OpenJDK 27 · org.jcp.xml.dsig.internal.dom.DOMKeyInfo

Modifier and Type	Field and Description
private final String	id
private final List<XMLStructure>	keyInfoTypes

Access	Constructor and Description
public	DOMKeyInfo(List<? extends XMLStructure> a list of one or more `XMLStructure`s representing key information types. The list is defensively copied to protect against subsequent modification. content, String an ID attribute id) Creates a `DOMKeyInfo`.
public	DOMKeyInfo(Element KeyInfo element kiElem, XMLCryptoContext context, Provider provider) Creates a `DOMKeyInfo` from XML.

Method Summary

Modifier and Type	Method and Description
public boolean	equals(Object o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public static List<XMLStructure>	Returns: the content of a KeyInfo Object getContent(KeyInfo ki) A utility function to suppress casting warnings.
public List<XMLStructure>	getContent() Implements javax.xml.crypto.dsig.keyinfo.KeyInfo.getContent. Returns an `unmodifiable list` containing the key information.
public String	getId() Implements javax.xml.crypto.dsig.keyinfo.KeyInfo.getId. Return the optional Id attribute of this `KeyInfo`, which may be useful for referencing this `KeyInfo` from other XML structures.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public void	marshal(XMLStructure parent, XMLCryptoContext context) Implements javax.xml.crypto.dsig.keyinfo.KeyInfo.marshal. Marshals the key info to XML.
public void	marshal(Node parent, String dsPrefix, DOMCryptoContext context) Implements abstract org.jcp.xml.dsig.internal.dom.DOMStructure.marshal.
public void	marshal(Node parent, Node nextSibling, String dsPrefix, DOMCryptoContext context)
private void	marshal(Node parent, Element kiElem, Node nextSibling, String dsPrefix, DOMCryptoContext context)

Inherited from org.jcp.xml.dsig.internal.dom.DOMStructure:: equalsContent isFeatureSupported

id	back to summary
private final String id

keyInfoTypes	back to summary
private final List<XMLStructure> keyInfoTypes

DOMKeyInfo	back to summary
public DOMKeyInfo(List<? extends XMLStructure> content, String id) Creates a `DOMKeyInfo`. Parameters content:List<? extends XMLStructure> a list of one or more `XMLStructure`s representing key information types. The list is defensively copied to protect against subsequent modification. id:String an ID attribute Exceptions NullPointerException: if `content` is `null` IllegalArgumentException: if `content` is empty ClassCastException: if `content` contains any entries that are not of type `XMLStructure`

DOMKeyInfo	back to summary
public DOMKeyInfo(Element kiElem, XMLCryptoContext context, Provider provider) throws MarshalException Creates a `DOMKeyInfo` from XML. Parameters kiElem:Element KeyInfo element

Method Detail

equals back to summary

equals	back to summary
public boolean equals(Object o) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. 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`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Annotations @Override

public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

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.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Annotations

@Override

getContent	back to summary
public static List<XMLStructure> getContent(KeyInfo ki) A utility function to suppress casting warnings. Returns:List<XMLStructure> the content of a KeyInfo Object Annotations @SuppressWarnings:unchecked

getContent

back to summary

public static List<XMLStructure> getContent(KeyInfo ki)

A utility function to suppress casting warnings.

Returns:List<XMLStructure>

the content of a KeyInfo Object

Annotations

@SuppressWarnings:unchecked

getContent back to summary

getContent	back to summary
public List<XMLStructure> getContent() Implements javax.xml.crypto.dsig.keyinfo.KeyInfo.getContent. Doc from javax.xml.crypto.dsig.keyinfo.KeyInfo.getContent. 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 `javax.xml.crypto.dsig.keyinfo.X509Data`). Annotations @Override

public List<XMLStructure> getContent()

Implements javax.xml.crypto.dsig.keyinfo.KeyInfo.getContent.

Doc from javax.xml.crypto.dsig.keyinfo.KeyInfo.getContent.

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 javax.xml.crypto.dsig.keyinfo.X509Data).

Annotations

@Override

getId back to summary

getId	back to summary
public String getId() Implements javax.xml.crypto.dsig.keyinfo.KeyInfo.getId. Doc from javax.xml.crypto.dsig.keyinfo.KeyInfo.getId. Return the optional Id attribute of this `KeyInfo`, which may be useful for referencing this `KeyInfo` from other XML structures. Annotations @Override

public String getId()

Implements javax.xml.crypto.dsig.keyinfo.KeyInfo.getId.

Doc from javax.xml.crypto.dsig.keyinfo.KeyInfo.getId.

Return the optional Id attribute of this KeyInfo, which may be useful for referencing this KeyInfo from other XML structures.

Annotations

@Override

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Annotations

@Override

marshal	back to summary
public void marshal(XMLStructure parent, XMLCryptoContext context) throws MarshalException Implements javax.xml.crypto.dsig.keyinfo.KeyInfo.marshal. Doc from javax.xml.crypto.dsig.keyinfo.KeyInfo.marshal. Marshals the key info to XML. Annotations @Override Exceptions MarshalException: if the key info cannot be marshalled

marshal

back to summary

public void marshal(XMLStructure parent, XMLCryptoContext context) throws MarshalException

Implements javax.xml.crypto.dsig.keyinfo.KeyInfo.marshal.

Doc from javax.xml.crypto.dsig.keyinfo.KeyInfo.marshal.

Marshals the key info to XML.

Annotations

@Override

Exceptions

MarshalException:: if the key info cannot be marshalled

marshal	back to summary
public void marshal(Node parent, String dsPrefix, DOMCryptoContext context) throws MarshalException Implements abstract org.jcp.xml.dsig.internal.dom.DOMStructure.marshal. Annotations @Override

marshal

back to summary

public void marshal(Node parent, String dsPrefix, DOMCryptoContext context) throws MarshalException

Implements abstract org.jcp.xml.dsig.internal.dom.DOMStructure.marshal.

Annotations

@Override

marshal	back to summary
public void marshal(Node parent, Node nextSibling, String dsPrefix, DOMCryptoContext context) throws MarshalException

marshal	back to summary
private void marshal(Node parent, Element kiElem, Node nextSibling, String dsPrefix, DOMCryptoContext context) throws MarshalException

public final Class DOMKeyInfo

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail