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.
User should never implement this interface directly, and is required to useSAMLTokenFactory
to get an instance of ProviderConfig.
-
-
Method Summary
Methods Modifier and Type Method and Description java.lang.String
getAttributeProvider()
Retrieves the name of the Attribute provider used by this SAML token issuer.java.lang.String
getAudience()
Retrieves the setting for the Audience elementjava.lang.String
getIssuerFormat()
Retrieves the Issuer FormatKeyInformationConfig
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()
Deprecated.Not for public use.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
setAudience(java.lang.String audienceRestriction)
Sets the value for the Audience element in the AudienceRestriction Condition.void
setIssuerFormat(java.lang.String format)
Sets the Issuer Formatvoid
setIssuerURI(java.lang.String uri)
Sets the Issuer URIvoid
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)
Deprecated.Not for public use.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
-
-
-
-
Method Detail
-
getKeyInformationConfig
KeyInformationConfig getKeyInformationConfig()
Retrieves the key attributes for the SAML token issuer.- Returns:
- key information configuration object for the SAML token issuer.
-
getKeyStoreConfig
KeyStoreConfig getKeyStoreConfig()
Retrieves the keyStore configuration object for the SAML token issuer.- Returns:
- keyStore configuration object for the SAML token issuer.
-
getTrustStoreConfig
KeyStoreConfig getTrustStoreConfig()
Retrieves the trustStore configuration object for the SAML token issuer.- Returns:
- trustStore configuration object for the SAML token issuer.
-
validate
void validate() throws SoapSecurityException
Performs validation on the configuration of the SAML token issuer.- Specified by:
validate
in interfaceConfiguration
- 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()
Deprecated. Not for public use.
-
getIssuerFormat
java.lang.String getIssuerFormat()
Retrieves the Issuer Format- Returns:
- a String representing the Issuer Format attribute
-
setTimeToLive
void setTimeToLive(long ttl)
Sets the lifetime value for the tokens issued by this SAML token issuer.- Parameters:
ttl
- Token's lifetime.
-
setAttributeProvider
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
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
void setSamlModifier(java.lang.String mod)
Deprecated. Not for public use.
-
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.
-
setKeyStoreConfig
void setKeyStoreConfig(KeyStoreConfig ksc)
Sets the keyStore configuration object for the SAML token issuer.
-
setTrustStoreConfig
void setTrustStoreConfig(KeyStoreConfig tsc)
Sets the trustStore configuration object for the SAML token issuer.
-
setIssuerFormat
void setIssuerFormat(java.lang.String format)
Sets the Issuer Format- Parameters:
format
- A string identifying the Issuer Format attribute
-
setIssuerURI
void setIssuerURI(java.lang.String uri)
Sets the Issuer URI- Specified by:
setIssuerURI
in interfaceProviderConfiguration
- Parameters:
uri
- A string identifying the Issuer URI
-
setAudience
void setAudience(java.lang.String audienceRestriction)
Sets the value for the Audience element in the AudienceRestriction Condition. Only one Audience can get set.- Parameters:
uri
- A string identifying the value for the Audience element
-
getAudience
java.lang.String getAudience()
Retrieves the setting for the Audience element- Returns:
- a String representing the Audience value
-
-