Skip navigation links

oracle.security.idaas.oauth.sdk.request
Class OAMCredentialsTokenRequest

java.lang.Object
oracle.security.idaas.oauth.sdk.request.OAuthRestRequest
oracle.security.idaas.oauth.sdk.request.OAuthTokenRequest
oracle.security.idaas.oauth.sdk.request.OAMCredentialsTokenRequest

public class OAMCredentialsTokenRequest

extends OAuthTokenRequest

Class dedicated to receive the OAM Credentials Token request parameters.
It allows to get :

• (5) an OAM Access Token using 2 different request constructors,
• (4) an OAM User Token using 4 different request constructors,
• (3) an OAM User and Master Tokens using 4 different request constructors,
• (2) a JWT Access token using 2 different request constructors.
• (1) a JWT User token using 2 different request constructors,

Constructor Summary

OAMCredentialsTokenRequest()
Initializes a basic OAM Credentials Token Request without any parameters.

OAMCredentialsTokenRequest(ClientIdSecretPair clientCredentials, OracleUserCredentials oracleUserCredentials, java.lang.String scope, java.lang.String oamAuthenResource)
(2a) Initializes the OAM Credentials Token Request to obtain a JWT Access Token using Client Credentials.

OAMCredentialsTokenRequest(ClientIdSecretPair clientCredentials, java.lang.String oamAuthenResource)
(1a) Initializes the OAM Credentials Token Request to obtain a JWT User Token using Client Credentials.

OAMCredentialsTokenRequest(ClientIdSecretPair clientCredentials, java.lang.String oracleRequestAssertions, OracleUserCredentials oracleUserCredentials, java.lang.String oamAuthenResource)
(3a) and (4a) Initializes the OAM Credentials Token Request to obtain an OAM User Token and an OAM Master Token when the oracleRequestAssertions is null.

OAMCredentialsTokenRequest(ClientIdSecretPair clientCredentials, java.lang.String oracleRequestAssertions, java.lang.String userAssertion, java.lang.String userAssertionType, java.lang.String oamAuthenResource)
(3b) and (4b) Initializes the OAM Credentials Token Request to obtain an OAM User Token and an OAM Master Token when the oracleRequestAssertions is null.

OAMCredentialsTokenRequest(ClientIdSecretPair clientCredentials, java.lang.String userAssertion, java.lang.String userAssertionType, java.lang.String applicationContext, java.net.URL applicationResource)
(5a)Initializes the OAM Credentials Token Request to obtain an OAM Access Token.

OAMCredentialsTokenRequest(java.util.Map<java.lang.String,java.lang.String> header, java.util.Map<java.lang.String,java.lang.String> query)
Initializes the OAM Credentials Token Request using the given parameters.

OAMCredentialsTokenRequest(java.lang.String clientAssertion, java.lang.String clientAssertionType, OracleUserCredentials oracleUserCredentials, java.lang.String scope, java.lang.String oamAuthenResource)
(2b) Initializes the OAM Credentials Token Request to obtain a JWT Access Token using Client Assertion.

OAMCredentialsTokenRequest(java.lang.String clientAssertion, java.lang.String clientAssertionType, java.lang.String oamAuthenResource)
(1b) Initializes the OAM Credentials Token Request to obtain a JWT User Token using Client Assertion.

OAMCredentialsTokenRequest(java.lang.String clientAssertion, java.lang.String clientAssertionType, java.lang.String oracleRequestAssertions, OracleUserCredentials oracleUserCredentials, java.lang.String oamAuthenResource)
(3c) and (4c) Initializes the OAM Credentials Token Request to obtain an OAM User Token and an OAM Master Token when the oracleRequestAssertions is null.

OAMCredentialsTokenRequest(java.lang.String clientAssertion, java.lang.String clientAssertionType, java.lang.String oracleRequestAssertions, java.lang.String userAssertion, java.lang.String userAssertionType, java.lang.String oamAuthenResource)
(3d) and (4d) Initializes the OAM Credentials Token Request to obtain an OAM User Token and an OAM Master Token when the oracleRequestAssertions is null.

