IBM WebSphere Application ServerTM
Release 7

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

All Superinterfaces:
Configuration, RequesterConfiguration

public interface RequesterConfig
extends RequesterConfiguration

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


Nested Class Summary
 
Nested classes/interfaces inherited from interface com.ibm.wsspi.wssecurity.core.token.config.RequesterConfiguration
RequesterConfiguration.RSTT, RequesterConfiguration.RSTT13
 
Method Summary
 java.lang.String getAuthenticationMethod()
          Retrieves the type of authentication used by the requester; password authentication.
 java.lang.String getConfirmationMethod()
          Retrieves the SAML confirmation method used by the requester.
 java.lang.String getEncryptionKeyInfoType()
          Retrieves the type of encryption that the requester chooses to apply when holder of key subject confirmation is used.
 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.
 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.
 java.lang.String getKeyAliasForRequester()
          Retrieves the requester's key alias name to be used for the holder of key confirmation.
 java.lang.String getRequesterDNSAddress()
          Retrieves the DNS address for the requester.
 java.lang.String getRequesterIPAddress()
          Retrieves the IP address for the requester.
 java.lang.String getSignatureKeyInfoType()
          Retrieves the type of public key used for the signature on the assertion (e.g.; X509Certificate).
 java.lang.String getStatementType()
          Retrieves the type of SAML statement being requested.
 boolean isAssertionSignatureRequired()
          Retrieves the indication of whether or not this requester requires a signature on the SAML assertion.
 boolean isOneTimeUse()
          Retrieves the indication of whether or not this requester requires an OneTimeUse assertion.
 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.
 void setAssertionSignatureRequired(boolean option)
          Sets the indication of whether or not this requester requires a signature on the SAML assertion.
 void setAuthenticationMethod(java.lang.String method)
          Retrieves the type of authentication used by the requester; password authentication.
 void setConfirmationMethod(java.lang.String method)
          Sets the confirmation method to be used (e.g. bearer, holder of key or sender vouches)
 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.
 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.
 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.
 void setKeyAliasForRequester(java.lang.String alias)
          Sets the requester's key alias name to be used for the holder of key confirmation.
 void setOneTimeUse(boolean option)
          Sets the indication of whether or not this requester requires an OneTimeUse assertion.
 void setRequesterDNSAddress(java.lang.String dns)
          Sets the DNS address for the SubjectLocality.
 void setRequesterIPAddress(java.lang.String ip)
          Sets the IP address for the SubjectLocality.
 void setSignatureKeyInfoType(java.lang.String type)
          Sets the type of public key used for the signature on the assertion (e.g.; X509Certificate).
 void setStatementType(java.lang.String type)
          Sets the type of SAML statement being requested.
 
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
 

Method Detail

getConfirmationMethod

java.lang.String getConfirmationMethod()
Retrieves the SAML confirmation method used by the requester. Subject confirmation is of three type:

getEncryptionKeyInfoType

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

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

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

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

java.lang.String getStatementType()
Retrieves the type of SAML statement being requested.

Returns:
a string representing the type of statement requested.

getAuthenticationMethod

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

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

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

java.lang.String getRequesterDNSAddress()
Retrieves the DNS address for the requester.

Returns:
a string representing the requester's DNS address.

getRequesterIPAddress

java.lang.String getRequesterIPAddress()
Retrieves the IP address for the requester.

Returns:
a string representing the requester's IP address.

isAssertionSignatureRequired

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

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

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

Parameters:
a - string representing the subject confirmation method to be used.

setEncryptionKeyInfoType

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.

Parameters:
a - string indicating the type of encryption key to be used.

setHolderOfKeyKeyInfoType

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.

Parameters:
a - string indicating the type of of holder of key value.

setSignatureKeyInfoType

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

Parameters:
a - string representing the type of public key used for the signature on the assertion.

setStatementType

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

Parameters:
a - string representing the type of statement requested.

setAuthenticationMethod

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

Parameters:
a - string representing the type of authentication used by the requester.

setKeyAliasForAppliesTo

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.

Parameters:
a - string representing the key alias for the recipient (consumer of the SAML token).

setKeyAliasForRequester

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

Parameters:
a - string representing the key alias for the requester of the SAML token.

setRequesterDNSAddress

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

Parameters:
a - string representing the system's DNS address where requester is authenticated.

setRequesterIPAddress

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

Parameters:
a - string representing the system's IP address where requester is authenticated.

setAssertionSignatureRequired

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

Parameters:
a - boolean for whether the requester requires signed assertions.

setOneTimeUse

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

Parameters:
a - boolean for whether the requester requires requires an OneTimeUse assertion.

IBM WebSphere Application ServerTM
Release 7