XML Security, 1.6

com.ibm.xml.enc.dom
Class DOMKeyInfo

java.lang.Object
  extended by com.ibm.xml.enc.dom.DOMStructure
      extended by com.ibm.xml.enc.dom.DOMKeyInfo
All Implemented Interfaces:
KeyInfo, XMLStructure
Direct Known Subclasses:
DOMOriginatorKeyInfo, DOMRecipientKeyInfo

public class DOMKeyInfo
extends DOMStructure
implements KeyInfo

DOM-based implementation of KeyInfo.


Constructor Summary
DOMKeyInfo(org.w3c.dom.Element kiElem, XMLCryptoContext context)
          Creates a DOMKeyInfo from XML.
DOMKeyInfo(java.util.List content, java.lang.String id)
          Creates a DOMKeyInfo.
 
Method Summary
 boolean equals(java.lang.Object o)
           
 java.util.List getContent()
          Returns an unmodifiable list containing the key information.
 java.lang.String getId()
          Return the optional Id attribute of this KeyInfo, which may be useful for referencing this KeyInfo from other XML structures.
 void marshal(org.w3c.dom.Node parent, org.w3c.dom.Node nextSibling, java.lang.String dsPrefix, DOMCryptoContext context)
           
 void marshal(org.w3c.dom.Node parent, java.lang.String dsPrefix, DOMCryptoContext context)
           
 void marshal(XMLStructure parent, XMLCryptoContext context)
          Marshals the key info to XML.
 
Methods inherited from class com.ibm.xml.enc.dom.DOMStructure
isFeatureSupported
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface javax.xml.crypto.XMLStructure
isFeatureSupported
 

Constructor Detail

DOMKeyInfo

public DOMKeyInfo(java.util.List content,
                  java.lang.String id)
Creates a DOMKeyInfo.

Parameters:
content - a list of one or more XMLStructures representing key information types. The list is defensively copied to protect against subsequent modification.
id - an ID attribute
Throws:
java.lang.NullPointerException - if content is null
java.lang.IllegalArgumentException - if content is empty
java.lang.ClassCastException - if content contains any entries that are not of type XMLStructure

DOMKeyInfo

public DOMKeyInfo(org.w3c.dom.Element kiElem,
                  XMLCryptoContext context)
           throws MarshalException
Creates a DOMKeyInfo from XML.

Parameters:
input - XML input
Throws:
MarshalException
Method Detail

getId

public java.lang.String getId()
Description copied from interface: KeyInfo
Return the optional Id attribute of this KeyInfo, which may be useful for referencing this KeyInfo from other XML structures.

Specified by:
getId in interface KeyInfo
Returns:
the Id attribute of this KeyInfo (may be null if not specified)

getContent

public java.util.List getContent()
Description copied from interface: KeyInfo
Returns an unmodifiable list containing the key information. Each entry of the list is an XMLStructure.

If there is a public subclass representing the type of XMLStructure, it is returned as an instance of that class (ex: an X509Data element would be returned as an instance of X509Data).

Specified by:
getContent in interface KeyInfo
Returns:
an unmodifiable list of one or more XMLStructures in this KeyInfo. Never returns null or an empty list.

marshal

public void marshal(XMLStructure parent,
                    XMLCryptoContext context)
             throws MarshalException
Description copied from interface: KeyInfo
Marshals the key info to XML.

Specified by:
marshal in interface KeyInfo
Parameters:
parent - a mechanism-specific structure containing the parent node that the marshalled key info will be appended to
context - the XMLCryptoContext containing additional context (may be null if not applicable)
Throws:
MarshalException - if the key info cannot be marshalled

marshal

public void marshal(org.w3c.dom.Node parent,
                    java.lang.String dsPrefix,
                    DOMCryptoContext context)
             throws MarshalException
Specified by:
marshal in class DOMStructure
Throws:
MarshalException

marshal

public void marshal(org.w3c.dom.Node parent,
                    org.w3c.dom.Node nextSibling,
                    java.lang.String dsPrefix,
                    DOMCryptoContext context)
             throws MarshalException
Throws:
MarshalException

equals

public boolean equals(java.lang.Object o)
Overrides:
equals in class java.lang.Object

XML Security, 1.6

Portions Copyright 2003, 2012 IBM Corporation.
Portions Copyright 2003, 2012 Oracle and/or its affiliates.