Skip navigation links

oracle.security.idaas.rest.common
Class Token

java.lang.Object
oracle.security.idaas.rest.common.Token

public class Token

extends java.lang.Object

Token includes all the user / client / Provider specific token information in the request. JAX-RS Request Handler parses each request and generates this instance. The RESTful Identity Service Adaptor/Helper layer invokes Token Service provider implementation with this parameter.

Nested Class Summary

static class

Token.Type Enumerated Token Type.

Field Summary

static java.lang.String

USERDN_ATTR

Constructor Summary

Token()
No Arg Token Constructor

Token(java.lang.String tValue)
Token Constructor with Token value

Token(java.lang.String tId, java.lang.String tVal, java.lang.String tType)
Token Constructor with Token ID, Token Value and Token Type

Token(java.lang.String tId, java.lang.String tVal, java.lang.String tkType, TokenValueFormatHelper h)
Token Constructor with Token ID, Token Value, Token Type, Token Value Format Helper

Token(java.lang.String tVal, TokenValueFormatHelper h)
Token Constructor with Token value and Token Value Format Helper

Method Summary

java.lang.String	getAttribute(java.lang.String attrName) getAttribute returns matching session attribute with attribute name for Token.
java.lang.Iterable<java.lang.String>	getAttributeNames() return attribute name set of this token
PluginContext	getPluginContext() return Plugin Context used in Security Plugin Integration
java.lang.String	getPrincipal() getPrincipal returns user principal for the token
java.lang.String	getTokenId() getTokenId returns TokenId.
java.lang.String	getTokenProviderType() return Token Provider Type (if applicable)
Token.Type	getTokenType() getTokenType returns TokenType from Token.
java.lang.String	getTokenTypeString() getTokenTypeString returns TokenType from Token in String format.
java.lang.String	getTokenValue() getTokenValue returns opaque token value from Token.
java.lang.String	getUserDN() return User LDAP DN (if applicable)
java.lang.String	getUserPrincipalAttrName() getUserPrincipalAttrName returns user principal Attribute Name for the token
void	setAttribute(java.lang.String attrName, java.lang.String attrValue) setAttribute sets individual session attribute for Token
void	setPluginContext(PluginContext pluginContext) setting Plugin Context used in Security Plugin Integration
void	setPrincipal(java.lang.String principal) setPrincipal sets user principal for token
void	setTokenId(java.lang.String id) setTokenId sets TokenId into Token
void	setTokenProviderType(java.lang.String providerType) set Token Provider Type (if applicable)
void	setTokenType(java.lang.String type) Deprecated.
void	setTokenType(Token.Type type) setTokenType sets TokenType into Token TokenType is one of followings : - userToken, clientToken, serviceToken
void	setTokenTypeString(java.lang.String type) setTokenTypeString sets TokenType into Token TokenType is one of followings : - userToken, clientToken, serviceToken
void	setTokenValue(java.lang.String v) setTokenValue sets the token value into Token.
void	setUserDN(java.lang.String userDN) set User LDAP DN (if applicable)
void	setUserPrincipalAttrName(java.lang.String principalAttrName) setUserPrincipalAttrName sets user principal Attribute Name for token
java.lang.String	toString() Value returned by this "toString()" may change in future.

Methods inherited from class java.lang.Object

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

Field Detail

USERDN_ATTR

public static final java.lang.String USERDN_ATTR

See Also:

Constant Field Values

Constructor Detail

Token

public Token()

No Arg Token Constructor

Token

public Token(java.lang.String tId,
             java.lang.String tVal,
             java.lang.String tkType,
             TokenValueFormatHelper h)
      throws InvalidToken

Token Constructor with Token ID, Token Value, Token Type, Token Value Format Helper

Throws:

InvalidToken

Token

public Token(java.lang.String tValue)
      throws InvalidToken

Token Constructor with Token value

Throws:

InvalidToken

Token

