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. java.lang.String
getIssuerFormat()
Retrieves the Issuer Format
  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()
Deprecated. Not for public use.
  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
setIssuerFormat(java.lang.String format)
Sets the Issuer Format
  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)
Deprecated. Not for public use.
  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.

getKeyStoreConfig

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

getTrustStoreConfig

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

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( )
Deprecated. Not for public use.

getIssuerFormat

  1. java.lang.String getIssuerFormat( )
Retrieves the Issuer Format
Returns:
a String representing the Issuer Format attribute

setTimeToLive

  1. void setTimeToLive(long ttl)
Sets the lifetime value for the tokens issued by this SAML token issuer.
Parameters:
ttl - Token's lifetime.

setAttributeProvider

  1. void setAttributeProvider(java.lang.String provider)
Sets the name of the Attribute provider used by this SAML token issuer.
Parameters:
provider - Attribute provider class name.
See Also:
com.ibm.websphere.wssecurity.callbackhandler.Saml11AttributeCallback, com.ibm.websphere.wssecurity.callbackhandler.Saml20AttributeCallback

setNameIDProvider

  1. void setNameIDProvider(java.lang.String provider)
Sets the NameIDProvider used by this SAML token issuer.
Parameters:
provider - NameIDProvider provider class name
See Also:
com.ibm.websphere.wssecurity.callbackhandler.NameIDCallback

setSamlModifier

  1. void setSamlModifier(java.lang.String mod)
Deprecated. Not for public use.

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.

setKeyStoreConfig

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

setTrustStoreConfig

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

setIssuerFormat

  1. void setIssuerFormat(java.lang.String format)
Sets the Issuer Format
Parameters:
format - A string identifying the Issuer Format attribute