OAMCredentialsTokenRequest(java.lang.String clientAssertion, java.lang.String clientAssertionType, java.lang.String userAssertion, java.lang.String userAssertionType, java.lang.String applicationContext, java.net.URL applicationResource)
(5b)Initializes the OAM Credentials Token Request to obtain an OAM Access Token.

Method Summary

java.lang.String	getClientAssertion() Returns the client_assertion
java.lang.String	getClientAssertionType() Returns the client_assertion_type
ClientIdSecretPair	getClientCredentials() Returns the class encapsulating the client id and secret.
java.lang.String	getOamAuthenResource() Returns the oam authenticated resource
java.lang.String	getOracleOamApplicationContext() Returns the Application Context
java.net.URL	getOracleOamApplicationResource() Returns the Application Resource URL.
java.lang.String	getOracleRequestedAssertions() Returns the oracle_requested_assertions
OracleUserCredentials	getOracleUserCredentials() Returns the user credentials
java.lang.String	getScope() Returns the scope.
java.lang.String	getUserAssertion() Returns the user_assertion
java.lang.String	getUserAssertionType() Returns the user_assertion_type
boolean	isJwtClientAssertion() Return true if the client assertion is a JWT one.
boolean	isSamlClientAssertion() Return true if the client assertion is a SAML one.
void	setClientAssertion(java.lang.String clientAssertion) Updates the client_assertion
void	setClientAssertionType(java.lang.String clientAssertionType) Updates the Client Assertion Type.
void	setClientCredentials(ClientIdSecretPair clientCredentials) Updates the client Id and secret.
void	setGrantType(java.lang.String grantType) Changes the grant_type.
void	setOamAuthenResource(java.lang.String value) Updates the oam authenticated resource
void	setOracleOamApplicationContext(java.lang.String value) Updates the application context
void	setOracleOamApplicationResource(java.net.URL value) Updates the application Resource.
void	setOracleRequestedAssertions(java.lang.String requestedAssertions) Updates the oracle_requested_assertions.
void	setOracleUserCredentials(OracleUserCredentials userCredentials) Updates the oracle_user_credentials.
void	setScope(java.lang.String scope) Update the scope.
void	setUserAssertion(java.lang.String userAssertion) Updates the user_assertion
void	setUserAssertionType(java.lang.String userAssertionType) Updates the User Assertion Type.

Methods inherited from class oracle.security.idaas.oauth.sdk.request.OAuthTokenRequest

getGrantType

Methods inherited from class oracle.security.idaas.oauth.sdk.request.OAuthRestRequest

addHeader, addQuery, clearAll, clearHeader, clearQuery, getHeader, getHeader, getQuery, getQuery, getQueryMap, isNullOrEmpty, setHeader, setQuery

Methods inherited from class java.lang.Object

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

Constructor Detail

OAMCredentialsTokenRequest

public OAMCredentialsTokenRequest()

Initializes a basic OAM Credentials Token Request without any parameters.

OAMCredentialsTokenRequest

public OAMCredentialsTokenRequest(java.util.Map<java.lang.String,java.lang.String> header,
                                  java.util.Map<java.lang.String,java.lang.String> query)

Initializes the OAM Credentials Token Request using the given parameters.

Parameters:

header - name value pairs for request header

query - name value pairs for request query

OAMCredentialsTokenRequest

public OAMCredentialsTokenRequest(ClientIdSecretPair clientCredentials,
                                  java.lang.String oamAuthenResource)

(1a) Initializes the OAM Credentials Token Request to obtain a JWT User Token using Client Credentials.

Parameters:

clientCredentials - it shall not be null

oamAuthenResource - optional resource string

OAMCredentialsTokenRequest

public OAMCredentialsTokenRequest(java.lang.String clientAssertion,
                                  java.lang.String clientAssertionType,
                                  java.lang.String oamAuthenResource)

(1b) Initializes the OAM Credentials Token Request to obtain a JWT User Token using Client Assertion.

Parameters:

clientAssertion - client assertion, see also ClientAssertionTokenRequest

clientAssertionType - accept only OAuthSdkConstants.SAML_CLIENT_ASSERTION_TYPE or OAuthSdkConstants.JWT_CLIENT_ASSERTION_TYPE

