com.ibm.wsspi.wssecurity.core.token

Interface SecurityTokenManager


  1. public interface SecurityTokenManager

Method Summary

Modifier and Type Method and Description
  1. void
addToken(com.ibm.websphere.wssecurity.wssapi.token.SecurityToken token)
Adds the specified SecurityToken object into the current Subject.
  1. void
addTokens(java.util.Collection<com.ibm.websphere.wssecurity.wssapi.token.SecurityToken> tokens)
Adds a list of SecurityToken objects into the current subject.
  1. com.ibm.websphere.wssecurity.wssapi.token.SecurityToken
getToken(java.lang.String id)
Returns the SecurityToken from the current subject with the specified identifier.
  1. com.ibm.websphere.wssecurity.wssapi.token.SecurityToken
getToken(TokenConsumerConfig tconfig,java.lang.String id)
Gets the SecurityToken from the Subject in this context with specified identifier.
  1. java.util.Collection<com.ibm.websphere.wssecurity.wssapi.token.SecurityToken>
getTokens()
Gets a set of SecurityToken objects stored in the current subject.
  1. java.util.Collection<com.ibm.websphere.wssecurity.wssapi.token.SecurityToken>
getTokens(java.lang.String id)
Returns the SecurityToken objects from the Subject in this context with specified identifier.
  1. java.util.Collection<com.ibm.websphere.wssecurity.wssapi.token.SecurityToken>
getTokens(TokenConsumerConfig tconfig)
Gets the SecurityToken that is processed by the specified TokenConsumerConfig object.
  1. java.util.Collection<com.ibm.websphere.wssecurity.wssapi.token.SecurityToken>
getTokens(TokenGeneratorConfig tconfig)
Gets the SecurityToken that is processed by the specified TokenGeneratorConfig object.
  1. java.util.Collection<com.ibm.websphere.wssecurity.wssapi.token.SecurityToken>
getTokens(TokenGeneratorConfig tconfig,java.lang.String keyInfoType)
Gets the SecurityToken that is processed by the specified TokenGeneratorConfig object and is referenced by the specified type.
  1. java.util.Collection<com.ibm.websphere.wssecurity.wssapi.token.SecurityToken>
getTokensByKeyInfo(java.lang.String keyInfoName)
Returns the SecurityToken from the current subject with the specified keyInfoName.
  1. void
removeAllTokens()
Removes all SecurityToken objects from the current subject.
  1. void
removeToken(com.ibm.websphere.wssecurity.wssapi.token.SecurityToken token)
Removes the specified SecurityToken object from the current subject.
  1. void
removeTokens(java.util.Collection<com.ibm.websphere.wssecurity.wssapi.token.SecurityToken> tokens)
Removes all specified SecurityToken objects from the current subject.

Method Detail

addToken

  1. void addToken(com.ibm.websphere.wssecurity.wssapi.token.SecurityToken token)
Adds the specified SecurityToken object into the current Subject.
Parameters:
token - the SecurityToken object

getToken

  1. com.ibm.websphere.wssecurity.wssapi.token.SecurityToken getToken( TokenConsumerConfig tconfig,
  2. java.lang.String id)
Gets the SecurityToken from the Subject in this context with specified identifier. If there is no token with the identifier, returns null.
Parameters:
tconfig - The configuration of token consumer
id - An identifier for a desired token.
Returns:
The SecurityToken object with a given id. If no match occurred, returns null.

getToken

  1. com.ibm.websphere.wssecurity.wssapi.token.SecurityToken getToken( java.lang.String id)
Returns the SecurityToken from the current subject with the specified identifier. If there is no token with the identifier, returns null.
Parameters:
id - The identifier of the token
Returns:
The SecurityToken object that matches with the given identifier. If no match occurred, retuns null.

getTokensByKeyInfo

  1. java.util.Collection<com.ibm.websphere.wssecurity.wssapi.token.SecurityToken> getTokensByKeyInfo( java.lang.String keyInfoName)
Returns the SecurityToken from the current subject with the specified keyInfoName. If there is no token with the keyInfoName, returns null.
Parameters:
keyInfoName - The identifier of the keyInfo
Returns:
The SecurityToken object that matches with the given keyInfoName. If no match occurred, retuns null.

addTokens

  1. void addTokens(java.util.Collection<com.ibm.websphere.wssecurity.wssapi.token.SecurityToken> tokens)
Adds a list of SecurityToken objects into the current subject.
Parameters:
tokens - a list of SecurityToken objects

getTokens

  1. java.util.Collection<com.ibm.websphere.wssecurity.wssapi.token.SecurityToken> getTokens( )
Gets a set of SecurityToken objects stored in the current subject.
Returns:
a set of SecurityToken objects.

getTokens

  1. java.util.Collection<com.ibm.websphere.wssecurity.wssapi.token.SecurityToken> getTokens( TokenGeneratorConfig tconfig)
Gets the SecurityToken that is processed by the specified TokenGeneratorConfig object. If there is no token, returns null.
Parameters:
tconfig - The configuration of token generator
Returns:
The SecurityToken object with a given id. If no match occurred, returns null.

getTokens

  1. java.util.Collection<com.ibm.websphere.wssecurity.wssapi.token.SecurityToken> getTokens( TokenGeneratorConfig tconfig,
  2. java.lang.String keyInfoType)
Gets the SecurityToken that is processed by the specified TokenGeneratorConfig object and is referenced by the specified type. If there is no token, returns null.
Parameters:
tconfig - The configuration of token generator
keyInfoType - The type of key information
Returns:
The SecurityToken object with a given id. If no match occurred, returns null.

getTokens

  1. java.util.Collection<com.ibm.websphere.wssecurity.wssapi.token.SecurityToken> getTokens( TokenConsumerConfig tconfig)
Gets the SecurityToken that is processed by the specified TokenConsumerConfig object. If there is no token, returns null.
Parameters:
tconfig - The configuration of token consumer
Returns:
The SecurityToken object with a given id. If no match occurred, returns null.

getTokens

  1. java.util.Collection<com.ibm.websphere.wssecurity.wssapi.token.SecurityToken> getTokens( java.lang.String id)
Returns the SecurityToken objects from the Subject in this context with specified identifier. If there is no token with the identifier, returns null.
Parameters:
id - The identifier of the token
Returns:
The SecurityToken objects with a given id. If no match occurred, returns null.

removeToken

  1. void removeToken(com.ibm.websphere.wssecurity.wssapi.token.SecurityToken token)
Removes the specified SecurityToken object from the current subject.
Parameters:
token - The SecurityToken object to be removed

removeTokens

  1. void removeTokens(java.util.Collection<com.ibm.websphere.wssecurity.wssapi.token.SecurityToken> tokens)
Removes all specified SecurityToken objects from the current subject.
Parameters:
tokens - A list of SecurityToken objects to be removed

removeAllTokens

  1. void removeAllTokens()
Removes all SecurityToken objects from the current subject.