Skip navigation links

Oracle Fusion Middleware Web Services Security Java API Reference for Oracle Security Developer Tools
11g Release 1 (11.1.1)

E10678-03


oracle.security.xmlsec.wss.saml
Class SAMLAssertionKeyIdentifier

java.lang.Object
  extended by oracle.security.xmlsec.util.XMLNode
      extended by oracle.security.xmlsec.util.XMLElement
          extended by oracle.security.xmlsec.wss.WSSElement
              extended by oracle.security.xmlsec.wss.WSSKeyIdentifier
                  extended by oracle.security.xmlsec.wss.saml.SAMLAssertionKeyIdentifier

All Implemented Interfaces:
WSSecurityTokenReferenceType

public class SAMLAssertionKeyIdentifier
extends WSSKeyIdentifier

This class represents WSSKeyIdentifier for SAML Assertion where AssertionID is used as the key identifier.


Field Summary

 

Fields inherited from class oracle.security.xmlsec.wss.WSSKeyIdentifier
vt_ThumbprintSHA1

 

Fields inherited from class oracle.security.xmlsec.util.XMLNode
node, systemId

 

Constructor Summary
SAMLAssertionKeyIdentifier(org.w3c.dom.Document owner)
          Create a new SAMLAssertionKeyIdentifier instance.
SAMLAssertionKeyIdentifier(org.w3c.dom.Document owner, byte[] assertionId)
          Create a new SAMLAssertionKeyIdentifier instance.
SAMLAssertionKeyIdentifier(org.w3c.dom.Document owner, byte[] assertionId, java.lang.String valueType)
          Create a new SAMLAssertionKeyIdentifier instance.
SAMLAssertionKeyIdentifier(org.w3c.dom.Document owner, java.lang.String valueType)
          Create a new SAMLAssertionKeyIdentifier instance.
SAMLAssertionKeyIdentifier(org.w3c.dom.Document owner, java.lang.String assertionId, java.lang.String valueType)
          Create a new SAMLAssertionKeyIdentifier instance.
SAMLAssertionKeyIdentifier(org.w3c.dom.Element element)
          Create a new SAMLAssertionKeyIdentifier instance from the given XML element.
SAMLAssertionKeyIdentifier(org.w3c.dom.Element element, java.lang.String systemId)
          Create a new SAMLAssertionKeyIdentifier instance from the given XML element.

 

Method Summary
static void addResolver(SAMLAssertionKeyIdentifierResolver resolver)
          Register the SAMLAssertionKeyIdentifierResolver instance for use in keyidentifier resolver operations.
 oracle.security.xmlsec.saml.AuthorityBinding getAuthorityBinding()
          Get the associated SAML AuthorityBinding.
protected  java.lang.String getDefaultEncodingType()
          Return the default encoding type of key identifier.
 java.lang.Object getKey()
          Returns the key (symmetric or asymmetric) corresponding to the underlying WSS SecurityToken.
 java.security.PrivateKey getPrivateKey()
          Get the underlying WSSecurity Token.
 java.security.cert.X509Certificate getPublicKey()
          Get the underlying WSSecurity Token.
static java.util.List getResolvers()
          Get the list of registered SAMLAssertionKeyIdentifierResolvers.
 WSSecurityToken getSecurityToken()
          Get the underlying WSSecurity Token.
 void setAuthorityBinding(oracle.security.xmlsec.saml.AuthorityBinding authorityBinding)
          Set the associated SAML AuthorityBinding.

 

Methods inherited from class oracle.security.xmlsec.wss.WSSKeyIdentifier
addResolver, getEncodingType, getName, getThumbprint, getValue, getValueType, setEncodingType, setValue, setValueType

 

Methods inherited from class oracle.security.xmlsec.wss.WSSElement
getId, getWsuId, setId, setWsuId

 

Methods inherited from class oracle.security.xmlsec.util.XMLElement
addNSPrefixAttr, addNSPrefixAttr, addNSPrefixAttrDefault, addNSPrefixAttrDefault, getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getChildElementsByTagName, getChildElementsByTagName, getChildElementsByTagNameNS, getChildElementsByTagNameNS, getDefaultNSPrefix, getElement, getElementsByTagName, getElementsByTagNameNS, getTagName, hasAttribute, hasAttributeNS, removeAttribute, removeAttributeNode, removeAttributeNS, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setDefaultNSPrefix

 

Methods inherited from class oracle.security.xmlsec.util.XMLNode
appendChild, appendChild, appendTo, cloneNode, getAttributes, getChildNodes, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNode, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getSystemId, hasAttributes, hasChildNodes, insertBefore, insertBefore, isSupported, normalize, removeChild, removeChild, replaceChild, replaceChild, setNodeValue, setPrefix, setSystemId, toBytesXML, toStringXML

 

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Methods inherited from interface oracle.security.xmlsec.wss.WSSecurityTokenReferenceType
getNode

 

Constructor Detail

SAMLAssertionKeyIdentifier

