com.ibm.wsspi.wssecurity.saml.config

Interface ProviderConfig

All Superinterfaces:
Configuration, ProviderConfiguration

  1. public interface ProviderConfig
  2. extends ProviderConfiguration

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

User should never implement this interface directly, and is required to use SAMLTokenFactory to get an instance of ProviderConfig.

Method Summary

Modifier and Type Method and Description
  1. java.lang.String
getAttributeProvider()
Retrieves the name of the Attribute provider used by this SAML token issuer.
  1. KeyInformationConfig
getKeyInformationConfig()
Retrieves the key attributes for the SAML token issuer.
  1. KeyStoreConfig
getKeyStoreConfig()
Retrieves the keyStore configuration object for the SAML token issuer.
  1. java.lang.String
getNameIDProvider()
Retrieves the NameIDProvider provider used by this SAML token issuer.
  1. java.lang.String
getSamlModifier()
Retrieves the implementation class name that is configured for modification of a SAML Assertion before it is signed.
  1. long
getTimeToLive()
Retrieves the lifetime of the SAML tokens issued by this provider.
  1. KeyStoreConfig
getTrustStoreConfig()
Retrieves the trustStore configuration object for the SAML token issuer.
  1. void
setAttributeProvider(java.lang.String provider)
Sets the name of the Attribute provider used by this SAML token issuer.
  1. void
setKeyInformationConfig(KeyInformationConfig kic)
Sets the key information attributes for the SAML token issuer.
  1. void
setKeyStoreConfig(KeyStoreConfig ksc)
Sets the keyStore configuration object for the SAML token issuer.
  1. void
setNameIDProvider(java.lang.String provider)
Sets the NameIDProvider used by this SAML token issuer.
  1. void
setSamlModifier(java.lang.String mod)
Sets the implementation class name that is configured for modification of a SAML Assertion before it is signed.
  1. void
setTimeToLive(long ttl)
Sets the lifetime value for the tokens issued by this SAML token issuer.
  1. void
setTrustStoreConfig(KeyStoreConfig tsc)
Sets the trustStore configuration object for the SAML token issuer.
  1. 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

  1. KeyInformationConfig getKeyInformationConfig( )
Retrieves the key attributes for the SAML token issuer.
Returns:
key information configuration object for the SAML token issuer.
See Also:

getKeyStoreConfig

  1. 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

  1. 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

  1. void validate()
  2. 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

  1. 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

  1. 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

  1. java.lang.String getNameIDProvider( )
Retrieves the NameIDProvider provider used by this SAML token issuer.
Returns:
a string representing the NameIDProvider.

getSamlModifier

  1. 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

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

setAttributeProvider

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

setNameIDProvider

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

setSamlModifier

  1. 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

  1. 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:

setKeyStoreConfig

  1. void setKeyStoreConfig(KeyStoreConfig ksc)
Sets the keyStore configuration object for the SAML token issuer.
See Also:
ccom.ibm.wsspi.wssecurity.core.config.KeyStoreConfig.

setTrustStoreConfig

  1. void setTrustStoreConfig(KeyStoreConfig tsc)
Sets the trustStore configuration object for the SAML token issuer.
See Also:
ccom.ibm.wsspi.wssecurity.core.config.KeyStoreConfig.