Skip navigation links

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

E10676-03


oracle.security.xmlsec.saml2.core
Class EncryptedID

java.lang.Object
  extended by oracle.security.xmlsec.util.XMLNode
      extended by oracle.security.xmlsec.util.XMLElement
          extended by oracle.security.xmlsec.saml2.core.EncryptedElement
              extended by oracle.security.xmlsec.saml2.core.EncryptedID

All Implemented Interfaces:
SAML2EncryptedType, SAML2NameIdentifier

public class EncryptedID
extends EncryptedElement
implements SAML2NameIdentifier

Represents an encrypted name identifier.


Field Summary

 

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

 

Constructor Summary
EncryptedID(org.w3c.dom.Document owner)
          Creates a new EncryptedID instance.
EncryptedID(org.w3c.dom.Element element)
          Creates a new EncryptedID instance from the given Element node.
EncryptedID(org.w3c.dom.Element element, java.lang.String systemId)
          Creates a new EncryptedID instance from the given Element node.

 

Method Summary
 oracle.security.xmlsec.enc.XEEncryptedData encryptNameID(NameID nameID, java.lang.String dataEncAlg, javax.crypto.SecretKey dataEncKey, java.lang.String dataEncKeyName)
          Encrypt the NameID with the given algorithm and content encryption key, where the key is identified by a key name.
 oracle.security.xmlsec.enc.XEEncryptedData encryptNameID(NameID nameID, java.lang.String dataEncAlg, javax.crypto.SecretKey dataEncKey, java.lang.String keyEncAlg, java.security.Key keyEncKey, java.lang.String keyEncKeyName)
          Encrypt NameID with the given algorithm and key, where the data encryption key is encrypted with the given key encryption key.
 java.lang.String getIDName()
          Returns the tag name of the identifier.
 java.lang.String getIDNamespaceURI()
          Returns the namespace URI of the identifier element.

 

Methods inherited from class oracle.security.xmlsec.saml2.core.EncryptedElement
addEncryptedKey, decryptElement, encryptElement, encryptElement, getEncryptedData, getEncryptedKeys, removeChildren, setEncryptedData

 

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.saml2.core.SAML2NameIdentifier
getNode

 

Constructor Detail

EncryptedID

public EncryptedID(org.w3c.dom.Element element)
            throws org.w3c.dom.DOMException
Creates a new EncryptedID instance from the given Element node.
Parameters:
element - A EncryptedID element.
Throws:
org.w3c.dom.DOMException

EncryptedID

public EncryptedID(org.w3c.dom.Element element,
                   java.lang.String systemId)
            throws org.w3c.dom.DOMException
Creates a new EncryptedID instance from the given Element node.
Parameters:
element - A EncryptedID element.
systemId - The URI string system ID for the EncryptedID.
Throws:
org.w3c.dom.DOMException

EncryptedID

public EncryptedID(org.w3c.dom.Document owner)
            throws org.w3c.dom.DOMException
Creates a new EncryptedID instance.
Parameters:
owner - The owner document of the new EncryptedID.
Throws:
org.w3c.dom.DOMException

Method Detail

encryptNameID

public oracle.security.xmlsec.enc.XEEncryptedData encryptNameID(NameID nameID,
                                                                java.lang.String dataEncAlg,
                                                                javax.crypto.SecretKey dataEncKey,
                                                                java.lang.String dataEncKeyName)
                                                         throws oracle.security.xmlsec.enc.XEException
Encrypt the NameID with the given algorithm and content encryption key, where the key is identified by a key name.

The supported data encrytion algorithms are:

Parameters:
nameID - The identifier to encrypt.
dataEncAlg - The URI identifying the data encryption algorithm.
dataEncKey - The data encryption key. If null, a encryption key will be randomly generated.
dataEncKeyName - The name identifying the data encryption key, optional.
Returns:
A new XEEncryptedData which replaces the nameID element.
Throws:
oracle.security.xmlsec.enc.XEException - If an error occurs in encrypting the data.

encryptNameID

public oracle.security.xmlsec.enc.XEEncryptedData encryptNameID(NameID nameID,
                                                                java.lang.String dataEncAlg,
                                                                javax.crypto.SecretKey dataEncKey,
                                                                java.lang.String keyEncAlg,
                                                                java.security.Key keyEncKey,
                                                                java.lang.String keyEncKeyName)
                                                         throws oracle.security.xmlsec.enc.XEException
Encrypt NameID with the given algorithm and key, where the data encryption key is encrypted with the given key encryption key.

The supported data encrytion algorithms are:

The supported key encrytion algorithms are:

For RSA-OAEP, the following parameters are used:

Parameters:
nameID - The identifier to encrypt.
dataEncAlg - The URI identifying the data encryption algorithm.
dataEncKey - The data encryption key. If null, a encryption key will be randomly generated.
keyEncAlg - The URI identifying the key encryption algorithm.
keyEncKey - The key encryption key.
keyEncKeyName - The name identifying the key encryption key, optional.
Returns:
A new XEEncryptedData which replaces the nameID element.
Throws:
oracle.security.xmlsec.enc.XEException - If an error occurs in encrypting the data.

getIDNamespaceURI

public java.lang.String getIDNamespaceURI()
Returns the namespace URI of the identifier element.
Specified by:
getIDNamespaceURI in interface SAML2NameIdentifier
Returns:
A URI reference.

getIDName

public java.lang.String getIDName()
Returns the tag name of the identifier.
Specified by:
getIDName in interface SAML2NameIdentifier
Returns:
A String value.

Skip navigation links

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

E10676-03


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