IBM WebSphere Application ServerTM
Release 7

com.ibm.wsspi.wssecurity.config
Interface TokenConsumerConfig

All Superinterfaces:
com.ibm.ws.webservices.wssecurity.config.Configuration

public interface TokenConsumerConfig
extends com.ibm.ws.webservices.wssecurity.config.Configuration

An interface for retrieving TokenConsumer configuration data.

See Also:
Configuration

Field Summary
static java.lang.String CONFIG_KEY
           
 
Method Summary
 java.util.Map getCallerProperties()
          Gets the Map object which contains name-value pairs related with the caller.
 TokenConsumerComponent getInstance()
          Gets the instance of token consumer.
 java.lang.String getJAASConfig()
          Gets the module name in the JAAS configuration.
 java.util.Map getJAASConfigProperties()
          Gets the Map object which contains name-value pairs for the JAAS configuration.
 java.security.cert.PKIXBuilderParameters getPKIXBuilderParameters()
          Gets the certificate store.
 java.util.Map getProperties()
          Gets the Map object which contains name-value pairs.
 java.security.Provider getProvider()
          Gets the provider.
 TrustedIDEvaluator getTrustedIDEvaluator()
          Gets the evaluator of trusted identifiers.
 java.util.Map getTrustMethodProperties()
          Gets the Map object which contains name-value pairs related with the trusted identifier.
 javax.xml.namespace.QName getType()
          Gets the type of this token.
 java.lang.String getUsage()
          Gets the usage of the consumer.
 boolean isCallerRequired()
          Checks whether the token is used to specify the caller.
 boolean isTrustAnyCertificate()
          Gets whether this consumer trusts any certificate.
 boolean isTrustMethodRequired()
          Checks whether the token is used to specify the trusted identifier.
 boolean isUsedForDecryption()
          Checks whether the token is used for decryption.
 boolean isUsedForVerification()
          Checks whether the token is used for signature verification.
 
Methods inherited from interface com.ibm.ws.webservices.wssecurity.config.Configuration
validate
 

Field Detail

CONFIG_KEY

static final java.lang.String CONFIG_KEY
See Also:
Constant Field Values
Method Detail

getInstance

TokenConsumerComponent getInstance()
Gets the instance of token consumer.

Returns:
The instance of token consumer

getUsage

java.lang.String getUsage()
Gets the usage of the consumer.

Returns:
The usage of the consumer

getType

javax.xml.namespace.QName getType()
Gets the type of this token. It is represented as the qualified name, such as wsse:X509v3 or wsse:UsernameToken.

Returns:
The type of this token

getTrustedIDEvaluator

TrustedIDEvaluator getTrustedIDEvaluator()
Gets the evaluator of trusted identifiers.

Returns:
The evaluator of trusted identifiers

isTrustAnyCertificate

boolean isTrustAnyCertificate()
Gets whether this consumer trusts any certificate.

Returns:
True of this consumer trusts any certificate, otherwise false

getProvider

java.security.Provider getProvider()
Gets the provider.

Returns:
The provider

getPKIXBuilderParameters

java.security.cert.PKIXBuilderParameters getPKIXBuilderParameters()
Gets the certificate store.

Returns:
The certificate store

isCallerRequired

boolean isCallerRequired()
Checks whether the token is used to specify the caller.

Returns:
True if the token is used to specify the caller, otherwise false

getCallerProperties

java.util.Map getCallerProperties()
Gets the Map object which contains name-value pairs related with the caller.

Returns:
The Map object

isTrustMethodRequired

boolean isTrustMethodRequired()
Checks whether the token is used to specify the trusted identifier.

Returns:
True if the token is used to specify the trusted identifier, otherwise false

getTrustMethodProperties

java.util.Map getTrustMethodProperties()
Gets the Map object which contains name-value pairs related with the trusted identifier.

Returns:
The Map object

getJAASConfig

java.lang.String getJAASConfig()
Gets the module name in the JAAS configuration.

Returns:
The module name in the JAAS configuration

getJAASConfigProperties

java.util.Map getJAASConfigProperties()
Gets the Map object which contains name-value pairs for the JAAS configuration.

Returns:
The Map object

isUsedForVerification

boolean isUsedForVerification()
Checks whether the token is used for signature verification.

Returns:
True if the token is used for signature verification, otherwise false

isUsedForDecryption

boolean isUsedForDecryption()
Checks whether the token is used for decryption.

Returns:
True if the token is used for decryption, otherwise false

getProperties

java.util.Map getProperties()
Gets the Map object which contains name-value pairs. These pairs include <Property> elements in the configuration XMI files.

Returns:
The Map object

IBM WebSphere Application ServerTM
Release 7