oracle.security.xmlsec.saml2.metadata

Class KeyDescriptor

java.lang.Object

oracle.security.xmlsec.util.XMLNode

oracle.security.xmlsec.util.XMLElement

oracle.security.xmlsec.saml2.metadata.KeyDescriptor

public class KeyDescriptor
extends oracle.security.xmlsec.util.XMLElement

Represents the KeyDescriptor metadata element.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	KeyDescriptor.KeyType Represents the key usage.

Field Summary

Fields inherited from class oracle.security.xmlsec.util.XMLNode

node, systemId

Constructor Summary

Constructors

Modifier	Constructor and Description
	KeyDescriptor(org.w3c.dom.Document owner) Creates a new KeyDescriptor instance.
protected	KeyDescriptor(org.w3c.dom.Document owner, java.lang.String nsURI, java.lang.String localName) Creates a new KeyDescriptor instance.
	KeyDescriptor(org.w3c.dom.Element element) Creates a new KeyDescriptor instance from the given Element node.
	KeyDescriptor(org.w3c.dom.Element element, java.lang.String systemId) Creates a new KeyDescriptor instance from the given Element node.

Method Summary

Methods

Modifier and Type	Method and Description
void	addEncryptionMethod(EncryptionMethod encMethod) Adds an encryption method.
java.util.List	getEncryptionMethods() Returns the list of encryption methods.
oracle.security.xmlsec.dsig.XSKeyInfo	getKeyInfo() Returns the key information.
KeyDescriptor.KeyType	getUse() Returns the key usage.
void	setKeyInfo(oracle.security.xmlsec.dsig.XSKeyInfo ki) Adds key information.
void	setUse(KeyDescriptor.KeyType use) Sets the key usage.

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

Constructor Detail

KeyDescriptor

public KeyDescriptor(org.w3c.dom.Element element)
              throws org.w3c.dom.DOMException

Creates a new KeyDescriptor instance from the given Element node.

Parameters:

element - An KeyDescriptor element.

Throws:

org.w3c.dom.DOMException

KeyDescriptor

public KeyDescriptor(org.w3c.dom.Element element,
             java.lang.String systemId)
              throws org.w3c.dom.DOMException

Creates a new KeyDescriptor instance from the given Element node.

Parameters:

element - An KeyDescriptor element.

systemId - The URI string system ID for the KeyDescriptor.

Throws:

org.w3c.dom.DOMException

KeyDescriptor

public KeyDescriptor(org.w3c.dom.Document owner)
              throws org.w3c.dom.DOMException

Creates a new KeyDescriptor instance.

Parameters:

owner - The owner document of the new KeyDescriptor.

Throws:

org.w3c.dom.DOMException

KeyDescriptor

protected KeyDescriptor(org.w3c.dom.Document owner,
             java.lang.String nsURI,
             java.lang.String localName)
                 throws org.w3c.dom.DOMException

Creates a new KeyDescriptor instance. This constructor is for use in subclass for extension of the KeyDescriptor element.

Parameters:

owner - The owner document of the new KeyDescriptor.

nsURI - The namespace URI in which the new KeyDescriptor is to be created.

localName - The localName of the element represented by the class that extends this class.

Throws:

org.w3c.dom.DOMException

Method Detail

setUse

public void setUse(KeyDescriptor.KeyType use)

Sets the key usage.

Parameters:

use - A String.

getUse

public KeyDescriptor.KeyType getUse()

Returns the key usage.

Returns:

The usage String or null if not found.

setKeyInfo

public void setKeyInfo(oracle.security.xmlsec.dsig.XSKeyInfo ki)

Adds key information.

Parameters:

ki - The KeyInfo Node.

getKeyInfo

public oracle.security.xmlsec.dsig.XSKeyInfo getKeyInfo()

Returns the key information.

Returns:

A KeyInfo object or null if none was found.

addEncryptionMethod

public void addEncryptionMethod(EncryptionMethod encMethod)

Adds an encryption method.

Parameters:

encMethod - A EncryptionMethod object.

getEncryptionMethods

public java.util.List getEncryptionMethods()

Returns the list of encryption methods.

Returns:

A List of EncryptionMethod objects or null if none were found.