com.vmware.vapi.vmc.client.authz

Class CspClientCredentialsSecurityContext

java.lang.Object

com.vmware.vapi.vmc.client.authz.CspClientCredentialsSecurityContext

All Implemented Interfaces:

ExecutionContext.SecurityContext, CspAccessTokenSecurityContext

public class CspClientCredentialsSecurityContext
extends java.lang.Object
implements CspAccessTokenSecurityContext

Represents a security-context for the Common SaaS Platform client_credentials flow that VMC uses.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLIENT_ID
static java.lang.String	CLIENT_SECRET
static java.lang.String	ORG_ID
protected java.util.Map<java.lang.String,java.lang.Object>	properties

Fields inherited from interface com.vmware.vapi.core.ExecutionContext.SecurityContext

AUTHENTICATION_DATA_ID, AUTHENTICATION_SCHEME_ID

Constructor Summary

Constructors

Constructor and Description
CspClientCredentialsSecurityContext(java.lang.String clientId, char[] clientSecret, java.lang.String orgId)

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	getAllProperties()
java.lang.String	getClientId()
char[]	getClientSecret()
java.lang.String	getOrgId()
java.lang.Object	getProperty(java.lang.String key)
boolean	needsRefresh() Method to check if access token needs to be refreshed.
void	setAccessToken(char[] accessToken) Used to set AccessToken in security context.

Methods inherited from class java.lang.Object

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

Field Detail

CLIENT_ID

public static final java.lang.String CLIENT_ID

See Also:

Constant Field Values

CLIENT_SECRET

public static final java.lang.String CLIENT_SECRET

See Also:

Constant Field Values

ORG_ID

public static final java.lang.String ORG_ID

See Also:

Constant Field Values

properties

protected final java.util.Map<java.lang.String,java.lang.Object> properties

Constructor Detail

CspClientCredentialsSecurityContext

public CspClientCredentialsSecurityContext(java.lang.String clientId,
                                           char[] clientSecret,
                                           java.lang.String orgId)

Parameters:

clientId - Client Identifier (AKA App ID) for CSP; must not be null

clientSecret - Client Secret (AKA App Secret) for CSP; must not be null

orgId - Organization ID for which access token needs to be generated. If this is null, token will be generated for default orgId.

Method Detail

setAccessToken

public void setAccessToken(char[] accessToken)

Description copied from interface: CspAccessTokenSecurityContext

Used to set AccessToken in security context.

Specified by:

setAccessToken in interface CspAccessTokenSecurityContext

needsRefresh

public boolean needsRefresh()

Description copied from interface: CspAccessTokenSecurityContext

Method to check if access token needs to be refreshed.

Specified by:

needsRefresh in interface CspAccessTokenSecurityContext

getClientId

public java.lang.String getClientId()

Returns:

the Client Identifier (AKA App ID) for authenticating against the authorization server; never null

getClientSecret

public char[] getClientSecret()

Returns:

the Client Secret (AKA App Secret) for authenticating against the authorization server; never null

getOrgId

public java.lang.String getOrgId()

Returns:

Organization ID for which access token needs to be generated.

getProperty

public java.lang.Object getProperty(java.lang.String key)

Specified by:

getProperty in interface ExecutionContext.SecurityContext

Returns:

the security context property under the specified key

getAllProperties

public java.util.Map<java.lang.String,java.lang.Object> getAllProperties()

Specified by:

getAllProperties in interface ExecutionContext.SecurityContext

Returns:

an unmodifiable Map representing all the properties