IBM WebSphere Application ServerTM
Release 7

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

All Superinterfaces:
Configuration, ProviderConfiguration

public interface ProviderConfig
extends ProviderConfiguration

This interface encapsulates the configuration information for the SAML token provider.


Method Summary
 java.lang.String getAttributeProvider()
          Retrieves the name of the Attribute provider used by this SAML token issuer.
 KeyInformationConfig getKeyInformationConfig()
          Retrieves the key attributes for the SAML token issuer.
 KeyStoreConfig getKeyStoreConfig()
          Retrieves the keyStore configuration object for the SAML token issuer.
 java.lang.String getNameIDProvider()
          Retrieves the NameIDProvider provider used by this SAML token issuer.
 java.lang.String getSamlModifier()
          Retrieves the implementation class name that is configured for modification of a SAML Assertion before it is signed.
 long getTimeToLive()
          Retrieves the lifetime of the SAML tokens issued by this provider.
 KeyStoreConfig getTrustStoreConfig()
          Retrieves the trustStore configuration object for the SAML token issuer.
 void setAttributeProvider(java.lang.String provider)
          Sets the name of the Attribute provider used by this SAML token issuer.
 void setKeyInformationConfig(KeyInformationConfig kic)
          Sets the key information attributes for the SAML token issuer.
 void setKeyStoreConfig(KeyStoreConfig ksc)
          Sets the keyStore configuration object for the SAML token issuer.
 void setNameIDProvider(java.lang.String provider)
          Sets the NameIDProvider used by this SAML token issuer.
 void setSamlModifier(java.lang.String mod)
          Sets the implementation class name that is configured for modification of a SAML Assertion before it is signed.
 void setTimeToLive(long ttl)
          Sets the lifetime value for the tokens issued by this SAML token issuer.
 void setTrustStoreConfig(KeyStoreConfig tsc)
          Sets the trustStore configuration object for the SAML token issuer.
 void validate()
          Performs validation on the configuration of the SAML token issuer.
 
Methods inherited from interface com.ibm.wsspi.wssecurity.core.token.config.ProviderConfiguration
getIssuerURI, setIssuerURI
 

Method Detail

getKeyInformationConfig

KeyInformationConfig getKeyInformationConfig()
Retrieves the key attributes for the SAML token issuer.

Returns:
key information configuration object for the SAML token issuer.
See Also:
KeyInformationConfig

getKeyStoreConfig

KeyStoreConfig getKeyStoreConfig()
Retrieves the keyStore configuration object for the SAML token issuer.

Returns:
keyStore configuration object for the SAML token issuer.
See Also:
ccom.ibm.wsspi.wssecurity.core.config.KeyStoreConfig.

getTrustStoreConfig

KeyStoreConfig getTrustStoreConfig()
Retrieves the trustStore configuration object for the SAML token issuer.

Returns:
trustStore configuration object for the SAML token issuer.
See Also:
ccom.ibm.wsspi.wssecurity.core.config.KeyStoreConfig.

validate

void validate()
              throws SoapSecurityException
Performs validation on the configuration of the SAML token issuer.

Specified by:
validate in interface Configuration
Throws:
SoapSecurityException - When there is a problem during the validation

getTimeToLive

long getTimeToLive()
Retrieves the lifetime of the SAML tokens issued by this provider.

Returns:
a long integer representing the lifetime of the token issued by this provider.

getAttributeProvider

java.lang.String getAttributeProvider()
Retrieves the name of the Attribute provider used by this SAML token issuer.

Returns:
a string representing the name of the Attribute provider.

getNameIDProvider

java.lang.String getNameIDProvider()
Retrieves the NameIDProvider provider used by this SAML token issuer.

Returns:
a string representing the NameIDProvider.

getSamlModifier

java.lang.String getSamlModifier()
Retrieves the implementation class name that is configured for modification of a SAML Assertion before it is signed.

Returns:
a string representing the configured class name used to modify the SAML assertion.

setTimeToLive

void setTimeToLive(long ttl)
Sets the lifetime value for the tokens issued by this SAML token issuer.

Parameters:
a - long integer for the tokens lifetime.

setAttributeProvider

void setAttributeProvider(java.lang.String provider)
Sets the name of the Attribute provider used by this SAML token issuer.

Parameters:
a - string identifying an Attribute provider.

setNameIDProvider

void setNameIDProvider(java.lang.String provider)
Sets the NameIDProvider used by this SAML token issuer.

Parameters:
a - string identifying NameIDProvider provider.

setSamlModifier

void setSamlModifier(java.lang.String mod)
Sets the implementation class name that is configured for modification of a SAML Assertion before it is signed.


setKeyInformationConfig

void setKeyInformationConfig(KeyInformationConfig kic)
Sets the key information attributes for the SAML token issuer.

Parameters:
kic - object encapsulating the attributes of the issuer's key information.
See Also:
KeyInformationConfig

setKeyStoreConfig

void setKeyStoreConfig(KeyStoreConfig ksc)
Sets the keyStore configuration object for the SAML token issuer.

See Also:
ccom.ibm.wsspi.wssecurity.core.config.KeyStoreConfig.

setTrustStoreConfig

void setTrustStoreConfig(KeyStoreConfig tsc)
Sets the trustStore configuration object for the SAML token issuer.

See Also:
ccom.ibm.wsspi.wssecurity.core.config.KeyStoreConfig.

IBM WebSphere Application ServerTM
Release 7