Package com.ibm.websphere.security.saml2
Interface Saml20Token
public interface Saml20Token
-
Method Summary
Modifier and TypeMethodDescriptionReturn SAML Assertion namespace, defined in a schema SAML-XSD.Retrieves AudienceRestriction String name list.Retrieves the authentication time when the token holder is authenticated.Retrieves the authentication method that was used to authenticate the token holder.Retrieves the Subject Confirmation Method used in this SAML token.byte[]
Retrieves the key bytes from the Holder-of-Key Element of this SAML token.Retrieves the SAML assertion creation date.Gets customized properties.Retrieves String list of ProxyRestriction Audience.long
Retrieves number of ProxyRestriction Count.Gets the serializable representation of this SAML XML.Return SAML Expiration time.Retrieves the identifier associated with this SAML assertion.Retrieves the name of issuer.Retrieves the issuer name format.Retrieves the name of NameID.Retrieves the format of NameID.Retrieves the id of the SAML Service Provider Such as: the "ibmSP01" in <samlWebSso20 id="ibmSP01" authFilterRef="requestFilter01" ...Retrieves SAML signer's X.509 CertificateRetrieves DNSAddress in SubjectLocality.Retrieves IPAddress in SubjectLocality.boolean
Retrieves flag to indicate ProxyRestriction.boolean
Retrieves flag to indicate OneTimeUse or DoNotCacheCondition.
-
Method Details
-
getSamlID
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
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
Date getSamlExpires()Return SAML Expiration time.- Returns:
- SAML Token expiration time, which is delimited by the NotOnOrAfter attribute in
element.
-
getIssueInstant
Date getIssueInstant()Retrieves the SAML assertion creation date.- Returns:
- SAML Token creation Date based on the IssueInstant attribute in
element.
-
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:
-
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
String getSAMLNameID()Retrieves the name of NameID.- Returns:
- NameID in the SAML assertion.
-
getSAMLNameIDFormat
String getSAMLNameIDFormat()Retrieves the format of NameID.- Returns:
- NameID format in the SAML assertion.
-
getSAMLIssuerName
String getSAMLIssuerName()Retrieves the name of issuer.- Returns:
- issuer name of the SAML authority responsible for the claims in the SAML assertion.
-
getSAMLIssuerNameFormat
String getSAMLIssuerNameFormat()Retrieves the issuer name format.- Returns:
- name format of the SAML authority responsible for the claims in the SAML assertion.
-
getAuthenticationMethod
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
Date getAuthenticationInstant()Retrieves the authentication time when the token holder is authenticated.- Returns:
- the authentication time when the token holder is authenticated.
-
getSubjectDNS
String getSubjectDNS()Retrieves DNSAddress in SubjectLocality.- Returns:
- DNSAddress in SubjectLocality.
-
getSubjectIPAddress
String getSubjectIPAddress()Retrieves IPAddress in SubjectLocality.- Returns:
- IPAddress in SubjectLocality.
-
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
Retrieves String list of ProxyRestriction Audience.- Returns:
- String list of ProxyRestriction Audience.
-
getSignerCertificate
List<X509Certificate> getSignerCertificate()Retrieves SAML signer's X.509 Certificate- Returns:
- SAML signer's X.509 Certificate
-
getSAMLAsString
String getSAMLAsString()Gets the serializable representation of this SAML XML.- Returns:
- the String representation of this SAML
-
getSAMLAttributes
List<Saml20Attribute> getSAMLAttributes() -
getServiceProviderID
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
Gets customized properties.- Returns:
- the Map of properties
-