Package com.ibm.websphere.security.saml2
Interface Saml20Token
-
public interface Saml20Token
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description javax.xml.namespace.QName
getAssertionQName()
Return SAML Assertion namespace, defined in a schema SAML-XSD.java.util.List<java.lang.String>
getAudienceRestriction()
Retrieves AudienceRestriction String name list.java.util.Date
getAuthenticationInstant()
Retrieves the authentication time when the token holder is authenticated.java.lang.String
getAuthenticationMethod()
Retrieves the authentication method that was used to authenticate the token holder.java.util.List<java.lang.String>
getConfirmationMethod()
Retrieves the Subject Confirmation Method used in this SAML token.byte[]
getHolderOfKeyBytes()
Retrieves the key bytes from the Holder-of-Key Element of this SAML token.java.util.Date
getIssueInstant()
Retrieves the SAML assertion creation date.java.util.Map<java.lang.String,java.lang.Object>
getProperties()
Gets customized properties.java.util.List<java.lang.String>
getProxyRestrictionAudience()
Retrieves String list of ProxyRestriction Audience.long
getProxyRestrictionCount()
Retrieves number of ProxyRestriction Count.java.lang.String
getSAMLAsString()
Gets the serializable representation of this SAML XML.java.util.List<Saml20Attribute>
getSAMLAttributes()
java.util.Date
getSamlExpires()
Return SAML Expiration time.java.lang.String
getSamlID()
Retrieves the identifier associated with this SAML assertion.java.lang.String
getSAMLIssuerName()
Retrieves the name of issuer.java.lang.String
getSAMLIssuerNameFormat()
Retrieves the issuer name format.java.lang.String
getSAMLNameID()
Retrieves the name of NameID.java.lang.String
getSAMLNameIDFormat()
Retrieves the format of NameID.java.lang.String
getServiceProviderID()
Retrieves the id of the SAML Service Provider Such as: the "ibmSP01" in <samlWebSso20 id="ibmSP01" authFilterRef="requestFilter01" ...java.util.List<java.security.cert.X509Certificate>
getSignerCertificate()
Retrieves SAML signer's X.509 Certificatejava.lang.String
getSubjectDNS()
Retrieves DNSAddress in SubjectLocality.java.lang.String
getSubjectIPAddress()
Retrieves IPAddress in SubjectLocality.boolean
hasProxyRestriction()
Retrieves flag to indicate ProxyRestriction.boolean
isOneTimeUse()
Retrieves flag to indicate OneTimeUse or DoNotCacheCondition.
-
-
-
Method Detail
-
getSamlID
java.lang.String getSamlID()
Retrieves the identifier associated with this SAML assertion.- Returns:
- a string representing the ID for SAML 2.0, or AssertionID for SAML 1.1.
-
getAssertionQName
javax.xml.namespace.QName getAssertionQName()
Return SAML Assertion namespace, defined in a schema SAML-XSD.- Returns:
- SAML Assertion namespace, defined in a schema SAML-XSD It is "urn:oasis:names:tc:SAML:1.0:assertion" for SAML 1.1, and "urn:oasis:names:tc:SAML:2.0:assertion" for SAML 2.0.
-
getSamlExpires
java.util.Date getSamlExpires()
Return SAML Expiration time.- Returns:
- SAML Token expiration time, which is delimited by the NotOnOrAfter attribute in
element.
-
getIssueInstant
java.util.Date getIssueInstant()
Retrieves the SAML assertion creation date.- Returns:
- SAML Token creation Date based on the IssueInstant attribute in
element.
-
getConfirmationMethod
java.util.List<java.lang.String> getConfirmationMethod()
Retrieves the Subject Confirmation Method used in this SAML token. based on the SAML token profile for versions 1.1 and 2.0.- Returns:
- List of SAML SubjectConfirmation Method, and valid method is holder-of-key, bearer, or sender-vouches.
- See Also:
- OASIS SAML Token Profile 1.1, OASIS SAML Token Profile 2.0
-
getHolderOfKeyBytes
byte[] getHolderOfKeyBytes()
Retrieves the key bytes from the Holder-of-Key Element of this SAML token.- Returns:
- the shared secret key bytes for a symmetric holder-of-key assertion.
-
getSAMLNameID
java.lang.String getSAMLNameID()
Retrieves the name of NameID.- Returns:
- NameID in the SAML assertion.
-
getSAMLNameIDFormat
java.lang.String getSAMLNameIDFormat()
Retrieves the format of NameID.- Returns:
- NameID format in the SAML assertion.
-
getSAMLIssuerName
java.lang.String getSAMLIssuerName()
Retrieves the name of issuer.- Returns:
- issuer name of the SAML authority responsible for the claims in the SAML assertion.
-
getSAMLIssuerNameFormat
java.lang.String getSAMLIssuerNameFormat()
Retrieves the issuer name format.- Returns:
- name format of the SAML authority responsible for the claims in the SAML assertion.
-
getAuthenticationMethod
java.lang.String getAuthenticationMethod()
Retrieves the authentication method that was used to authenticate the token holder.- Returns:
- the authentication method that took place prior to the token's creation. For example "password", "kerberos", "ltpa".
-
getAuthenticationInstant
java.util.Date getAuthenticationInstant()
Retrieves the authentication time when the token holder is authenticated.- Returns:
- the authentication time when the token holder is authenticated.
-
getSubjectDNS
java.lang.String getSubjectDNS()
Retrieves DNSAddress in SubjectLocality.- Returns:
- DNSAddress in SubjectLocality.
-
getSubjectIPAddress
java.lang.String getSubjectIPAddress()
Retrieves IPAddress in SubjectLocality.- Returns:
- IPAddress in SubjectLocality.
-
getAudienceRestriction
java.util.List<java.lang.String> getAudienceRestriction()
Retrieves AudienceRestriction String name list.- Returns:
- AudienceRestriction String name list.
-
isOneTimeUse
boolean isOneTimeUse()
Retrieves flag to indicate OneTimeUse or DoNotCacheCondition.- Returns:
- flag to indicate OneTimeUse or DoNotCacheCondition.
-
hasProxyRestriction
boolean hasProxyRestriction()
Retrieves flag to indicate ProxyRestriction.- Returns:
- flag to indicate ProxyRestriction.
-
getProxyRestrictionCount
long getProxyRestrictionCount()
Retrieves number of ProxyRestriction Count.- Returns:
- number of ProxyRestriction Count.
-
getProxyRestrictionAudience
java.util.List<java.lang.String> getProxyRestrictionAudience()
Retrieves String list of ProxyRestriction Audience.- Returns:
- String list of ProxyRestriction Audience.
-
getSignerCertificate
java.util.List<java.security.cert.X509Certificate> getSignerCertificate()
Retrieves SAML signer's X.509 Certificate- Returns:
- SAML signer's X.509 Certificate
-
getSAMLAsString
java.lang.String getSAMLAsString()
Gets the serializable representation of this SAML XML.- Returns:
- the String representation of this SAML
-
getSAMLAttributes
java.util.List<Saml20Attribute> getSAMLAttributes()
-
getServiceProviderID
java.lang.String getServiceProviderID()
Retrieves the id of the SAML Service Provider Such as: the "ibmSP01" in <samlWebSso20 id="ibmSP01" authFilterRef="requestFilter01" ... \>- Returns:
- the ID of the SAML Service Provider
-
getProperties
java.util.Map<java.lang.String,java.lang.Object> getProperties()
Gets customized properties.- Returns:
- the Map of properties
-
-