|
IBM WebSphere Application ServerTM Release 8 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface RequesterConfig
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 useSAMLTokenFactory
to get an instance of RequesterConfig.
Nested Class Summary | |
---|---|
static class |
RequesterConfig.requestMode
|
Nested classes/interfaces inherited from interface com.ibm.wsspi.wssecurity.core.token.config.RequesterConfiguration |
---|
RequesterConfiguration.RSTT, RequesterConfiguration.RSTT13 |
Field Summary | |
---|---|
static long |
DEFAULT_CLOCKSKEW
|
Method Summary | |
---|---|
boolean |
enableNotBefore()
|
java.lang.String |
getAddress()
|
java.lang.String |
getAuthenticatingAuthority()
|
java.lang.String |
getAuthenticationMethod()
Retrieves the type of authentication used by the requester; password authentication. |
java.lang.String |
getAuthnContextDecl()
|
java.lang.String |
getAuthnContextDeclRef()
|
long |
getClockSkew()
Return the allowable clock skew. |
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 |
getInResponseTo()
|
RequesterConfig.requestMode |
getIssueMode()
|
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. |
long |
getNotOnOrAfter()
|
java.lang.String |
getRecipient()
|
java.lang.String |
getRequesterDNSAddress()
Retrieves the DNS address for the requester. |
java.lang.String |
getRequesterIPAddress()
Retrieves the IP address for the requester. |
long |
getSessionNotOnOrAfter()
|
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 |
includeCredentialToken()
|
boolean |
includeExpiration()
|
boolean |
includeGroupIds()
|
boolean |
includeHostName()
|
boolean |
includeOID()
|
boolean |
includePrimaryGroupId()
|
boolean |
includeRealmName()
|
boolean |
includeSecurityName()
|
boolean |
includeUniqueSecurityName()
|
boolean |
isAssertionSignatureRequired()
Retrieves the indication of whether or not this requester requires a signature on the SAML assertion. |
boolean |
isEncryptSAML()
|
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 |
setAddress(java.lang.String url)
|
void |
setAssertionSignatureRequired(boolean option)
Sets the indication of whether or not this requester requires a signature on the SAML assertion. |
void |
setAuthenticatingAuthority(java.lang.String url)
|
void |
setAuthenticationMethod(java.lang.String method)
Sets the type of authentication used by the requester; password authentication. |
void |
setAuthnContextDecl(java.lang.String url)
|
void |
setAuthnContextDeclRef(java.lang.String url)
|
void |
setClockSkew(long time)
Set clock skew |
void |
setConfirmationMethod(java.lang.String method)
Sets the confirmation method to be used (e.g. bearer, holder of key or sender vouches) |
void |
setEnableNotBefore(boolean notBefore)
|
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 |
setEncryptSAML(boolean enc)
|
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 |
setIncludeCredentialToken(boolean flag)
Sets boolean flag to assert CredentialToken from WSCredential as an SAML attribute. |
void |
setIncludeExpiration(boolean flag)
Sets boolean flag to assert Expiration from WSCredential as an SAML attribute. |
void |
setIncludeGroupIds(boolean flag)
Sets boolean flag to assert GroupIds from WSCredential as an SAML attribute. |
void |
setIncludeHostName(boolean flag)
Sets boolean flag to assert HostName from WSCredential as an SAML attribute. |
void |
setIncludeOID(boolean flag)
Sets boolean flag to assert OID from WSCredential as an SAML attribute. |
void |
setIncludePrimaryGroupId(boolean flag)
Sets boolean flag to assert PrimaryGroupId from WSCredential as an SAML attribute. |
void |
setIncludeRealmName(boolean flag)
Sets boolean flag to assert realm from WSCredential as an SAML attribute. |
void |
setIncludeSecurityName(boolean flag)
Sets boolean flag to assert SecurityName from WSCredential as an SAML attribute. |
void |
setIncludeUniqueSecurityName(boolean flag)
Sets boolean flag to assert UniqueSecurityName from WSCredential as an SAML attribute. |
void |
setInResponseTo(java.lang.String url)
|
void |
setIssueMode(RequesterConfig.requestMode mode)
|
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 |
setNotOnOrAfter(long minutes)
|
void |
setOneTimeUse(boolean option)
Sets the indication of whether or not this requester requires an OneTimeUse assertion. |
void |
setRecipient(java.lang.String url)
|
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 |
setSessionNotOnOrAfter(long minutes)
|
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. |
void |
setUseSha2ForSignature(boolean flag)
Set the flag. |
void |
setUseUniqueSecurityName(boolean flag)
Sets boolean flag to use UniqueSecurityName from WSCredential as NameID or NameIdentifier. |
boolean |
useSha2ForSignature()
Return the flag. |
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 |
---|
static final long DEFAULT_CLOCKSKEW
Method Detail |
---|
java.lang.String getConfirmationMethod()
java.lang.String getEncryptionKeyInfoType()
java.lang.String getHolderOfKeyKeyInfoType()
boolean isSessionIndexEnabled()
java.lang.String getSignatureKeyInfoType()
java.lang.String getStatementType()
java.lang.String getAuthenticationMethod()
java.lang.String getKeyAliasForAppliesTo()
java.lang.String getKeyAliasForRequester()
java.lang.String getRequesterDNSAddress()
java.lang.String getRequesterIPAddress()
boolean isAssertionSignatureRequired()
boolean isOneTimeUse()
void setConfirmationMethod(java.lang.String method)
a
- string representing the subject confirmation method to be used.void setEncryptionKeyInfoType(java.lang.String type)
a
- string indicating the type of encryption key to be used.void setHolderOfKeyKeyInfoType(java.lang.String type)
a
- string indicating the type of of holder of key value.void setSignatureKeyInfoType(java.lang.String type)
a
- string representing the type of public key used for the signature on the assertion.void setStatementType(java.lang.String type)
a
- string representing the type of statement requested.void setAuthenticationMethod(java.lang.String method)
a
- string representing the type of authentication used by the requester.void setKeyAliasForAppliesTo(java.lang.String type)
a
- string representing the key alias for the recipient (consumer of the SAML token).void setKeyAliasForRequester(java.lang.String alias)
a
- string representing the key alias for the requester of the SAML token.void setRequesterDNSAddress(java.lang.String dns)
a
- string representing the system's DNS address where requester is authenticated.void setRequesterIPAddress(java.lang.String ip)
a
- string representing the system's IP address where requester is authenticated.void setAssertionSignatureRequired(boolean option)
a
- boolean for whether the requester requires signed assertions.void setOneTimeUse(boolean option)
a
- boolean for whether the requester requires requires an OneTimeUse assertion.long getClockSkew()
void setClockSkew(long time)
clock
- skew in millisecondsboolean includeRealmName()
void setIncludeRealmName(boolean flag)
boolean
- flag to assert realm from WSCredential as an SAML attribute.boolean includeSecurityName()
void setIncludeSecurityName(boolean flag)
boolean
- flag to assert SecurityName from WSCredential as an SAML attribute.boolean includeUniqueSecurityName()
void setIncludeUniqueSecurityName(boolean flag)
boolean
- flag to assert UniqueSecurityName from WSCredential as an SAML attribute.boolean includeCredentialToken()
void setIncludeCredentialToken(boolean flag)
boolean
- flag to assert CredentialToken from WSCredential as an SAML attribute.boolean includeOID()
void setIncludeOID(boolean flag)
boolean
- flag to assert OID from WSCredential as an SAML attribute.boolean includeExpiration()
void setIncludeExpiration(boolean flag)
boolean
- flag to assert Expiration from WSCredential as an SAML attribute.boolean includePrimaryGroupId()
void setIncludePrimaryGroupId(boolean flag)
boolean
- flag to assert PrimaryGroupId from WSCredential as an SAML attribute.boolean includeGroupIds()
void setIncludeGroupIds(boolean flag)
boolean
- flag to assert GroupIds from WSCredential as an SAML attribute.boolean includeHostName()
void setIncludeHostName(boolean flag)
boolean
- flag to assert HostName from WSCredential as an SAML attribute.boolean useUniqueSecurityName()
void setUseUniqueSecurityName(boolean flag)
boolean
- flag to use UniqueSecurityName from WSCredential as NameID or NameIdentifier.RequesterConfig.requestMode getIssueMode()
void setIssueMode(RequesterConfig.requestMode mode)
boolean useSha2ForSignature()
void setUseSha2ForSignature(boolean flag)
the
- flag to use Sha2 for signaturevoid setInResponseTo(java.lang.String url)
java.lang.String getInResponseTo()
void setRecipient(java.lang.String url)
java.lang.String getRecipient()
void setAddress(java.lang.String url)
java.lang.String getAddress()
void setEnableNotBefore(boolean notBefore)
boolean enableNotBefore()
void setNotOnOrAfter(long minutes)
long getNotOnOrAfter()
void setAuthnContextDeclRef(java.lang.String url)
java.lang.String getAuthnContextDeclRef()
void setAuthnContextDecl(java.lang.String url)
java.lang.String getAuthnContextDecl()
void setAuthenticatingAuthority(java.lang.String url)
java.lang.String getAuthenticatingAuthority()
void setSessionNotOnOrAfter(long minutes)
long getSessionNotOnOrAfter()
void setEncryptSAML(boolean enc)
boolean isEncryptSAML()
|
IBM WebSphere Application ServerTM Release 8 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |