|
IBM WebSphere Application ServerTM Release 7 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface SAMLToken
This API is used to retrieve data elements from an existing
SAML token assertion. Items such token creation time, expiration time, the subject
confirmation method, attributes, etc.
SAMLToken represents a SAML security token as defined by OASIS
Web Services Security:SAML Token Profile 1.1.
WSSTrustClient class and WSSTrustClientValidateResult class could return tokens that implement this interface.
SecurityToken
,
GenericSecurityToken
Field Summary | |
---|---|
static java.security.SecurityPermission |
GET_SAMLATTRIBUTES_PERM
this is the java2 security permission needed to retrieve attributes from a SAML token. |
Fields inherited from interface com.ibm.websphere.wssecurity.wssapi.token.SecurityToken |
---|
DECRYPTING_KEY, ENCRYPTING_KEY, REF_EMBEDDED, REF_KEYID, REF_STR, REF_THUMBPRINT, SIGNING_KEY, TokenQname, ValueType, VERIFING_KEY |
Method Summary | |
---|---|
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.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. |
long |
getProxyRestrictionCount()
Retrieves number of ProxyRestriction Count. |
java.util.List<java.lang.String> |
getroxyRestrictionAudience()
Retrieves String list of ProxyRestriction Audience. |
java.util.List<com.ibm.wsspi.wssecurity.saml.data.SAMLAttribute> |
getSAMLAttributes()
Retrieves the list of all attributes contained in the SAML token. |
java.util.Date |
getSamlCreated()
Retrieves the SAML assertion creation date. |
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. |
com.ibm.wsspi.wssecurity.saml.data.SAMLNameID |
getSAMLNameID()
Retrieves SAML NameId or NameIdentifier assertion associated with the token holder. |
java.security.cert.X509Certificate |
getSignerCertificate()
Retrieves SAML signer's X.509 Certificate |
java.util.Map<java.lang.String,java.lang.String> |
getStringAttributes()
Retrieves a Map of SAML attributes that consist of single (key, string value) pairs only. |
java.lang.String |
getSubjectDNS()
Retrieves DNSAddress in SubjectLocality. |
java.lang.String |
getSubjectIPAddress()
Retrieves IPAddress in SubjectLocality. |
java.io.InputStream |
getXMLInputStream()
Retrieves InputSream form of SAML Assertion. |
boolean |
hasProxyRestriction()
Retrieves flag to indicate ProxyRestriction. |
boolean |
isOneTimeUse()
Retrieves flag to indicate OneTimeUse or DoNotCacheCondition. |
boolean |
isReadOnly()
Retrieves readOnly flag. |
void |
setTokenReadOnly()
sets the SAMLToken to read only mode, meaning when we get any kind of SAMLAtributes, we return only copies instead of direct references. |
Methods inherited from interface com.ibm.websphere.wssecurity.wssapi.token.GenericSecurityToken |
---|
getProperties, setValueType |
Methods inherited from interface com.ibm.websphere.wssecurity.wssapi.token.SecurityToken |
---|
getId, getKey, getKeyIdentifier, getKeyIdentifierEncodingType, getKeyIdentifierValueType, getKeyName, getPrincipal, getReferenceURI, getThumbprint, getThumbprintEncodingType, getThumbprintValueType, getTokenQname, getValueType, getXML |
Field Detail |
---|
static final java.security.SecurityPermission GET_SAMLATTRIBUTES_PERM
Method Detail |
---|
java.lang.String getSamlID()
javax.xml.namespace.QName getAssertionQName()
java.util.Date getSamlExpires()
java.util.Date getSamlCreated()
java.lang.String getConfirmationMethod()
byte[] getHolderOfKeyBytes()
java.lang.String getSAMLIssuerName()
java.lang.String getAuthenticationMethod()
java.util.Date getAuthenticationInstant()
java.lang.String getSubjectDNS()
java.lang.String getSubjectIPAddress()
java.util.List<java.lang.String> getAudienceRestriction()
boolean isOneTimeUse()
boolean hasProxyRestriction()
long getProxyRestrictionCount()
java.util.List<java.lang.String> getroxyRestrictionAudience()
java.util.List<com.ibm.wsspi.wssecurity.saml.data.SAMLAttribute> getSAMLAttributes()
java.util.Map<java.lang.String,java.lang.String> getStringAttributes()
com.ibm.wsspi.wssecurity.saml.data.SAMLNameID getSAMLNameID()
void setTokenReadOnly()
boolean isReadOnly()
java.io.InputStream getXMLInputStream() throws WSSException
WSSException
java.security.cert.X509Certificate getSignerCertificate()
|
IBM WebSphere Application ServerTM Release 7 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |