com.ibm.wsspi.wssecurity.saml.config

Interface RequesterConfig

All Superinterfaces:
Configuration, RequesterConfiguration

  1. public interface RequesterConfig
  2. extends RequesterConfiguration

This interface encapsulates the configuration information for the requesting entity of the SAML token.

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

Nested Class Summary

Modifier and Type Interface and Description
  1. static class
RequesterConfig.requestMode
Nested classes/interfaces inherited from interface com.ibm.wsspi.wssecurity.core.token.config.RequesterConfiguration
RequesterConfiguration.RSTT, RequesterConfiguration.RSTT13

Field Summary

Modifier and Type Field and Description
  1. static
  2. long
DEFAULT_CLOCKSKEW

Method Summary

Modifier and Type Method and Description
  1. boolean
enableNotBefore()
  1. java.lang.String
getAddress()
  1. java.lang.String
getAuthenticatingAuthority()
  1. java.lang.String
getAuthenticationMethod()
Retrieves the type of authentication used by the requester; password authentication.
  1. java.lang.String
getAuthnContextDecl()
  1. java.lang.String
getAuthnContextDeclRef()
  1. long
getClockSkew()
Return the allowable clock skew.
  1. java.lang.String
getConfirmationMethod()
Retrieves the SAML confirmation method used by the requester.
  1. java.lang.String
getEncryptionKeyInfoType()
Retrieves the type of encryption that the requester chooses to apply when holder of key subject confirmation is used.
  1. java.lang.String
getHolderOfKeyKeyInfoType()
Retrieves the value type of the holder of key material; e.g a key value indicates the presence of a key material.
  1. java.lang.String
getInResponseTo()
  1. RequesterConfig.requestMode
getIssueMode()
  1. java.lang.String
getKeyAliasForAppliesTo()
Retrieves the recipient's key alias that is used to encrypt the proof of key info in the subject confirmation of the SAML token.
  1. java.lang.String
getKeyAliasForRequester()
Retrieves the requester's key alias name to be used for the holder of key confirmation.
  1. long
getNotOnOrAfter()
  1. java.lang.String
getRecipient()
  1. java.lang.String
getRequesterDNSAddress()
Retrieves the DNS address for the requester.
  1. java.lang.String
getRequesterIPAddress()
Retrieves the IP address for the requester.
  1. long
getSessionNotOnOrAfter()
  1. java.lang.String
getSignatureKeyInfoType()
Retrieves the type of public key used for the signature on the assertion (e.g.; X509Certificate).
  1. java.lang.String
getStatementType()
Retrieves the type of SAML statement being requested.
  1. boolean
includeCredentialToken()
  1. boolean
includeExpiration()
  1. boolean
includeGroupIds()
  1. boolean
includeHostName()
  1. boolean
includeOID()
  1. boolean
includePrimaryGroupId()
  1. boolean
includeRealmName()
  1. boolean
includeSecurityName()
  1. boolean
includeUniqueSecurityName()
  1. boolean
isAssertionSignatureRequired()
Retrieves the indication of whether or not this requester requires a signature on the SAML assertion.
  1. boolean
isEncryptSAML()
  1. boolean
isOneTimeUse()
Retrieves the indication of whether or not this requester requires an OneTimeUse assertion.
  1. boolean
isSessionIndexEnabled()
Retrieves the indication of whether the session between the requester and the authentication service to which the user authenticates will be indexed (uniquely identified) in the SAML assertion.
  1. void
setAddress(java.lang.String url)
  1. void
setAssertionSignatureRequired(boolean option)
Sets the indication of whether or not this requester requires a signature on the SAML assertion.
  1. void
setAuthenticatingAuthority(java.lang.String url)
  1. void
setAuthenticationMethod(java.lang.String method)
Sets the type of authentication used by the requester; password authentication.
  1. void
setAuthnContextDecl(java.lang.String url)
  1. void
setAuthnContextDeclRef(java.lang.String url)
  1. void
setClockSkew(long time)
Set clock skew
  1. void
setConfirmationMethod(java.lang.String method)
Sets the confirmation method to be used (e.g. bearer, holder of key or sender vouches)
  1. void
setEnableNotBefore(boolean notBefore)
  1. void
setEncryptionKeyInfoType(java.lang.String type)
Sets the type of encryption that the requester chooses to apply when holder of key subject confirmation is used.
  1. void
setEncryptSAML(boolean enc)
  1. void
setHolderOfKeyKeyInfoType(java.lang.String type)
Sets the value type of the holder of key material; e.g a keyValue indicates the presence of a key material.
  1. void
setIncludeCredentialToken(boolean flag)
Sets boolean flag to assert CredentialToken from WSCredential as an SAML attribute.
  1. void
setIncludeExpiration(boolean flag)
Sets boolean flag to assert Expiration from WSCredential as an SAML attribute.
  1. void
setIncludeGroupIds(boolean flag)
Sets boolean flag to assert GroupIds from WSCredential as an SAML attribute.
  1. void
setIncludeHostName(boolean flag)
Sets boolean flag to assert HostName from WSCredential as an SAML attribute.
  1. void
setIncludeOID(boolean flag)
Sets boolean flag to assert OID from WSCredential as an SAML attribute.
  1. void
setIncludePrimaryGroupId(boolean flag)
Sets boolean flag to assert PrimaryGroupId from WSCredential as an SAML attribute.
  1. void
setIncludeRealmName(boolean flag)
Sets boolean flag to assert realm from WSCredential as an SAML attribute.
  1. void
setIncludeSecurityName(boolean flag)
Sets boolean flag to assert SecurityName from WSCredential as an SAML attribute.
  1. void
setIncludeUniqueSecurityName(boolean flag)
Sets boolean flag to assert UniqueSecurityName from WSCredential as an SAML attribute.
  1. void
setInResponseTo(java.lang.String url)
  1. void
setIssueMode(RequesterConfig.requestMode mode)
  1. void
setKeyAliasForAppliesTo(java.lang.String type)
Sets the recipient's key alias that is used to encrypt the proof of key info in the subject confirmation of the SAML token.
  1. void
setKeyAliasForRequester(java.lang.String alias)
Sets the requester's key alias name to be used for the holder of key confirmation.
  1. void
setNotOnOrAfter(long minutes)
  1. void
setOneTimeUse(boolean option)
Sets the indication of whether or not this requester requires an OneTimeUse assertion.
  1. void
setRecipient(java.lang.String url)
  1. void
setRequesterDNSAddress(java.lang.String dns)
Sets the DNS address for the SubjectLocality.
  1. void
setRequesterIPAddress(java.lang.String ip)
Sets the IP address for the SubjectLocality.
  1. void
setSessionNotOnOrAfter(long minutes)
  1. void
setSignatureKeyInfoType(java.lang.String type)
Sets the type of public key used for the signature on the assertion (e.g.; X509Certificate).
  1. void
setStatementType(java.lang.String type)
Sets the type of SAML statement being requested.
  1. void
setUseSha2ForSignature(boolean flag)
Set the flag.
  1. void
setUseUniqueSecurityName(boolean flag)
Sets boolean flag to use UniqueSecurityName from WSCredential as NameID or NameIdentifier.
  1. boolean
useSha2ForSignature()
Return the flag.
  1. boolean
useUniqueSecurityName()
Methods inherited from interface com.ibm.wsspi.wssecurity.core.token.config.RequesterConfiguration
getRSTTProperties, setRSTTProperties
Methods inherited from interface com.ibm.wsspi.wssecurity.core.config.Configuration
validate

Field Detail

DEFAULT_CLOCKSKEW

  1. static final long DEFAULT_CLOCKSKEW
See Also:

Method Detail

getConfirmationMethod

  1. java.lang.String getConfirmationMethod( )
Retrieves the SAML confirmation method used by the requester. Subject confirmation is of three type:
  • bearer
  • holder of key
  • sender vouches <\ul>
Returns:
a string indicating the confirmation method used.

getEncryptionKeyInfoType

  1. java.lang.String getEncryptionKeyInfoType( )
Retrieves the type of encryption that the requester chooses to apply when holder of key subject confirmation is used.
Returns:
a string indicating the type of encryption key to be used.

getHolderOfKeyKeyInfoType

  1. java.lang.String getHolderOfKeyKeyInfoType( )
Retrieves the value type of the holder of key material; e.g a key value indicates the presence of a key material.
Returns:
a string indicating the type of of holder of key value.

isSessionIndexEnabled

  1. boolean isSessionIndexEnabled()
Retrieves the indication of whether the session between the requester and the authentication service to which the user authenticates will be indexed (uniquely identified) in the SAML assertion.
Returns:
a boolean value indicating whether the authentication session is to be indexed.

getSignatureKeyInfoType

  1. java.lang.String getSignatureKeyInfoType( )
Retrieves the type of public key used for the signature on the assertion (e.g.; X509Certificate).
Returns:
a string representing the type of public key used for the signature on the assertion.

getStatementType

  1. java.lang.String getStatementType( )
Retrieves the type of SAML statement being requested.
Returns:
a string representing the type of statement requested.

getAuthenticationMethod

  1. java.lang.String getAuthenticationMethod( )
Retrieves the type of authentication used by the requester; password authentication.
Returns:
a string representing the type of authentication used by the requester.

getKeyAliasForAppliesTo

  1. java.lang.String getKeyAliasForAppliesTo( )
Retrieves the recipient's key alias that is used to encrypt the proof of key info in the subject confirmation of the SAML token.
Returns:
a string representing the key alias for the recipient (consumer of the SAML token).

getKeyAliasForRequester

  1. java.lang.String getKeyAliasForRequester( )
Retrieves the requester's key alias name to be used for the holder of key confirmation.
Returns:
a string representing the key alias for the requester of the SAML token.

getRequesterDNSAddress

  1. java.lang.String getRequesterDNSAddress( )
Retrieves the DNS address for the requester.
Returns:
a string representing the requester's DNS address.

getRequesterIPAddress

  1. java.lang.String getRequesterIPAddress( )
Retrieves the IP address for the requester.
Returns:
a string representing the requester's IP address.

isAssertionSignatureRequired

  1. boolean isAssertionSignatureRequired( )
Retrieves the indication of whether or not this requester requires a signature on the SAML assertion.
Returns:
a boolean for whether the requester requires signed assertions.

isOneTimeUse

  1. boolean isOneTimeUse()
Retrieves the indication of whether or not this requester requires an OneTimeUse assertion.
Returns:
a boolean for whether the requester requires an OneTimeUse assertion.

setConfirmationMethod

  1. void setConfirmationMethod(java.lang.String method)
Sets the confirmation method to be used (e.g. bearer, holder of key or sender vouches)

setEncryptionKeyInfoType

  1. void setEncryptionKeyInfoType(java.lang.String type)
Sets the type of encryption that the requester chooses to apply when holder of key subject confirmation is used.

setHolderOfKeyKeyInfoType

  1. void setHolderOfKeyKeyInfoType( java.lang.String type)
Sets the value type of the holder of key material; e.g a keyValue indicates the presence of a key material.

setSignatureKeyInfoType

  1. void setSignatureKeyInfoType(java.lang.String type)
Sets the type of public key used for the signature on the assertion (e.g.; X509Certificate).

setStatementType

  1. void setStatementType(java.lang.String type)
Sets the type of SAML statement being requested.

setAuthenticationMethod

  1. void setAuthenticationMethod(java.lang.String method)
Sets the type of authentication used by the requester; password authentication.

setKeyAliasForAppliesTo

  1. void setKeyAliasForAppliesTo(java.lang.String type)
Sets the recipient's key alias that is used to encrypt the proof of key info in the subject confirmation of the SAML token.

setKeyAliasForRequester

  1. void setKeyAliasForRequester(java.lang.String alias)
Sets the requester's key alias name to be used for the holder of key confirmation.

setRequesterDNSAddress

  1. void setRequesterDNSAddress(java.lang.String dns)
Sets the DNS address for the SubjectLocality.

setRequesterIPAddress

  1. void setRequesterIPAddress(java.lang.String ip)
Sets the IP address for the SubjectLocality.

setAssertionSignatureRequired

  1. void setAssertionSignatureRequired( boolean option)
Sets the indication of whether or not this requester requires a signature on the SAML assertion.

setOneTimeUse

  1. void setOneTimeUse(boolean option)
Sets the indication of whether or not this requester requires an OneTimeUse assertion.

getClockSkew

  1. long getClockSkew()
Return the allowable clock skew.
Returns:
the maximum allowable clock skew

setClockSkew

  1. void setClockSkew(long time)
Set clock skew

includeRealmName

  1. boolean includeRealmName()

setIncludeRealmName

  1. void setIncludeRealmName(boolean flag)
Sets boolean flag to assert realm from WSCredential as an SAML attribute.

includeSecurityName

  1. boolean includeSecurityName()

setIncludeSecurityName

  1. void setIncludeSecurityName(boolean flag)
Sets boolean flag to assert SecurityName from WSCredential as an SAML attribute.

includeUniqueSecurityName

  1. boolean includeUniqueSecurityName( )

setIncludeUniqueSecurityName

  1. void setIncludeUniqueSecurityName( boolean flag)
Sets boolean flag to assert UniqueSecurityName from WSCredential as an SAML attribute.

includeCredentialToken

  1. boolean includeCredentialToken( )

setIncludeCredentialToken

  1. void setIncludeCredentialToken( boolean flag)
Sets boolean flag to assert CredentialToken from WSCredential as an SAML attribute.

includeOID

  1. boolean includeOID()

setIncludeOID

  1. void setIncludeOID(boolean flag)
Sets boolean flag to assert OID from WSCredential as an SAML attribute.

includeExpiration

  1. boolean includeExpiration()

setIncludeExpiration

  1. void setIncludeExpiration(boolean flag)
Sets boolean flag to assert Expiration from WSCredential as an SAML attribute.

includePrimaryGroupId

  1. boolean includePrimaryGroupId()

setIncludePrimaryGroupId

  1. void setIncludePrimaryGroupId(boolean flag)
Sets boolean flag to assert PrimaryGroupId from WSCredential as an SAML attribute.

includeGroupIds

  1. boolean includeGroupIds()

setIncludeGroupIds

  1. void setIncludeGroupIds(boolean flag)
Sets boolean flag to assert GroupIds from WSCredential as an SAML attribute.

includeHostName

  1. boolean includeHostName()

setIncludeHostName

  1. void setIncludeHostName(boolean flag)
Sets boolean flag to assert HostName from WSCredential as an SAML attribute.

useUniqueSecurityName

  1. boolean useUniqueSecurityName()

setUseUniqueSecurityName

  1. void setUseUniqueSecurityName(boolean flag)
Sets boolean flag to use UniqueSecurityName from WSCredential as NameID or NameIdentifier.

getIssueMode

  1. RequesterConfig.requestMode getIssueMode( )

setIssueMode

  1. void setIssueMode(RequesterConfig.requestMode mode)

useSha2ForSignature

  1. boolean useSha2ForSignature()
Return the flag.
Returns:
the flag if use Sha2 for signature

setUseSha2ForSignature

  1. void setUseSha2ForSignature(boolean flag)
Set the flag.

setInResponseTo

  1. void setInResponseTo(java.lang.String url)

getInResponseTo

  1. java.lang.String getInResponseTo( )

setRecipient

  1. void setRecipient(java.lang.String url)

getRecipient

  1. java.lang.String getRecipient()

setAddress

  1. void setAddress(java.lang.String url)

getAddress

  1. java.lang.String getAddress()

setEnableNotBefore

  1. void setEnableNotBefore(boolean notBefore)

enableNotBefore

  1. boolean enableNotBefore()

setNotOnOrAfter

  1. void setNotOnOrAfter(long minutes)

getNotOnOrAfter

  1. long getNotOnOrAfter()

setAuthnContextDeclRef

  1. void setAuthnContextDeclRef(java.lang.String url)

getAuthnContextDeclRef

  1. java.lang.String getAuthnContextDeclRef( )

setAuthnContextDecl

  1. void setAuthnContextDecl(java.lang.String url)

getAuthnContextDecl

  1. java.lang.String getAuthnContextDecl( )

setAuthenticatingAuthority

  1. void setAuthenticatingAuthority( java.lang.String url)

getAuthenticatingAuthority

  1. java.lang.String getAuthenticatingAuthority( )

setSessionNotOnOrAfter

  1. void setSessionNotOnOrAfter(long minutes)

getSessionNotOnOrAfter

  1. long getSessionNotOnOrAfter()

setEncryptSAML

  1. void setEncryptSAML(boolean enc)

isEncryptSAML

  1. boolean isEncryptSAML()