Skip navigation links

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

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

public class UserAssertionTokenRequest

extends OAuthTokenRequest

Class dedicated to receive the User Assertion Token request parameters. Creating JWT User Assertion Token (and their Refresh Token)

• [UT.1] Confidential Client to use Client Secret and User Password to acquire a JWT-based User Assertion Token (UT)
• [UT.2] Confidential Client to use Client Assertion (SAML or JWT) and User Password to acquire a JWT-based User Assertion Token (UT)

Constructor Summary

UserAssertionTokenRequest()
Initializes a basic JWT User Assertion Token request without any parameters.

UserAssertionTokenRequest(ClientIdSecretPair clientCredentials, java.lang.String userName, java.lang.String password)
[UT.1] Confidential Client to use Client Secret and User Password to acquire a JWT-based User Assertion Token (UT)

UserAssertionTokenRequest(java.util.Map<java.lang.String,java.lang.String> header, java.util.Map<java.lang.String,java.lang.String> query)
Initializes the JWT User Assertion Token request using the given parameters.

UserAssertionTokenRequest(java.lang.String userName, java.lang.String password, java.lang.String clientAssertionType, java.lang.String clientAssertion)
[UT.2] Confidential Client to use Client Assertion (SAML or JWT) and User Password to acquire a JWT-based User Assertion Token (UT)

Method Summary

java.lang.String	getClientAssertion() returns the Client Assertion.
java.lang.String	getClientAssertionType() Returns the Client Assertion type.
ClientIdSecretPair	getClientCredentials() Returns the client id and secret.
java.lang.String	getPassword() returns the password.
java.lang.String	getUsername() Returns the username
boolean	isJwtClientAssertion() Returns true if the client assertion is a JWT one.
boolean	isSamlClientAssertion() Returns 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) Update the client Id and secret.
void	setPassword(java.lang.String password) Updates the password.
void	setUsername(java.lang.String username) Updates the username.

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

getGrantType, setGrantType

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

UserAssertionTokenRequest

public UserAssertionTokenRequest()

Initializes a basic JWT User Assertion Token request without any parameters.

UserAssertionTokenRequest

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

Initializes the JWT User Assertion Token request using the given parameters.

Parameters:

header - name value pairs for request header

query - name value pairs for request query

UserAssertionTokenRequest

public UserAssertionTokenRequest(ClientIdSecretPair clientCredentials,
                                 java.lang.String userName,
                                 java.lang.String password)
                          throws java.io.UnsupportedEncodingException,
                                 java.lang.IllegalArgumentException

[UT.1] Confidential Client to use Client Secret and User Password to acquire a JWT-based User Assertion Token (UT)

Parameters:

clientCredentials - client information

userName - user name

password - password

Throws:

java.io.UnsupportedEncodingException - when encoding fails

java.lang.IllegalArgumentException - when invalid argument is provided

UserAssertionTokenRequest

public UserAssertionTokenRequest(java.lang.String userName,
                                 java.lang.String password,
                                 java.lang.String clientAssertionType,
                                 java.lang.String clientAssertion)
                          throws java.io.UnsupportedEncodingException,
                                 java.lang.IllegalArgumentException

[UT.2] Confidential Client to use Client Assertion (SAML or JWT) and User Password to acquire a JWT-based User Assertion Token (UT)

Parameters:

userName - user name

password - password

clientAssertionType - accept only OAuthSdkConstants.SAML_CLIENT_ASSERTION_TYPE or OAuthSdkConstants.JWT_CLIENT_ASSERTION_TYPE

clientAssertion - client assertion, see also ClientAssertionTokenRequest

Throws:

java.io.UnsupportedEncodingException - when encoding fails

java.lang.IllegalArgumentException - when invalid argument is provided

Method Detail

getClientCredentials

public ClientIdSecretPair getClientCredentials()

Returns the client id and secret.

Returns:

client id and secret

setClientCredentials

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

Update the client Id and secret.

Parameters:

clientCredentials - client information

Throws:

java.lang.IllegalArgumentException - when null parameter

getUsername

public java.lang.String getUsername()

Returns the username

Returns:

username

setUsername

public void setUsername(java.lang.String username)

Updates the username.

Parameters:

username - user name

getPassword

public java.lang.String getPassword()

returns the password.

Returns:

password

setPassword

public void setPassword(java.lang.String password)

Updates the password.

Parameters:

password - password

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()

Returns true if the client assertion is a JWT one.

Returns:

true for JWT

isSamlClientAssertion

public boolean isSamlClientAssertion()

Returns true if the client assertion is a SAML one.

Returns:

true for SAML

Skip navigation links