oamAuthenResource - optional resource string

OAMCredentialsTokenRequest

public OAMCredentialsTokenRequest(ClientIdSecretPair clientCredentials,
                                  OracleUserCredentials oracleUserCredentials,
                                  java.lang.String scope,
                                  java.lang.String oamAuthenResource)

(2a) Initializes the OAM Credentials Token Request to obtain a JWT Access Token using Client Credentials.

Parameters:

clientCredentials - it shall not be null

oracleUserCredentials - JSON user credentials

scope - space separated list of scopes

oamAuthenResource - optional resource string

OAMCredentialsTokenRequest

public OAMCredentialsTokenRequest(java.lang.String clientAssertion,
                                  java.lang.String clientAssertionType,
                                  OracleUserCredentials oracleUserCredentials,
                                  java.lang.String scope,
                                  java.lang.String oamAuthenResource)

(2b) Initializes the OAM Credentials Token Request to obtain a JWT Access Token using Client Assertion.

Parameters:

clientAssertion - client assertion, see also ClientAssertionTokenRequest

clientAssertionType - accept only OAuthSdkConstants.SAML_CLIENT_ASSERTION_TYPE or OAuthSdkConstants.JWT_CLIENT_ASSERTION_TYPE

oracleUserCredentials - JSON user credentials

scope - space separated list of scopes

oamAuthenResource - optional resource string

OAMCredentialsTokenRequest

public OAMCredentialsTokenRequest(ClientIdSecretPair clientCredentials,
                                  java.lang.String oracleRequestAssertions,
                                  OracleUserCredentials oracleUserCredentials,
                                  java.lang.String oamAuthenResource)

(3a) and (4a) Initializes the OAM Credentials Token Request to obtain an OAM User Token and an OAM Master Token when the oracleRequestAssertions is null.
If the oracleRequestAssertions parameter is set to OAuthSdkConstants.ORACLE_IDM_ASSERTION_TYPE_USER_IDENTITY_OAM then only the OAM User Token will returned.

Parameters:

clientCredentials - it shall not be null

oracleRequestAssertions - null or OAuthSdkConstants.ORACLE_IDM_ASSERTION_TYPE_USER_IDENTITY_OAM

oracleUserCredentials - it shall not be null

oamAuthenResource - optional resource string

OAMCredentialsTokenRequest

public OAMCredentialsTokenRequest(ClientIdSecretPair clientCredentials,
                                  java.lang.String oracleRequestAssertions,
                                  java.lang.String userAssertion,
                                  java.lang.String userAssertionType,
                                  java.lang.String oamAuthenResource)

(3b) and (4b) Initializes the OAM Credentials Token Request to obtain an OAM User Token and an OAM Master Token when the oracleRequestAssertions is null.
If the oracleRequestAssertions parameter is set to OAuthSdkConstants.ORACLE_IDM_ASSERTION_TYPE_USER_IDENTITY_OAM then only the OAM User Token will returned.

Parameters:

clientCredentials - it shall not be null

oracleRequestAssertions - null or OAuthSdkConstants.ORACLE_IDM_ASSERTION_TYPE_USER_IDENTITY_OAM

userAssertion - it shall not be null

userAssertionType - accept only OAuthSdkConstants.JWT_USER_ASSERTION_TYPE

oamAuthenResource - optional resource string

OAMCredentialsTokenRequest

public OAMCredentialsTokenRequest(java.lang.String clientAssertion,
                                  java.lang.String clientAssertionType,
                                  java.lang.String oracleRequestAssertions,
                                  OracleUserCredentials oracleUserCredentials,
                                  java.lang.String oamAuthenResource)

(3c) and (4c) Initializes the OAM Credentials Token Request to obtain an OAM User Token and an OAM Master Token when the oracleRequestAssertions is null.
If the oracleRequestAssertions parameter is set to OAuthSdkConstants.ORACLE_IDM_ASSERTION_TYPE_USER_IDENTITY_OAM then only the OAM User Token will returned.

Parameters:

clientAssertion - client assertion, see also ClientAssertionTokenRequest