public Token(java.lang.String tVal,
             TokenValueFormatHelper h)
      throws InvalidToken

Token Constructor with Token value and Token Value Format Helper

Throws:

InvalidToken

Token

public Token(java.lang.String tId,
             java.lang.String tVal,
             java.lang.String tType)
      throws InvalidToken

Token Constructor with Token ID, Token Value and Token Type

Throws:

InvalidToken

Method Detail

getTokenId

public java.lang.String getTokenId()

getTokenId returns TokenId.

Returns:

TokenId that is unique value to identify the token.

setTokenId

public void setTokenId(java.lang.String id)

setTokenId sets TokenId into Token

getTokenValue

public java.lang.String getTokenValue()

getTokenValue returns opaque token value from Token.

Returns:

the value of token.

setTokenValue

public void setTokenValue(java.lang.String v)
                   throws InvalidToken

setTokenValue sets the token value into Token.

Throws:

InvalidToken

getTokenType

public Token.Type getTokenType()

getTokenType returns TokenType from Token.

Returns:

TokenType that is one of following : - userToken, clientToken, serviceToken, localToken

getTokenTypeString

public java.lang.String getTokenTypeString()

getTokenTypeString returns TokenType from Token in String format.

Returns:

TokenType that is one of following : - userToken, clientToken, serviceToken, localToken

setTokenType

public void setTokenType(Token.Type type)

setTokenType sets TokenType into Token TokenType is one of followings : - userToken, clientToken, serviceToken

setTokenType

@Deprecated
public void setTokenType(java.lang.String type)

Deprecated.

setTokenTypeString

public void setTokenTypeString(java.lang.String type)

setTokenTypeString sets TokenType into Token TokenType is one of followings : - userToken, clientToken, serviceToken

getAttributeNames

public java.lang.Iterable<java.lang.String> getAttributeNames()

return attribute name set of this token

Returns:

attribute name set of this token

setAttribute

public void setAttribute(java.lang.String attrName,
                         java.lang.String attrValue)

setAttribute sets individual session attribute for Token

getAttribute

public java.lang.String getAttribute(java.lang.String attrName)

getAttribute returns matching session attribute with attribute name for Token.

Returns:

attr matching with attribute name

setPluginContext

public void setPluginContext(PluginContext pluginContext)

setting Plugin Context used in Security Plugin Integration

Parameters:

pluginContext - Plugin Context used in Security Plugin Integration

getPluginContext

public PluginContext getPluginContext()

return Plugin Context used in Security Plugin Integration

Returns:

Plugin Context used in Security Plugin Integration

getUserPrincipalAttrName

public java.lang.String getUserPrincipalAttrName()

getUserPrincipalAttrName returns user principal Attribute Name for the token

Returns:

principal attribute name for the token

setUserPrincipalAttrName

public void setUserPrincipalAttrName(java.lang.String principalAttrName)

setUserPrincipalAttrName sets user principal Attribute Name for token

getPrincipal

public java.lang.String getPrincipal()

getPrincipal returns user principal for the token

Returns:

principal for the token

setPrincipal

public void setPrincipal(java.lang.String principal)

setPrincipal sets user principal for token

setUserDN

public void setUserDN(java.lang.String userDN)

set User LDAP DN (if applicable)

Parameters:

userDN - User LDAP DN (if applicable)

getUserDN

public java.lang.String getUserDN()

return User LDAP DN (if applicable)

Returns:

User LDAP DN (if applicable)

setTokenProviderType

public void setTokenProviderType(java.lang.String providerType)

set Token Provider Type (if applicable)

Parameters:

providerType - Token Provider Type (if applicable)

getTokenProviderType

public java.lang.String getTokenProviderType()

return Token Provider Type (if applicable)

Returns:

Token Provider Type (if applicable)

toString

public java.lang.String toString()

Value returned by this "toString()" may change in future. This is mainly for informal debugging purpose.

Overrides:

toString in class java.lang.Object

Skip navigation links