public SAMLAssertionKeyIdentifier(org.w3c.dom.Element element)
Create a new SAMLAssertionKeyIdentifier instance from the given XML element.
Parameters:
element - A wsse:KeyIdentifier element.

SAMLAssertionKeyIdentifier

public SAMLAssertionKeyIdentifier(org.w3c.dom.Element element,
                                  java.lang.String systemId)
Create a new SAMLAssertionKeyIdentifier instance from the given XML element.
Parameters:
element - A wsse:KeyIdentifier element.
systemId - The URI string system ID for this element.

SAMLAssertionKeyIdentifier

public SAMLAssertionKeyIdentifier(org.w3c.dom.Document owner)
Create a new SAMLAssertionKeyIdentifier instance.
Parameters:
owner - A XML Document to be used as the owner document of this structure.

SAMLAssertionKeyIdentifier

public SAMLAssertionKeyIdentifier(org.w3c.dom.Document owner,
                                  byte[] assertionId)
Create a new SAMLAssertionKeyIdentifier instance.
Parameters:
owner - A XML Document to be used as the owner document of this structure.
assertionId - The assertion identifier.

SAMLAssertionKeyIdentifier

public SAMLAssertionKeyIdentifier(org.w3c.dom.Document owner,
                                  java.lang.String valueType)
Create a new SAMLAssertionKeyIdentifier instance.
Parameters:
owner - A XML Document to be used as the owner document of this structure.
valueType - The key identifier data value type.

SAMLAssertionKeyIdentifier

public SAMLAssertionKeyIdentifier(org.w3c.dom.Document owner,
                                  byte[] assertionId,
                                  java.lang.String valueType)
Create a new SAMLAssertionKeyIdentifier instance.
Parameters:
owner - A XML Document to be used as the owner document of this structure.
assertionId - The assertion identifier.
valueType - The identifier data value type.

SAMLAssertionKeyIdentifier

public SAMLAssertionKeyIdentifier(org.w3c.dom.Document owner,
                                  java.lang.String assertionId,
                                  java.lang.String valueType)
Create a new SAMLAssertionKeyIdentifier instance.
Parameters:
owner - A XML Document to be used as the owner document of this structure.
assertionId - The assertion identifier.
valueType - The optional identifier data value type.

Method Detail

addResolver

public static void addResolver(SAMLAssertionKeyIdentifierResolver resolver)
Register the SAMLAssertionKeyIdentifierResolver instance for use in keyidentifier resolver operations.
Parameters:
resolver - The SAML assertion key identifier resolver.

getResolvers

public static java.util.List getResolvers()
Get the list of registered SAMLAssertionKeyIdentifierResolvers.
Returns:
The List of SAML assertion key identifier resolvers.

setAuthorityBinding

public void setAuthorityBinding(oracle.security.xmlsec.saml.AuthorityBinding authorityBinding)
Set the associated SAML AuthorityBinding.

This is required for V1.1 SAML Assertion Tokens.

Parameters:
authorityBinding - The associated saml:AuthorityBinding.

getAuthorityBinding

public oracle.security.xmlsec.saml.AuthorityBinding getAuthorityBinding()
Get the associated SAML AuthorityBinding.
Returns:
The associated saml:AuthorityBinding.

getSecurityToken

public WSSecurityToken getSecurityToken()
                                 throws WSSException
Get the underlying WSSecurity Token.
Specified by:
getSecurityToken in interface WSSecurityTokenReferenceType
Overrides:
getSecurityToken in class WSSKeyIdentifier
Returns:
The referenced saml:Assertion.
Throws:
WSSException

getPublicKey

public java.security.cert.X509Certificate getPublicKey()
                                                throws WSSException
Get the underlying WSSecurity Token.
Returns:
The referenced saml:Assertion.
Throws:
WSSException

getPrivateKey

public java.security.PrivateKey getPrivateKey()
                                       throws WSSException
Get the underlying WSSecurity Token.
Returns:
The referenced saml:Assertion.
Throws:
WSSException

getKey

public java.lang.Object getKey()
                        throws WSSException
Returns the key (symmetric or asymmetric) corresponding to the underlying WSS SecurityToken.

**** NOT IMPLEMENTED ****

Specified by:
getKey in interface WSSecurityTokenReferenceType
Overrides:
getKey in class WSSKeyIdentifier
Returns:
The Key.
Throws:
WSSException

getDefaultEncodingType

protected java.lang.String getDefaultEncodingType()
Return the default encoding type of key identifier.

This is necessary to handle messages that do not contain the EncodingType attribute.

Overrides:
getDefaultEncodingType in class WSSKeyIdentifier
Returns:
The key identifier's default encoding typ i.e Base-64..

Skip navigation links

Oracle Fusion Middleware Web Services Security Java API Reference for Oracle Security Developer Tools
11g Release 1 (11.1.1)

E10678-03


Copyright © 2005, 2011 , Oracle. All rights reserved.