clientAssertionType - accept only OAuthSdkConstants.SAML_CLIENT_ASSERTION_TYPE or OAuthSdkConstants.JWT_CLIENT_ASSERTION_TYPE

oracleRequestAssertions - null or OAuthSdkConstants.ORACLE_IDM_ASSERTION_TYPE_USER_IDENTITY_OAM

oracleUserCredentials - it shall not be null

oamAuthenResource - optional resource string

OAMCredentialsTokenRequest

public OAMCredentialsTokenRequest(java.lang.String clientAssertion,
                                  java.lang.String clientAssertionType,
                                  java.lang.String oracleRequestAssertions,
                                  java.lang.String userAssertion,
                                  java.lang.String userAssertionType,
                                  java.lang.String oamAuthenResource)

(3d) and (4d) Initializes the OAM Credentials Token Request to obtain an OAM User Token and an OAM Master Token when the oracleRequestAssertions is null.
If the oracleRequestAssertions parameter is set to OAuthSdkConstants.ORACLE_IDM_ASSERTION_TYPE_USER_IDENTITY_OAM then only the OAM User Token will returned.

Parameters:

clientAssertion - client assertion, see also ClientAssertionTokenRequest

clientAssertionType - accept only OAuthSdkConstants.SAML_CLIENT_ASSERTION_TYPE or OAuthSdkConstants.JWT_CLIENT_ASSERTION_TYPE

oracleRequestAssertions - null or OAuthSdkConstants.ORACLE_IDM_ASSERTION_TYPE_USER_IDENTITY_OAM

userAssertion - it shall not be null

userAssertionType - accept only OAuthSdkConstants.JWT_USER_ASSERTION_TYPE

oamAuthenResource - optional resource string

OAMCredentialsTokenRequest

public OAMCredentialsTokenRequest(ClientIdSecretPair clientCredentials,
                                  java.lang.String userAssertion,
                                  java.lang.String userAssertionType,
                                  java.lang.String applicationContext,
                                  java.net.URL applicationResource)

(5a)Initializes the OAM Credentials Token Request to obtain an OAM Access Token.

Parameters:

clientCredentials - it shall not be null

userAssertion - it shall not be null

userAssertionType - accept only OAuthSdkConstants.JWT_USER_ASSERTION_TYPE

applicationContext - a formated string representing the application context, it can not be null

applicationResource - the protected resource URL, it can not be null

OAMCredentialsTokenRequest

public OAMCredentialsTokenRequest(java.lang.String clientAssertion,
                                  java.lang.String clientAssertionType,
                                  java.lang.String userAssertion,
                                  java.lang.String userAssertionType,
                                  java.lang.String applicationContext,
                                  java.net.URL applicationResource)

(5b)Initializes the OAM Credentials Token Request to obtain an OAM Access Token.

Parameters:

clientAssertion - client assertion, see also ClientAssertionTokenRequest

clientAssertionType - accept only OAuthSdkConstants.SAML_CLIENT_ASSERTION_TYPE or OAuthSdkConstants.JWT_CLIENT_ASSERTION_TYPE

userAssertion - it shall not be null

userAssertionType - accept only OAuthSdkConstants.JWT_USER_ASSERTION_TYPE

applicationContext - a formated string representing the application context, it can not be null

applicationResource - the protected resource URL, it can not be null

Method Detail

setGrantType

public void setGrantType(java.lang.String grantType)

Changes the grant_type. The grant_type shall be OAuthSdkConstants.ORACLE_IDM_GRANT_TYPE_OAM_CREDENTIALS

Overrides:

setGrantType in class OAuthTokenRequest

Parameters:

grantType - accept only OAuthSdkConstants.ORACLE_IDM_GRANT_TYPE_OAM_CREDENTIALS

getClientCredentials

public ClientIdSecretPair getClientCredentials()

Returns the class encapsulating the client id and secret.

Returns:

the client credentials

setClientCredentials

public void setClientCredentials(ClientIdSecretPair clientCredentials)
                          throws java.lang.IllegalArgumentException

Updates the client Id and secret. It shall not be null or empty.

Parameters:

clientCredentials - client information

Throws:

java.lang.IllegalArgumentException - when null parameter

