org.jcp.xml.dsig.internal.dom
Class DOMKeyInfo

java.lang.Object
  org.jcp.xml.dsig.internal.dom.DOMStructure
      org.jcp.xml.dsig.internal.dom.DOMKeyInfo

All Implemented Interfaces:

KeyInfo, XMLStructure

public final class DOMKeyInfo
extends DOMStructure
implements KeyInfo

Disabled: no SafeJ information.

DOM-based implementation of KeyInfo.

Constructor Summary

DOMKeyInfo(org.w3c.dom.Element kiElem, XMLCryptoContext context, Provider provider)
Creates a DOMKeyInfo from XML.

DOMKeyInfo(List content, String id)
Creates a DOMKeyInfo.

Method Summary

boolean	equals(Object o) Indicates whether some other object is "equal to" this one.
List	getContent() Returns an unmodifiable list containing the key information.
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, String dsPrefix, DOMCryptoContext context)
void	marshal(org.w3c.dom.Node parent, String dsPrefix, DOMCryptoContext context)
void	marshal(XMLStructure parent, XMLCryptoContext context) Marshals the key info to XML.

Methods inherited from class org.jcp.xml.dsig.internal.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(List content,
                  String id)

Class is disabled.

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:

NullPointerException - if content is null

IllegalArgumentException - if content is empty

ClassCastException - if content contains any entries that are not of type XMLStructure

DOMKeyInfo

public DOMKeyInfo(org.w3c.dom.Element kiElem,
                  XMLCryptoContext context,
                  Provider provider)
           throws MarshalException

Class is disabled.

Creates a DOMKeyInfo from XML.

Parameters:

kiElem - KeyInfo element

Throws:

MarshalException

Method Detail

getId

public String getId()

Class is disabled.

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 List getContent()

Class is disabled.

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

Class is disabled.

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,
                    String dsPrefix,
                    DOMCryptoContext context)
             throws MarshalException

Class is disabled.

Specified by:

marshal in class DOMStructure

Throws:

MarshalException

marshal

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

Class is disabled.

Throws:

MarshalException

equals

public boolean equals(Object o)

Enabled. assumes no non-deterministic equals methods in libraries

Description copied from class: Object

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

Overrides:

equals in class Object

Parameters:

o - the reference object with which to compare.

Returns:

true if this object is the same as the obj argument; false otherwise.

See Also:

Object.hashCode(), HashMap