APIdia Launch Partner
Top Description Fields Constructors Methods
org.jcp.xml.dsig.internal.dom

public final Class DOMSignedInfo

extends DOMStructure
implements SignedInfo
Class Inheritance
All Implemented Interfaces
javax.xml.crypto.dsig.SignedInfo, javax.xml.crypto.XMLStructure
Imports
java.io.ByteArrayInputStream, .ByteArrayOutputStream, .IOException, .InputStream, .OutputStream, java.security.Provider, java.security.spec.AlgorithmParameterSpec, .MGF1ParameterSpec, .PSSParameterSpec, java.util.ArrayList, .Collections, .List, javax.xml.crypto.MarshalException, .XMLCryptoContext, javax.xml.crypto.dom.DOMCryptoContext, javax.xml.crypto.dsig.CanonicalizationMethod, .Reference, .SignatureMethod, .SignedInfo, .TransformException, .XMLSignature, .XMLSignatureException, javax.xml.crypto.dsig.spec.RSAPSSParameterSpec, com.sun.org.apache.xml.internal.security.algorithms.implementations.SignatureBaseRSA, com.sun.org.apache.xml.internal.security.utils.UnsyncBufferedOutputStream, .XMLUtils, org.w3c.dom.Document, .Element, .Node

DOM-based implementation of SignedInfo.

Field Summary

Modifier and TypeField and Description
private InputStream
private final CanonicalizationMethod
private String
private Element
private static final Logger
private Document
private final List<Reference>
private final SignatureMethod

Constructor Summary

AccessConstructor and Description
public
DOMSignedInfo(CanonicalizationMethod
the canonicalization method
cm
,
SignatureMethod
the signature method
sm
,
List<? extends Reference>
the list of references. The list is copied.
references
)

Creates a DOMSignedInfo from the specified parameters.

public
DOMSignedInfo(CanonicalizationMethod
the canonicalization method
cm
,
SignatureMethod
the signature method
sm
,
List<? extends Reference>
the list of references. The list is copied.
references
,
String
an optional identifier that will allow this SignedInfo to be referenced by other signatures and objects
id
)

Creates a DOMSignedInfo from the specified parameters.

public
DOMSignedInfo(Element
a SignedInfo element
siElem
,
XMLCryptoContext context, Provider provider)

Creates a DOMSignedInfo from an element.

Method Summary

Modifier and TypeMethod and Description
public void
public boolean
equals(Object o)

Overrides java.lang.Object.equals.

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

public CanonicalizationMethod
getCanonicalizationMethod()

Implements javax.xml.crypto.dsig.SignedInfo.getCanonicalizationMethod.

Returns the canonicalization method of this SignedInfo.

public InputStream
getCanonicalizedData()

Implements javax.xml.crypto.dsig.SignedInfo.getCanonicalizedData.

Returns the canonicalized signed info bytes after a signing or validation operation.

public String
getId()

Implements javax.xml.crypto.dsig.SignedInfo.getId.

Returns the optional Id attribute of this SignedInfo.

public List<Reference>
public SignatureMethod
getSignatureMethod()

Implements javax.xml.crypto.dsig.SignedInfo.getSignatureMethod.

Returns the signature method of this SignedInfo.

public static List<Reference>
public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public void
Inherited from org.jcp.xml.dsig.internal.dom.DOMStructure:
equalsContentisFeatureSupported

Field Detail

canonDataback to summary
private InputStream canonData
canonicalizationMethodback to summary
private final CanonicalizationMethod canonicalizationMethod
idback to summary
private String id
localSiElemback to summary
private Element localSiElem
LOGback to summary
private static final Logger LOG
ownerDocback to summary
private Document ownerDoc
referencesback to summary
private final List<Reference> references
signatureMethodback to summary
private final SignatureMethod signatureMethod

Constructor Detail

DOMSignedInfoback to summary
public DOMSignedInfo(CanonicalizationMethod cm, SignatureMethod sm, List<? extends Reference> references)

Creates a DOMSignedInfo from the specified parameters. Use this constructor when the Id is not specified.

Parameters
cm:CanonicalizationMethod

the canonicalization method

sm:SignatureMethod

the signature method

references:List<? extends Reference>

the list of references. The list is copied.

Exceptions
NullPointerException:
if cm, sm, or references is null
IllegalArgumentException:
if references is empty
ClassCastException:
if any of the references are not of type Reference
DOMSignedInfoback to summary
public DOMSignedInfo(CanonicalizationMethod cm, SignatureMethod sm, List<? extends Reference> references, String id)

Creates a DOMSignedInfo from the specified parameters.

Parameters
cm:CanonicalizationMethod

the canonicalization method

sm:SignatureMethod

the signature method

references:List<? extends Reference>

the list of references. The list is copied.

id:String

an optional identifier that will allow this SignedInfo to be referenced by other signatures and objects

Exceptions
NullPointerException:
if cm, sm, or references is null
IllegalArgumentException:
if references is empty
ClassCastException:
if any of the references are not of type Reference
DOMSignedInfoback to summary
public DOMSignedInfo(Element siElem, XMLCryptoContext context, Provider provider) throws MarshalException

Creates a DOMSignedInfo from an element.

Parameters
siElem:Element

a SignedInfo element

Method Detail

canonicalizeback to summary
public void canonicalize(XMLCryptoContext context, ByteArrayOutputStream bos) throws XMLSignatureException
equalsback 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
getCanonicalizationMethodback to summary
public CanonicalizationMethod getCanonicalizationMethod()

Implements javax.xml.crypto.dsig.SignedInfo.getCanonicalizationMethod.

Doc from javax.xml.crypto.dsig.SignedInfo.getCanonicalizationMethod.

Returns the canonicalization method of this SignedInfo.

Annotations
@Override
getCanonicalizedDataback to summary
public InputStream getCanonicalizedData()

Implements javax.xml.crypto.dsig.SignedInfo.getCanonicalizedData.

Doc from javax.xml.crypto.dsig.SignedInfo.getCanonicalizedData.

Returns the canonicalized signed info bytes after a signing or validation operation. This method is useful for debugging.

Annotations
@Override
getIdback to summary
public String getId()

Implements javax.xml.crypto.dsig.SignedInfo.getId.

Doc from javax.xml.crypto.dsig.SignedInfo.getId.

Returns the optional Id attribute of this SignedInfo.

Annotations
@Override
getReferencesback to summary
public List<Reference> getReferences()

Implements javax.xml.crypto.dsig.SignedInfo.getReferences.

Doc from javax.xml.crypto.dsig.SignedInfo.getReferences.

Returns an unmodifiable list of one or more References.

Annotations
@Override
getSignatureMethodback to summary
public SignatureMethod getSignatureMethod()

Implements javax.xml.crypto.dsig.SignedInfo.getSignatureMethod.

Doc from javax.xml.crypto.dsig.SignedInfo.getSignatureMethod.

Returns the signature method of this SignedInfo.

Annotations
@Override
getSignedInfoReferencesback to summary
public static List<Reference> getSignedInfoReferences(SignedInfo si)
Annotations
@SuppressWarnings:unchecked
hashCodeback 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
marshalback 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