getOracleUserCredentials

public OracleUserCredentials getOracleUserCredentials()

Returns the user credentials

Returns:

oracle_user_credentials

setOracleUserCredentials

public void setOracleUserCredentials(OracleUserCredentials userCredentials)

Updates the oracle_user_credentials. It shall not be null.

Parameters:

userCredentials - user information

getOracleRequestedAssertions

public java.lang.String getOracleRequestedAssertions()

Returns the oracle_requested_assertions

Returns:

oracle_requested_assertions or null

setOracleRequestedAssertions

public void setOracleRequestedAssertions(java.lang.String requestedAssertions)

Updates the oracle_requested_assertions. If it is provided (not null), it shall be one of:

• OAuthSdkConstants.ORACLE_IDM_ASSERTION_TYPE_USER_IDENTITY_JWT
• OAuthSdkConstants.ORACLE_IDM_ASSERTION_TYPE_USER_IDENTITY_OAM

Parameters:

requestedAssertions - supports only OAuthSdkConstants.ORACLE_IDM_ASSERTION_TYPE_USER_IDENTITY_JWT or OAuthSdkConstants.ORACLE_IDM_ASSERTION_TYPE_USER_IDENTITY_OAM

getOracleOamApplicationContext

public java.lang.String getOracleOamApplicationContext()

Returns the Application Context

Returns:

application context

setOracleOamApplicationContext

public void setOracleOamApplicationContext(java.lang.String value)

Updates the application context

Parameters:

value - string representing the context

getOracleOamApplicationResource

public java.net.URL getOracleOamApplicationResource()

Returns the Application Resource URL. It can return null when an error occurs or if the parameter has not been previously set correctly.

Returns:

application resource

setOracleOamApplicationResource

public void setOracleOamApplicationResource(java.net.URL value)

Updates the application Resource.

Parameters:

value - the URl of the resource

getOamAuthenResource

public java.lang.String getOamAuthenResource()

Returns the oam authenticated resource

Returns:

oam_authen_resource

setOamAuthenResource

public void setOamAuthenResource(java.lang.String value)

Updates the oam authenticated resource

Parameters:

value - oam_authen_resource

getScope

public java.lang.String getScope()

Returns the scope.

Returns:

scope

setScope

public void setScope(java.lang.String scope)

Update the scope. The scope names shall be separated by the space character " ".

If the scope is null or empty then scope is set to "none".

Parameters:

scope - space separated list of scopes

getClientAssertionType

public java.lang.String getClientAssertionType()

Returns the client_assertion_type

Returns:

client_assertion_type

setClientAssertionType

public void setClientAssertionType(java.lang.String clientAssertionType)

Updates the Client Assertion Type. Accepts only:

• OAuthSdkConstants.SAML_CLIENT_ASSERTION_TYPE
• OAuthSdkConstants.JWT_CLIENT_ASSERTION_TYPE

Parameters:

clientAssertionType - assertion type

getClientAssertion

public java.lang.String getClientAssertion()

Returns the client_assertion

Returns:

client_assertion

setClientAssertion

public void setClientAssertion(java.lang.String clientAssertion)

Updates the client_assertion

Parameters:

clientAssertion - assertion

isJwtClientAssertion

public boolean isJwtClientAssertion()

Return true if the client assertion is a JWT one.

Returns:

true for JWT

isSamlClientAssertion

public boolean isSamlClientAssertion()

Return true if the client assertion is a SAML one.

Returns:

true for SAML

getUserAssertionType

public java.lang.String getUserAssertionType()

Returns the user_assertion_type

Returns:

user_assertion_type

setUserAssertionType

public void setUserAssertionType(java.lang.String userAssertionType)

Updates the User Assertion Type. Accepts only:

• OAuthSdkConstants.JWT_USER_ASSERTION_TYPE

Parameters:

userAssertionType - assertion type

getUserAssertion

public java.lang.String getUserAssertion()

Returns the user_assertion

Returns:

user_assertion

setUserAssertion

public void setUserAssertion(java.lang.String userAssertion)

Updates the user_assertion

Parameters:

userAssertion - assertion

Skip navigation links