IBM WebSphere Application ServerTM
Release 7

com.ibm.wsspi.wssecurity.saml.config
Interface ConsumerConfig

All Superinterfaces:
Configuration, ConsumerConfiguration

public interface ConsumerConfig
extends ConsumerConfiguration

This interface encapsulates getter and setter methods for the configuration attributes of the SAML token consumer.


Field Summary
static long DEFAULT_CLOCKSKEW
           
 
Method Summary
 java.lang.String getAlgorithmSuite()
          Returns the Encryption Algorithm for encrypted token or key.
 java.lang.String getAliasForTokenProvider()
          Returns a string representing the key alias corresponding to the token provider.
 long getClockSkew()
          Return the allowable clock skew.
 KeyInformationConfig getKeyInformationConfig()
          Returns the KeyInformationConfig object to be be used to decrypt an encrypted SAML token or key.
 KeyStoreConfig getKeyStoreConfig()
          Returns the KeyStoreConfig object used for the decryption of a SAML token or keys.
 KeyStoreConfig getTrustStoreConfig()
          Returns the KeyStoreConfig object used in the validation of the SAML Enveloped-Signature.
 boolean isAssertionSignatureRequired()
          Returns an indication as to whether this token consumer requires signed SAML assertions.
 void setAlgorithmSuite(java.lang.String alg)
          Sets the encryption algorithm for the encrypted token or key.
 void setAliasForTokenProvider(java.lang.String alias)
          Sets alias for Token provider's key.
 void setAssertionSignatureRequired(boolean option)
          Indicates if signature on the assertion is required by this consumer.
 void setClockSkew(long time)
          Set clock skew
 void setKeyInformationConfig(KeyInformationConfig kic)
          Sets the Key Information configuration attribute.
 void setKeyStoreConfig(KeyStoreConfig ksc)
          Sets the KeyStore configuration attribute.
 void setTrustAnySTS(boolean option)
          Indicates if this consumer trusts all token providers.
 void setTrustStoreConfig(KeyStoreConfig tsc)
          Sets the TrustStore configuration attribute.
 boolean trustAnySTS()
          Returns an indication as to whether this token consumer trusts all token providers.
 
Methods inherited from interface com.ibm.wsspi.wssecurity.core.config.Configuration
validate
 

Field Detail

DEFAULT_CLOCKSKEW

static final long DEFAULT_CLOCKSKEW
See Also:
Constant Field Values
Method Detail

getAlgorithmSuite

java.lang.String getAlgorithmSuite()
Returns the Encryption Algorithm for encrypted token or key.

Returns:
a string representing the Encryption Algorithm for encrypted SAML token or keys.

getKeyInformationConfig

KeyInformationConfig getKeyInformationConfig()
Returns the KeyInformationConfig object to be be used to decrypt an encrypted SAML token or key.

Returns:
KeyInformationConfig for the decryption of encrypted SAML token or keys.
See Also:
KeyInformationConfig

getKeyStoreConfig

KeyStoreConfig getKeyStoreConfig()
Returns the KeyStoreConfig object used for the decryption of a SAML token or keys.

Returns:
KeyStoreConfig for the decryption of encrypted SAML token or Keys.
See Also:
KeyStoreConfig

getTrustStoreConfig

KeyStoreConfig getTrustStoreConfig()
Returns the KeyStoreConfig object used in the validation of the SAML Enveloped-Signature.

Returns:
KeyStoreConfig object to be used for the SAML Enveloped-Signature validation.
See Also:
KeyStoreConfig

getAliasForTokenProvider

java.lang.String getAliasForTokenProvider()
Returns a string representing the key alias corresponding to the token provider.

Returns:
alias name for the token provider's key.

isAssertionSignatureRequired

boolean isAssertionSignatureRequired()
Returns an indication as to whether this token consumer requires signed SAML assertions.

Returns:
boolean true or false indicating if the consumer of the SAML token requires signed assertions.

trustAnySTS

boolean trustAnySTS()
Returns an indication as to whether this token consumer trusts all token providers.

Returns:
boolean true or false indicating if the consumer of the SAML token trusts all token providers.

setAlgorithmSuite

void setAlgorithmSuite(java.lang.String alg)
Sets the encryption algorithm for the encrypted token or key.

Parameters:
alg - a string representing the algorithm.

setKeyInformationConfig

void setKeyInformationConfig(KeyInformationConfig kic)
Sets the Key Information configuration attribute.

See Also:
KeyInformationConfig

setKeyStoreConfig

void setKeyStoreConfig(KeyStoreConfig ksc)
Sets the KeyStore configuration attribute.

See Also:
KeyStoreConfig

setTrustStoreConfig

void setTrustStoreConfig(KeyStoreConfig tsc)
Sets the TrustStore configuration attribute.

Parameters:
tsc - of KeyStoreConfig type.
See Also:
KeyStoreConfig

setAliasForTokenProvider

void setAliasForTokenProvider(java.lang.String alias)
Sets alias for Token provider's key.

Parameters:
alias - name for the provider's key.

setAssertionSignatureRequired

void setAssertionSignatureRequired(boolean option)
Indicates if signature on the assertion is required by this consumer.

Parameters:
option - boolean true or false.

setTrustAnySTS

void setTrustAnySTS(boolean option)
Indicates if this consumer trusts all token providers.

Parameters:
option - boolean true or false.

getClockSkew

long getClockSkew()
Return the allowable clock skew.

Returns:
the maximum allowable clock skew

setClockSkew

void setClockSkew(long time)
Set clock skew

Parameters:
clock - kew in milliseconds

IBM WebSphere Application ServerTM
Release 7