com.vmware.vapi.cis.authn

Class SecurityContextFactory

java.lang.Object

com.vmware.vapi.cis.authn.SecurityContextFactory

public final class SecurityContextFactory
extends Object

This factory class have methods for creating and parsing ExecutionContext.SecurityContext for all known AuthnType

Constructor Summary

Constructors

Constructor and Description
SecurityContextFactory()

Method Summary

Methods

Modifier and Type	Method and Description
static com.vmware.vapi.core.ExecutionContext.SecurityContext	createDefaultSecurityContext(Map<String,Object> props) Creates security context using the provided map of properties
static com.vmware.vapi.core.ExecutionContext.SecurityContext	createOAuthSecurityContext(char[] accessToken) Creates a security context based on OAuth2 access token
static com.vmware.vapi.core.ExecutionContext.SecurityContext	createSamlSecurityContext(com.vmware.vapi.saml.SamlToken token, PrivateKey privateKey) Creates a SAML token security context
static com.vmware.vapi.core.ExecutionContext.SecurityContext	createSessionSecurityContext(char[] sessionId) Creates a security context which represents and attempt to reuse an existing session.
static com.vmware.vapi.core.ExecutionContext.SecurityContext	createUserPassSecurityContext(String user, char[] password) Creates a security context suitable for user/pass authentication.
static com.vmware.vapi.security.OAuthSecurityContext	parseOAuthSecurityContext(com.vmware.vapi.core.ExecutionContext.SecurityContext ctx) Parses the ExecutionContext.SecurityContext looking for oauth information.
static SamlAuthenticationData	parseSamlSecurityContext(com.vmware.vapi.core.ExecutionContext.SecurityContext ctx) Parses a given ExecutionContext.SecurityContext into a more convenient for use structure
static com.vmware.vapi.security.SessionSecurityContext	parseSessionSecurityContext(com.vmware.vapi.core.ExecutionContext.SecurityContext ctx) Parses the ExecutionContext.SecurityContext looking for session information.
static com.vmware.vapi.security.UserPassSecurityContext	parseUserPassSecurityContext(com.vmware.vapi.core.ExecutionContext.SecurityContext ctx) Parses a ExecutionContext.SecurityContext into a UserPassSecurityContext if all needed data is there, otherwise null will be returned.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SecurityContextFactory

public SecurityContextFactory()

Method Detail

createSamlSecurityContext

public static com.vmware.vapi.core.ExecutionContext.SecurityContext createSamlSecurityContext(com.vmware.vapi.saml.SamlToken token,
                                                                              PrivateKey privateKey)

Creates a SAML token security context

Parameters:

token - the token that should be used for authentication

privateKey - the private key that should be used to sign the request

Returns:

the security context that describes the requested authn

createSessionSecurityContext

public static com.vmware.vapi.core.ExecutionContext.SecurityContext createSessionSecurityContext(char[] sessionId)

Creates a security context which represents and attempt to reuse an existing session. This is only usable with session-aware services. Such attempt would succeed only if the client has already been authenticated by the service and has a valid session with it.

Parameters:

sessionId - String representing a session ID

Returns:

the created security context

createOAuthSecurityContext

public static com.vmware.vapi.core.ExecutionContext.SecurityContext createOAuthSecurityContext(char[] accessToken)

Creates a security context based on OAuth2 access token

Parameters:

accessToken - access token that should be used for authentication

Returns:

the security context that describes the requested authentication

createUserPassSecurityContext

public static com.vmware.vapi.core.ExecutionContext.SecurityContext createUserPassSecurityContext(String user,
                                                                                  char[] password)

Creates a security context suitable for user/pass authentication.

Parameters:

user - the username of the principal. cannot be null.

password - the password of the principal. cannot be null.

Returns:

the created security context

parseUserPassSecurityContext

public static com.vmware.vapi.security.UserPassSecurityContext parseUserPassSecurityContext(com.vmware.vapi.core.ExecutionContext.SecurityContext ctx)

Parses a ExecutionContext.SecurityContext into a UserPassSecurityContext if all needed data is there, otherwise null will be returned.

Parameters:

ctx - cannot be null

Returns:

the parsed security context

parseSamlSecurityContext

public static SamlAuthenticationData parseSamlSecurityContext(com.vmware.vapi.core.ExecutionContext.SecurityContext ctx)

Parses a given ExecutionContext.SecurityContext into a more convenient for use structure

Parameters:

ctx - the security context that will be parsed. Cannot be null. Authentication type should be AuthnType.SAML

Returns:

the parsed security context

parseSessionSecurityContext

public static com.vmware.vapi.security.SessionSecurityContext parseSessionSecurityContext(com.vmware.vapi.core.ExecutionContext.SecurityContext ctx)

Parses the ExecutionContext.SecurityContext looking for session information.

Parameters:

ctx -

Returns:

SessionSecurityContext if session is found, null otherwise

parseOAuthSecurityContext

public static com.vmware.vapi.security.OAuthSecurityContext parseOAuthSecurityContext(com.vmware.vapi.core.ExecutionContext.SecurityContext ctx)

Parses the ExecutionContext.SecurityContext looking for oauth information.

Parameters:

ctx -

Returns:

OAuthSecurityContext if access token is found, null otherwise

createDefaultSecurityContext

public static com.vmware.vapi.core.ExecutionContext.SecurityContext createDefaultSecurityContext(Map<String,Object> props)

Creates security context using the provided map of properties

Parameters:

props - contains the security context properties. can be null

Returns:

ExecutionContext.SecurityContext containing the properties passed as parameter. must not be null