IBM WebSphere Application ServerTM
Release 8

com.ibm.websphere.wssecurity.wssapi.token
Interface ExchangeToken

All Superinterfaces:
SecurityToken

public interface ExchangeToken
extends SecurityToken

This interface represents the receiving token that is validated by using WS-Trust, and has been exchanged to a new token. This token interface encapsulates the unsorted properties of a generic security token in (key,value) pairs that are meaningful to implementors and exploiters of the token, and the authorization token from SecurityTokenService as a result of token validation and exchange.


Field Summary
 
Fields inherited from interface com.ibm.websphere.wssecurity.wssapi.token.SecurityToken
DECRYPTING_KEY, ENCRYPTING_KEY, REF_EMBEDDED, REF_KEYID, REF_STR, REF_THUMBPRINT, SIGNING_KEY, TokenQname, ValueType, VERIFING_KEY
 
Method Summary
 SecurityToken getAuthorizationToken()
          getter for the exchanged authorization token from SecurityTokenService
 java.util.Map getProperties()
          getter for the properties of the security token.
 
Methods inherited from interface com.ibm.websphere.wssecurity.wssapi.token.SecurityToken
getId, getKey, getKeyIdentifier, getKeyIdentifierEncodingType, getKeyIdentifierValueType, getKeyName, getPrincipal, getReferenceURI, getThumbprint, getThumbprintEncodingType, getThumbprintValueType, getTokenQname, getValueType, getXML
 

Method Detail

getProperties

java.util.Map getProperties()
getter for the properties of the security token.

Returns:
a map containing (key,value) pairs representing the token properties. For example, when WSTrust client returns a GenericSecurityToken, it could optionally store RequestSecurityTokenResponse in this properties.

getAuthorizationToken

SecurityToken getAuthorizationToken()
getter for the exchanged authorization token from SecurityTokenService

Returns:
an authorization token generated by SecurityTokenService via WS-Trust Validate request. For example WS-Trust client may return an authorization token in addition to status code.

IBM WebSphere Application ServerTM
Release 8