ExtendedTokenContext (Oracle Fusion Middleware Java API Reference for Oracle Platform Security Services)

java.lang.Object
- oracle.security.jps.service.trust.token.ExtendedTokenContext

All Implemented Interfaces:

TokenContext
```
public abstract class ExtendedTokenContext
extends java.lang.Object
implements TokenContext
```
This abstract class implements TokenContext interface. It also has additional methods necessary for advanced security token operations.

Since:

release specific (what release of product did this appear in)

Version:

$Header: jazn/jps/src/jps-api/oracle/security/jps/service/trust/token/ExtendedTokenContext.java /main/6 2015/02/10 03:59:02 yualiliu Exp $

Author:

kbiswas

Constructor Summary

Constructors
Constructor and Description

ExtendedTokenContext()
Default constructor

Constructors
Constructor and Description
`ExtendedTokenContext()` Default constructor

Method Summary

Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAppliesTo()` Provides the token audience scope value
`java.security.cert.X509Certificate[]`	`getCertificateChain()`
`java.util.List<Claim>`	`getClaims()` Provides claims from the token context
`java.util.ArrayList<java.lang.Object>`	`getConfiguration()` Provides token context specific properties
`java.lang.String`	`getContentType()`
`java.util.Date`	`getCreationTime()` Provides token creation time
`java.lang.String[]`	`getCritical()`
`java.util.List<Claim>`	`getDerivableClaims()`
`java.util.Date`	`getExpirationTime()` Provides token expire time
`java.lang.String`	`getIssuer()` Provides token issuer identity
`java.net.URL`	`getJsonKeyURL()`
`java.lang.String`	`getJwtID()`
`java.lang.String`	`getKeyID()`
`java.util.Map<java.lang.String,java.lang.Object>`	`getOtherProperties()` Provides optional context specific properties
`java.lang.String`	`getRequestor()` Provides requestor identity
`oracle.security.xml.Token`	`getSecurityToken()` Deprecated.
`java.lang.String`	`getTokenType()` Provides the token type which is provider implementation specific.
`TrustToken`	`getTrustToken()` Provides the `TrustToken` object
`java.net.URL`	`getX509URL()`
`void`	`setAppliesTo(java.lang.String appliesTo)` Sets the scope for the token audience.
`void`	`setCertificateChain(java.security.cert.X509Certificate[] certChain)` In order to set the "x5c" header claim of JWT Token.
`void`	`setClaims(java.util.List<Claim> claims)` Sets claims to the token context
`void`	`setContentType(java.lang.String contentType)` In order to set the "cty" claim of JWT token.
`void`	`setCreationTime(java.util.Date creationTime)` Sets token creation time
`void`	`setCritical(java.lang.String[] critical)` In order to set the "crit" claim of JWT token.
`void`	`setDerivableClaims(java.util.List<Claim> claims)`
`void`	`setExpirationTime(java.util.Date expiryTime)` Sets token expire date
`void`	`setIssuer(java.lang.String issuer)` Sets issuer identity
`void`	`setJsonKeyURL(java.net.URL jsonKeyURL)` In order to set the "jku" claim of JWT token.
`void`	`setJwtID(java.lang.String jwtID)` In order to set the "jti" claim of JWT token.
`void`	`setKeyID(java.lang.String kid)` In order to the "kid" claim of JWT token.
`void`	`setOtherProperties(java.util.Map<java.lang.String,java.lang.Object> otherProps)` Sets optional context specific properties
`void`	`setRequestor(java.lang.String requestor)` Sets requestor identity
`void`	`setSecurityToken(oracle.security.xml.Token token)` Deprecated.
`void`	`setTokenType(java.lang.String tokenType)` Sets the token type.
`void`	`setTrustToken(TrustToken token)` Sets the trust token
`void`	`setX509URL(java.net.URL x509url)` In order to set the "x5u" claim of JWT token.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ExtendedTokenContext
```
public ExtendedTokenContext()
```
    Default constructor
- Method Detail
  - setIssuer
```
public void setIssuer(java.lang.String issuer)
```
    Sets issuer identity
    
    Specified by:
    
    setIssuer in interface TokenContext
    
    Parameters:
    
    issuer - Issuer identity
  - getIssuer
```
public java.lang.String getIssuer()
```
    Provides token issuer identity
    
    Specified by:
    
    getIssuer in interface TokenContext
    
    Returns:
    
    Issuer identity
  - setRequestor
```
public void setRequestor(java.lang.String requestor)
```
    Sets requestor identity
    
    Specified by:
    
    setRequestor in interface TokenContext
    
    Parameters:
    
    requestor - Requestor identity
  - getRequestor
```
public java.lang.String getRequestor()
```
    Provides requestor identity
    
    Specified by:
    
    getRequestor in interface TokenContext
    
    Returns:
    
    Requestor identity
  - setTokenType
```
public void setTokenType(java.lang.String tokenType)
```
    Sets the token type. The type value is provider implementation specific.
    
    Specified by:
    
    setTokenType in interface TokenContext
    
    Parameters:
    
    tokenType - The token type value
  - getTokenType
```
public java.lang.String getTokenType()
```
    Provides the token type which is provider implementation specific.
    
    Specified by:
    
    getTokenType in interface TokenContext
    
    Returns:
    
    The token type value
  - setAppliesTo
```
public void setAppliesTo(java.lang.String appliesTo)
```
    Sets the scope for the token audience. For multiple urls, pass a Constants#APPLIES_TO_DELIMITER delimited string.
    
    Specified by:
    
    setAppliesTo in interface TokenContext
    
    Parameters:
    
    appliesTo - Token audience
  - getAppliesTo
```
public java.lang.String getAppliesTo()
```
    Provides the token audience scope value
    
    Specified by:
    
    getAppliesTo in interface TokenContext
    
    Returns:
    
    Token audience scope value
  - setSecurityToken
```
public void setSecurityToken(oracle.security.xml.Token token)
```
    Deprecated.
    
    Sets the security token
    
    Specified by:
    
    setSecurityToken in interface TokenContext
    
    Parameters:
    
    token - The Token object
  - setTrustToken
```
public void setTrustToken(TrustToken token)
```
    Sets the trust token
    
    Parameters:
    
    token - The TrustToken object
  - getSecurityToken
```
public oracle.security.xml.Token getSecurityToken()
```
    Deprecated.
    
    Provides the Token object
    
    Specified by:
    
    getSecurityToken in interface TokenContext
    
    Returns:
    
    Token object
  - getTrustToken
```
public TrustToken getTrustToken()
```
    Provides the TrustToken object
    
    Returns:
    
    TrustToken object
  - setCreationTime
```
public void setCreationTime(java.util.Date creationTime)
```
    Sets token creation time
    
    Specified by:
    
    setCreationTime in interface TokenContext
    
    Parameters:
    
    creationTime - Token creation time
  - getCreationTime
```
public java.util.Date getCreationTime()
```
    Provides token creation time
    
    Specified by:
    
    getCreationTime in interface TokenContext
    
    Returns:
    
    Token creation time
  - setExpirationTime
```
public void setExpirationTime(java.util.Date expiryTime)
```
    Sets token expire date
    
    Specified by:
    
    setExpirationTime in interface TokenContext
    
    Parameters:
    
    expiryTime - Token expire date
  - getExpirationTime
```
public java.util.Date getExpirationTime()
```
    Provides token expire time
    
    Specified by:
    
    getExpirationTime in interface TokenContext
    
    Returns:
    
    Token expire time
  - getOtherProperties
```
public java.util.Map<java.lang.String,java.lang.Object> getOtherProperties()
```
    Provides optional context specific properties
    
    Specified by:
    
    getOtherProperties in interface TokenContext
    
    Returns:
    
    Context specific properties
  - setOtherProperties
```
public void setOtherProperties(java.util.Map<java.lang.String,java.lang.Object> otherProps)
```
    Sets optional context specific properties
  - getConfiguration
```
public java.util.ArrayList<java.lang.Object> getConfiguration()
```
    Provides token context specific properties
    
    Specified by:
    
    getConfiguration in interface TokenContext
    
    Returns:
    
    List of configuration objects
  - setClaims
```
public void setClaims(java.util.List<Claim> claims)
```
    Sets claims to the token context
    
    Parameters:
    
    claims - List of claims to be set
  - getClaims
```
public java.util.List<Claim> getClaims()
```
    Provides claims from the token context
    
    Returns:
    
    List of claims in the token context
  - setDerivableClaims
```
public void setDerivableClaims(java.util.List<Claim> claims)
```
  - getDerivableClaims
```
public java.util.List<Claim> getDerivableClaims()
```
  - setCertificateChain
```
public void setCertificateChain(java.security.cert.X509Certificate[] certChain)
```
    In order to set the "x5c" header claim of JWT Token. No impact on SAML token. The array is cloned.
    
    Parameters:
    
    certChain -
  - getCertificateChain
```
public java.security.cert.X509Certificate[] getCertificateChain()
```
    Returns:
    
    a copy of the "x5c" claim value. null if the claim is not set. null in case of SAML Token.
  - setContentType
```
public void setContentType(java.lang.String contentType)
```
    In order to set the "cty" claim of JWT token. No impact on SAML token.
    
    Parameters:
    
    contentType -
  - getContentType
```
public java.lang.String getContentType()
```
    Returns:
    
    the "cty" claim of JWT token. null if the "cty" claim is not set. null in case of SAML token.
  - getCritical
```
public java.lang.String[] getCritical()
```
    Returns:
    
    a clone of the "crit" claim of JWT token. null if the claim is not set. null in case of SAML token.
  - setCritical
```
public void setCritical(java.lang.String[] critical)
```
    In order to set the "crit" claim of JWT token. No impact on SAML tokens. The array is cloned.
    
    Parameters:
    
    critical -
  - getJwtID
```
public java.lang.String getJwtID()
```
    Returns:
    
    gets the "jti" claim of the JWT token. null if the claim is not set. null in case of SAML token.
  - setJwtID
```
public void setJwtID(java.lang.String jwtID)
```
    In order to set the "jti" claim of JWT token. No impact on SAML token.
    
    Parameters:
    
    jwtID -
  - getKeyID
```
public java.lang.String getKeyID()
```
    Returns:
    
    the "kid" claim of JWT token. null if the token is not set. null in case of SAML token.
  - setKeyID
```
public void setKeyID(java.lang.String kid)
```
    In order to the "kid" claim of JWT token. No impact in case of JWT token.
    
    Parameters:
    
    kid -
  - getX509URL
```
public java.net.URL getX509URL()
```
    Returns:
    
    the "x5u" claim of JWT token. null if the claim is not set. null in case of SAML token.
  - setX509URL
```
public void setX509URL(java.net.URL x509url)
```
    In order to set the "x5u" claim of JWT token. No impact on SAML token.
    
    Parameters:
    
    x509url -
  - getJsonKeyURL
```
public java.net.URL getJsonKeyURL()
```
    Returns:
    
    get the "jku" claim of JWT token. null if the claim is not set. null in case of SAML token.
  - setJsonKeyURL
```
public void setJsonKeyURL(java.net.URL jsonKeyURL)
```
    In order to set the "jku" claim of JWT token. No impact in case of SAML token.
    
    Parameters:
    
    jsonKeyURL -

Class ExtendedTokenContext

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ExtendedTokenContext

Method Detail

setIssuer

getIssuer

setRequestor

getRequestor

setTokenType

getTokenType

setAppliesTo

getAppliesTo

setSecurityToken

setTrustToken

getSecurityToken

getTrustToken

setCreationTime

getCreationTime

setExpirationTime

getExpirationTime

getOtherProperties

setOtherProperties

getConfiguration

setClaims

getClaims

setDerivableClaims

getDerivableClaims

setCertificateChain

getCertificateChain

setContentType

getContentType

getCritical

setCritical

getJwtID

setJwtID

getKeyID

setKeyID

getX509URL

setX509URL

getJsonKeyURL

setJsonKeyURL