XMLSignatureFactory (Java Platform SE 6) (original) (raw)
javax.xml.crypto.dsig
Class XMLSignatureFactory
java.lang.Object
javax.xml.crypto.dsig.XMLSignatureFactory
public abstract class XMLSignatureFactory
extends Object
A factory for creating XMLSignature objects from scratch or for unmarshalling an XMLSignature
object from a corresponding XML representation.
Each instance of XMLSignatureFactory
supports a specific XML mechanism type. To create an XMLSignatureFactory
, call one of the static getInstance methods, passing in the XML mechanism type desired, for example:
XMLSignatureFactory factory = XMLSignatureFactory.getInstance("DOM");
The objects that this factory produces will be based on DOM and abide by the DOM interoperability requirements as defined in the[ DOM Mechanism Requirements](../../../../../technotes/guides/security/xmldsig/overview.html#DOM Mechanism Requirements) section of the API overview. See the[ Service Providers](../../../../../technotes/guides/security/xmldsig/overview.html#Service Provider) section of the API overview for a list of standard mechanism types.
XMLSignatureFactory
implementations are registered and loaded using the Provider mechanism. For example, a service provider that supports the DOM mechanism would be specified in the Provider
subclass as:
put("XMLSignatureFactory.DOM", "org.example.DOMXMLSignatureFactory");
An implementation MUST minimally support the default mechanism type: DOM.
Note that a caller must use the same XMLSignatureFactory
instance to create the XMLStructure
s of a particular XMLSignature
that is to be generated. The behavior is undefined if XMLStructure
s from different providers or different mechanism types are used together.
Also, the XMLStructure
s that are created by this factory may contain state specific to the XMLSignature
and are not intended to be reusable.
Creating XMLSignatures from scratch
Once the XMLSignatureFactory
has been created, objects can be instantiated by calling the appropriate method. For example, aReference instance may be created by invoking one of the[newReference](../../../../javax/xml/crypto/dsig/XMLSignatureFactory.html#newReference%28java.lang.String, javax.xml.crypto.dsig.DigestMethod%29) methods.
Unmarshalling XMLSignatures from XML
Alternatively, an XMLSignature
may be created from an existing XML representation by invoking the unmarshalXMLSignature method and passing it a mechanism-specific XMLValidateContext instance containing the XML content:
DOMValidateContext context = new DOMValidateContext(key, signatureElement); XMLSignature signature = factory.unmarshalXMLSignature(context);
Each XMLSignatureFactory
must support the required XMLValidateContext
types for that factory type, but may support others. A DOM XMLSignatureFactory
must support DOMValidateContext objects.
Signing and marshalling XMLSignatures to XML
Each XMLSignature
created by the factory can also be marshalled to an XML representation and signed, by invoking the sign method of the XMLSignature object and passing it a mechanism-specific XMLSignContext object containing the signing key and marshalling parameters (see DOMSignContext). For example:
DOMSignContext context = new DOMSignContext(privateKey, document);
signature.sign(context);
Concurrent Access
The static methods of this class are guaranteed to be thread-safe. Multiple threads may concurrently invoke the static methods defined in this class with no ill effects.
However, this is not true for the non-static methods defined by this class. Unless otherwise documented by a specific provider, threads that need to access a single XMLSignatureFactory
instance concurrently should synchronize amongst themselves and provide the necessary locking. Multiple threads each manipulating a different XMLSignatureFactory
instance need not synchronize.
Since:
1.6
Constructor Summary | |
---|---|
protected | XMLSignatureFactory() Default constructor, for invocation by subclasses. |
Method Summary | |
---|---|
static XMLSignatureFactory | getInstance() Returns an XMLSignatureFactory that supports the default XML processing mechanism and representation type ("DOM"). |
static XMLSignatureFactory | getInstance(String mechanismType) Returns an XMLSignatureFactory that supports the specified XML processing mechanism and representation type (ex: "DOM"). |
static XMLSignatureFactory | [getInstance](../../../../javax/xml/crypto/dsig/XMLSignatureFactory.html#getInstance%28java.lang.String, java.security.Provider%29)(String mechanismType,Provider provider) Returns an XMLSignatureFactory that supports the requested XML processing mechanism and representation type (ex: "DOM"), as supplied by the specified provider. |
static XMLSignatureFactory | [getInstance](../../../../javax/xml/crypto/dsig/XMLSignatureFactory.html#getInstance%28java.lang.String, java.lang.String%29)(String mechanismType,String provider) Returns an XMLSignatureFactory that supports the requested XML processing mechanism and representation type (ex: "DOM"), as supplied by the specified provider. |
KeyInfoFactory | getKeyInfoFactory() Returns a KeyInfoFactory that creates KeyInfo objects. |
String | getMechanismType() Returns the type of the XML processing mechanism and representation supported by this XMLSignatureFactory (ex: "DOM"). |
Provider | getProvider() Returns the provider of this XMLSignatureFactory. |
abstract URIDereferencer | getURIDereferencer() Returns a reference to the URIDereferencer that is used by default to dereference URIs in Reference objects. |
abstract boolean | isFeatureSupported(String feature) Indicates whether a specified feature is supported. |
abstract CanonicalizationMethod | [newCanonicalizationMethod](../../../../javax/xml/crypto/dsig/XMLSignatureFactory.html#newCanonicalizationMethod%28java.lang.String, javax.xml.crypto.dsig.spec.C14NMethodParameterSpec%29)(String algorithm,C14NMethodParameterSpec params) Creates a CanonicalizationMethod for the specified algorithm URI and parameters. |
abstract CanonicalizationMethod | [newCanonicalizationMethod](../../../../javax/xml/crypto/dsig/XMLSignatureFactory.html#newCanonicalizationMethod%28java.lang.String, javax.xml.crypto.XMLStructure%29)(String algorithm,XMLStructure params) Creates a CanonicalizationMethod for the specified algorithm URI and parameters. |
abstract DigestMethod | [newDigestMethod](../../../../javax/xml/crypto/dsig/XMLSignatureFactory.html#newDigestMethod%28java.lang.String, javax.xml.crypto.dsig.spec.DigestMethodParameterSpec%29)(String algorithm,DigestMethodParameterSpec params) Creates a DigestMethod for the specified algorithm URI and parameters. |
abstract Manifest | newManifest(List references) Creates a Manifest containing the specified list of References. |
abstract Manifest | [newManifest](../../../../javax/xml/crypto/dsig/XMLSignatureFactory.html#newManifest%28java.util.List, java.lang.String%29)(List references,String id) Creates a Manifest containing the specified list of References and optional id. |
abstract Reference | [newReference](../../../../javax/xml/crypto/dsig/XMLSignatureFactory.html#newReference%28java.lang.String, javax.xml.crypto.dsig.DigestMethod%29)(String uri,DigestMethod dm) Creates a Reference with the specified URI and digest method. |
abstract Reference | [newReference](../../../../javax/xml/crypto/dsig/XMLSignatureFactory.html#newReference%28java.lang.String, javax.xml.crypto.dsig.DigestMethod, java.util.List, javax.xml.crypto.Data, java.util.List, java.lang.String, java.lang.String%29)(String uri,DigestMethod dm,List appliedTransforms,Data result,List transforms,String type,String id) Creates a Reference with the specified parameters. |
abstract Reference | [newReference](../../../../javax/xml/crypto/dsig/XMLSignatureFactory.html#newReference%28java.lang.String, javax.xml.crypto.dsig.DigestMethod, java.util.List, java.lang.String, java.lang.String%29)(String uri,DigestMethod dm,List transforms,String type,String id) Creates a Reference with the specified parameters. |
abstract Reference | [newReference](../../../../javax/xml/crypto/dsig/XMLSignatureFactory.html#newReference%28java.lang.String, javax.xml.crypto.dsig.DigestMethod, java.util.List, java.lang.String, java.lang.String, byte[]%29)(String uri,DigestMethod dm,List transforms,String type,String id, byte[] digestValue) Creates a Reference with the specified parameters and pre-calculated digest value. |
abstract SignatureMethod | [newSignatureMethod](../../../../javax/xml/crypto/dsig/XMLSignatureFactory.html#newSignatureMethod%28java.lang.String, javax.xml.crypto.dsig.spec.SignatureMethodParameterSpec%29)(String algorithm,SignatureMethodParameterSpec params) Creates a SignatureMethod for the specified algorithm URI and parameters. |
abstract SignatureProperties | [newSignatureProperties](../../../../javax/xml/crypto/dsig/XMLSignatureFactory.html#newSignatureProperties%28java.util.List, java.lang.String%29)(List properties,String id) Creates a SignatureProperties containing the specified list of SignaturePropertys and optional id. |
abstract SignatureProperty | [newSignatureProperty](../../../../javax/xml/crypto/dsig/XMLSignatureFactory.html#newSignatureProperty%28java.util.List, java.lang.String, java.lang.String%29)(List content,String target,String id) Creates a SignatureProperty containing the specified list of XMLStructures, target URI and optional id. |
abstract SignedInfo | [newSignedInfo](../../../../javax/xml/crypto/dsig/XMLSignatureFactory.html#newSignedInfo%28javax.xml.crypto.dsig.CanonicalizationMethod, javax.xml.crypto.dsig.SignatureMethod, java.util.List%29)(CanonicalizationMethod cm,SignatureMethod sm,List references) Creates a SignedInfo with the specified canonicalization and signature methods, and list of one or more references. |
abstract SignedInfo | [newSignedInfo](../../../../javax/xml/crypto/dsig/XMLSignatureFactory.html#newSignedInfo%28javax.xml.crypto.dsig.CanonicalizationMethod, javax.xml.crypto.dsig.SignatureMethod, java.util.List, java.lang.String%29)(CanonicalizationMethod cm,SignatureMethod sm,List references,String id) Creates a SignedInfo with the specified parameters. |
abstract Transform | [newTransform](../../../../javax/xml/crypto/dsig/XMLSignatureFactory.html#newTransform%28java.lang.String, javax.xml.crypto.dsig.spec.TransformParameterSpec%29)(String algorithm,TransformParameterSpec params) Creates a Transform for the specified algorithm URI and parameters. |
abstract Transform | [newTransform](../../../../javax/xml/crypto/dsig/XMLSignatureFactory.html#newTransform%28java.lang.String, javax.xml.crypto.XMLStructure%29)(String algorithm,XMLStructure params) Creates a Transform for the specified algorithm URI and parameters. |
abstract XMLObject | [newXMLObject](../../../../javax/xml/crypto/dsig/XMLSignatureFactory.html#newXMLObject%28java.util.List, java.lang.String, java.lang.String, java.lang.String%29)(List content,String id,String mimeType,String encoding) Creates an XMLObject from the specified parameters. |
abstract XMLSignature | [newXMLSignature](../../../../javax/xml/crypto/dsig/XMLSignatureFactory.html#newXMLSignature%28javax.xml.crypto.dsig.SignedInfo, javax.xml.crypto.dsig.keyinfo.KeyInfo%29)(SignedInfo si,KeyInfo ki) Creates an XMLSignature and initializes it with the contents of the specified SignedInfo and KeyInfo objects. |
abstract XMLSignature | [newXMLSignature](../../../../javax/xml/crypto/dsig/XMLSignatureFactory.html#newXMLSignature%28javax.xml.crypto.dsig.SignedInfo, javax.xml.crypto.dsig.keyinfo.KeyInfo, java.util.List, java.lang.String, java.lang.String%29)(SignedInfo si,KeyInfo ki,List objects,String id,String signatureValueId) Creates an XMLSignature and initializes it with the specified parameters. |
abstract XMLSignature | unmarshalXMLSignature(XMLStructure xmlStructure) Unmarshals a new XMLSignature instance from a mechanism-specific XMLStructure instance. |
abstract XMLSignature | unmarshalXMLSignature(XMLValidateContext context) Unmarshals a new XMLSignature instance from a mechanism-specific XMLValidateContext instance. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, [wait](../../../../java/lang/Object.html#wait%28long, int%29) |
Constructor Detail |
---|
XMLSignatureFactory
protected XMLSignatureFactory()
Default constructor, for invocation by subclasses.
Method Detail |
---|
getInstance
public static XMLSignatureFactory getInstance(String mechanismType)
Returns an XMLSignatureFactory
that supports the specified XML processing mechanism and representation type (ex: "DOM").
This method uses the standard JCA provider lookup mechanism to locate and instantiate an XMLSignatureFactory
implementation of the desired mechanism type. It traverses the list of registered security Provider
s, starting with the most preferred Provider
. A new XMLSignatureFactory
object from the first Provider
that supports the specified mechanism is returned.
Note that the list of registered providers may be retrieved via the Security.getProviders() method.
Parameters:
mechanismType
- the type of the XML processing mechanism and representation. See the [ Service Providers](../../../../../technotes/guides/security/xmldsig/overview.html#Service Provider) section of the API overview for a list of standard mechanism types.
Returns:
a new XMLSignatureFactory
Throws:
[NullPointerException](../../../../java/lang/NullPointerException.html "class in java.lang")
- if mechanismType
is null
[NoSuchMechanismException](../../../../javax/xml/crypto/NoSuchMechanismException.html "class in javax.xml.crypto")
- if no Provider
supports an XMLSignatureFactory
implementation for the specified mechanism
See Also:
getInstance
public static XMLSignatureFactory getInstance(String mechanismType, Provider provider)
Returns an XMLSignatureFactory
that supports the requested XML processing mechanism and representation type (ex: "DOM"), as supplied by the specified provider. Note that the specified Provider
object does not have to be registered in the provider list.
Parameters:
mechanismType
- the type of the XML processing mechanism and representation. See the [ Service Providers](../../../../../technotes/guides/security/xmldsig/overview.html#Service Provider) section of the API overview for a list of standard mechanism types.
provider
- the Provider
object
Returns:
a new XMLSignatureFactory
Throws:
[NullPointerException](../../../../java/lang/NullPointerException.html "class in java.lang")
- if provider
or mechanismType
is null
[NoSuchMechanismException](../../../../javax/xml/crypto/NoSuchMechanismException.html "class in javax.xml.crypto")
- if an XMLSignatureFactory
implementation for the specified mechanism is not available from the specified Provider
object
See Also:
getInstance
public static XMLSignatureFactory getInstance(String mechanismType, String provider) throws NoSuchProviderException
Returns an XMLSignatureFactory
that supports the requested XML processing mechanism and representation type (ex: "DOM"), as supplied by the specified provider. The specified provider must be registered in the security provider list.
Note that the list of registered providers may be retrieved via the Security.getProviders() method.
Parameters:
mechanismType
- the type of the XML processing mechanism and representation. See the [ Service Providers](../../../../../technotes/guides/security/xmldsig/overview.html#Service Provider) section of the API overview for a list of standard mechanism types.
provider
- the string name of the provider
Returns:
a new XMLSignatureFactory
Throws:
[NoSuchProviderException](../../../../java/security/NoSuchProviderException.html "class in java.security")
- if the specified provider is not registered in the security provider list
[NullPointerException](../../../../java/lang/NullPointerException.html "class in java.lang")
- if provider
or mechanismType
is null
[NoSuchMechanismException](../../../../javax/xml/crypto/NoSuchMechanismException.html "class in javax.xml.crypto")
- if an XMLSignatureFactory
implementation for the specified mechanism is not available from the specified provider
See Also:
getInstance
public static XMLSignatureFactory getInstance()
Returns an XMLSignatureFactory
that supports the default XML processing mechanism and representation type ("DOM").
This method uses the standard JCA provider lookup mechanism to locate and instantiate an XMLSignatureFactory
implementation of the default mechanism type. It traverses the list of registered security Provider
s, starting with the most preferred Provider
. A new XMLSignatureFactory
object from the first Provider
that supports the DOM mechanism is returned.
Note that the list of registered providers may be retrieved via the Security.getProviders() method.
Returns:
a new XMLSignatureFactory
Throws:
[NoSuchMechanismException](../../../../javax/xml/crypto/NoSuchMechanismException.html "class in javax.xml.crypto")
- if no Provider
supports an XMLSignatureFactory
implementation for the DOM mechanism
See Also:
getMechanismType
public final String getMechanismType()
Returns the type of the XML processing mechanism and representation supported by this XMLSignatureFactory
(ex: "DOM").
Returns:
the XML processing mechanism type supported by thisXMLSignatureFactory
getProvider
public final Provider getProvider()
Returns the provider of this XMLSignatureFactory
.
Returns:
the provider of this XMLSignatureFactory
newXMLSignature
public abstract XMLSignature newXMLSignature(SignedInfo si, KeyInfo ki)
Creates an XMLSignature
and initializes it with the contents of the specified SignedInfo
and KeyInfo
objects.
Parameters:
si
- the signed info
ki
- the key info (may be null
)
Returns:
an XMLSignature
Throws:
[NullPointerException](../../../../java/lang/NullPointerException.html "class in java.lang")
- if si
is null
newXMLSignature
public abstract XMLSignature newXMLSignature(SignedInfo si, KeyInfo ki, List objects, String id, String signatureValueId)
Creates an XMLSignature
and initializes it with the specified parameters.
Parameters:
si
- the signed info
ki
- the key info (may be null
)
objects
- a list of XMLObjects (may be empty ornull
)
id
- the Id (may be null
)
signatureValueId
- the SignatureValue Id (may be null
)
Returns:
an XMLSignature
Throws:
[NullPointerException](../../../../java/lang/NullPointerException.html "class in java.lang")
- if si
is null
[ClassCastException](../../../../java/lang/ClassCastException.html "class in java.lang")
- if any of the objects
are not of type XMLObject
newReference
public abstract Reference newReference(String uri, DigestMethod dm)
Creates a Reference
with the specified URI and digest method.
Parameters:
uri
- the reference URI (may be null
)
dm
- the digest method
Returns:
a Reference
Throws:
[IllegalArgumentException](../../../../java/lang/IllegalArgumentException.html "class in java.lang")
- if uri
is not RFC 2396 compliant
[NullPointerException](../../../../java/lang/NullPointerException.html "class in java.lang")
- if dm
is null
newReference
public abstract Reference newReference(String uri, DigestMethod dm, List transforms, String type, String id)
Creates a Reference
with the specified parameters.
Parameters:
uri
- the reference URI (may be null
)
dm
- the digest method
transforms
- a list of Transforms. The list is defensively copied to protect against subsequent modification. May be null
or empty.
type
- the reference type, as a URI (may be null
)
id
- the reference ID (may be null
)
Returns:
a Reference
Throws:
[ClassCastException](../../../../java/lang/ClassCastException.html "class in java.lang")
- if any of the transforms
are not of type Transform
[IllegalArgumentException](../../../../java/lang/IllegalArgumentException.html "class in java.lang")
- if uri
is not RFC 2396 compliant
[NullPointerException](../../../../java/lang/NullPointerException.html "class in java.lang")
- if dm
is null
newReference
public abstract Reference newReference(String uri, DigestMethod dm, List transforms, String type, String id, byte[] digestValue)
Creates a Reference
with the specified parameters and pre-calculated digest value.
This method is useful when the digest value of a Reference
has been previously computed. See for example, the OASIS-DSS (Digital Signature Services) specification.
Parameters:
uri
- the reference URI (may be null
)
dm
- the digest method
transforms
- a list of Transforms. The list is defensively copied to protect against subsequent modification. May be null
or empty.
type
- the reference type, as a URI (may be null
)
id
- the reference ID (may be null
)
digestValue
- the digest value. The array is cloned to protect against subsequent modification.
Returns:
a Reference
Throws:
[ClassCastException](../../../../java/lang/ClassCastException.html "class in java.lang")
- if any of the transforms
are not of type Transform
[IllegalArgumentException](../../../../java/lang/IllegalArgumentException.html "class in java.lang")
- if uri
is not RFC 2396 compliant
[NullPointerException](../../../../java/lang/NullPointerException.html "class in java.lang")
- if dm
or digestValue
is null
newReference
public abstract Reference newReference(String uri, DigestMethod dm, List appliedTransforms, Data result, List transforms, String type, String id)
Creates a Reference
with the specified parameters.
This method is useful when a list of transforms have already been applied to the Reference
. See for example, the OASIS-DSS (Digital Signature Services) specification.
When an XMLSignature
containing this reference is generated, the specified transforms
(if non-null) are applied to the specified result
. The Transforms
element of the resulting Reference
element is set to the concatenation of the appliedTransforms
and transforms
.
Parameters:
uri
- the reference URI (may be null
)
dm
- the digest method
appliedTransforms
- a list of Transforms that have already been applied. The list is defensively copied to protect against subsequent modification. The list must contain at least one entry.
result
- the result of processing the sequence of appliedTransforms
transforms
- a list of Transforms that are to be applied when generating the signature. The list is defensively copied to protect against subsequent modification. May be null
or empty.
type
- the reference type, as a URI (may be null
)
id
- the reference ID (may be null
)
Returns:
a Reference
Throws:
[ClassCastException](../../../../java/lang/ClassCastException.html "class in java.lang")
- if any of the transforms (in either list) are not of type Transform
[IllegalArgumentException](../../../../java/lang/IllegalArgumentException.html "class in java.lang")
- if uri
is not RFC 2396 compliant or appliedTransforms
is empty
[NullPointerException](../../../../java/lang/NullPointerException.html "class in java.lang")
- if dm
, appliedTransforms
or result
is null
newSignedInfo
public abstract SignedInfo newSignedInfo(CanonicalizationMethod cm, SignatureMethod sm, List references)
Creates a SignedInfo
with the specified canonicalization and signature methods, and list of one or more references.
Parameters:
cm
- the canonicalization method
sm
- the signature method
references
- a list of one or more References. The list is defensively copied to protect against subsequent modification.
Returns:
a SignedInfo
Throws:
[ClassCastException](../../../../java/lang/ClassCastException.html "class in java.lang")
- if any of the references are not of type Reference
[IllegalArgumentException](../../../../java/lang/IllegalArgumentException.html "class in java.lang")
- if references
is empty
[NullPointerException](../../../../java/lang/NullPointerException.html "class in java.lang")
- if any of the parameters are null
newSignedInfo
public abstract SignedInfo newSignedInfo(CanonicalizationMethod cm, SignatureMethod sm, List references, String id)
Creates a SignedInfo
with the specified parameters.
Parameters:
cm
- the canonicalization method
sm
- the signature method
references
- a list of one or more References. The list is defensively copied to protect against subsequent modification.
id
- the id (may be null
)
Returns:
a SignedInfo
Throws:
[ClassCastException](../../../../java/lang/ClassCastException.html "class in java.lang")
- if any of the references are not of type Reference
[IllegalArgumentException](../../../../java/lang/IllegalArgumentException.html "class in java.lang")
- if references
is empty
[NullPointerException](../../../../java/lang/NullPointerException.html "class in java.lang")
- if cm
, sm
, orreferences
are null
newXMLObject
public abstract XMLObject newXMLObject(List content, String id, String mimeType, String encoding)
Creates an XMLObject
from the specified parameters.
Parameters:
content
- a list of XMLStructures. The list is defensively copied to protect against subsequent modification. May be null
or empty.
id
- the Id (may be null
)
mimeType
- the mime type (may be null
)
encoding
- the encoding (may be null
)
Returns:
an XMLObject
Throws:
[ClassCastException](../../../../java/lang/ClassCastException.html "class in java.lang")
- if content
contains any entries that are not of type XMLStructure
newManifest
public abstract Manifest newManifest(List references)
Creates a Manifest
containing the specified list of References.
Parameters:
references
- a list of one or more Reference
s. The list is defensively copied to protect against subsequent modification.
Returns:
a Manifest
Throws:
[NullPointerException](../../../../java/lang/NullPointerException.html "class in java.lang")
- if references
is null
[IllegalArgumentException](../../../../java/lang/IllegalArgumentException.html "class in java.lang")
- if references
is empty
[ClassCastException](../../../../java/lang/ClassCastException.html "class in java.lang")
- if references
contains any entries that are not of type Reference
newManifest
public abstract Manifest newManifest(List references, String id)
Creates a Manifest
containing the specified list of References and optional id.
Parameters:
references
- a list of one or more Reference
s. The list is defensively copied to protect against subsequent modification.
id
- the id (may be null
)
Returns:
a Manifest
Throws:
[NullPointerException](../../../../java/lang/NullPointerException.html "class in java.lang")
- if references
is null
[IllegalArgumentException](../../../../java/lang/IllegalArgumentException.html "class in java.lang")
- if references
is empty
[ClassCastException](../../../../java/lang/ClassCastException.html "class in java.lang")
- if references
contains any entries that are not of type Reference
newSignatureProperty
public abstract SignatureProperty newSignatureProperty(List content, String target, String id)
Creates a SignatureProperty
containing the specified list of XMLStructures, target URI and optional id.
Parameters:
content
- a list of one or more XMLStructure
s. The list is defensively copied to protect against subsequent modification.
target
- the target URI of the Signature that this property applies to
id
- the id (may be null
)
Returns:
a SignatureProperty
Throws:
[NullPointerException](../../../../java/lang/NullPointerException.html "class in java.lang")
- if content
or target
is null
[IllegalArgumentException](../../../../java/lang/IllegalArgumentException.html "class in java.lang")
- if content
is empty
[ClassCastException](../../../../java/lang/ClassCastException.html "class in java.lang")
- if content
contains any entries that are not of type XMLStructure
newSignatureProperties
public abstract SignatureProperties newSignatureProperties(List properties, String id)
Creates a SignatureProperties
containing the specified list of SignaturePropertys and optional id.
Parameters:
properties
- a list of one or more SignatureProperty
s. The list is defensively copied to protect against subsequent modification.
id
- the id (may be null
)
Returns:
a SignatureProperties
Throws:
[NullPointerException](../../../../java/lang/NullPointerException.html "class in java.lang")
- if properties
is null
[IllegalArgumentException](../../../../java/lang/IllegalArgumentException.html "class in java.lang")
- if properties
is empty
[ClassCastException](../../../../java/lang/ClassCastException.html "class in java.lang")
- if properties
contains any entries that are not of type SignatureProperty
newDigestMethod
public abstract DigestMethod newDigestMethod(String algorithm, DigestMethodParameterSpec params) throws NoSuchAlgorithmException, InvalidAlgorithmParameterException
Creates a DigestMethod
for the specified algorithm URI and parameters.
Parameters:
algorithm
- the URI identifying the digest algorithm
params
- algorithm-specific digest parameters (may be null
)
Returns:
the DigestMethod
Throws:
[InvalidAlgorithmParameterException](../../../../java/security/InvalidAlgorithmParameterException.html "class in java.security")
- if the specified parameters are inappropriate for the requested algorithm
[NoSuchAlgorithmException](../../../../java/security/NoSuchAlgorithmException.html "class in java.security")
- if an implementation of the specified algorithm cannot be found
[NullPointerException](../../../../java/lang/NullPointerException.html "class in java.lang")
- if algorithm
is null
newSignatureMethod
public abstract SignatureMethod newSignatureMethod(String algorithm, SignatureMethodParameterSpec params) throws NoSuchAlgorithmException, InvalidAlgorithmParameterException
Creates a SignatureMethod
for the specified algorithm URI and parameters.
Parameters:
algorithm
- the URI identifying the signature algorithm
params
- algorithm-specific signature parameters (may be null
)
Returns:
the SignatureMethod
Throws:
[InvalidAlgorithmParameterException](../../../../java/security/InvalidAlgorithmParameterException.html "class in java.security")
- if the specified parameters are inappropriate for the requested algorithm
[NoSuchAlgorithmException](../../../../java/security/NoSuchAlgorithmException.html "class in java.security")
- if an implementation of the specified algorithm cannot be found
[NullPointerException](../../../../java/lang/NullPointerException.html "class in java.lang")
- if algorithm
is null
newTransform
public abstract Transform newTransform(String algorithm, TransformParameterSpec params) throws NoSuchAlgorithmException, InvalidAlgorithmParameterException
Creates a Transform
for the specified algorithm URI and parameters.
Parameters:
algorithm
- the URI identifying the transform algorithm
params
- algorithm-specific transform parameters (may be null
)
Returns:
the Transform
Throws:
[InvalidAlgorithmParameterException](../../../../java/security/InvalidAlgorithmParameterException.html "class in java.security")
- if the specified parameters are inappropriate for the requested algorithm
[NoSuchAlgorithmException](../../../../java/security/NoSuchAlgorithmException.html "class in java.security")
- if an implementation of the specified algorithm cannot be found
[NullPointerException](../../../../java/lang/NullPointerException.html "class in java.lang")
- if algorithm
is null
newTransform
public abstract Transform newTransform(String algorithm, XMLStructure params) throws NoSuchAlgorithmException, InvalidAlgorithmParameterException
Creates a Transform
for the specified algorithm URI and parameters. The parameters are specified as a mechanism-specificXMLStructure
(ex: DOMStructure). This method is useful when the parameters are in XML form or there is no standard class for specifying the parameters.
Parameters:
algorithm
- the URI identifying the transform algorithm
params
- a mechanism-specific XML structure from which to unmarshal the parameters from (may be null
if not required or optional)
Returns:
the Transform
Throws:
[ClassCastException](../../../../java/lang/ClassCastException.html "class in java.lang")
- if the type of params
is inappropriate for this XMLSignatureFactory
[InvalidAlgorithmParameterException](../../../../java/security/InvalidAlgorithmParameterException.html "class in java.security")
- if the specified parameters are inappropriate for the requested algorithm
[NoSuchAlgorithmException](../../../../java/security/NoSuchAlgorithmException.html "class in java.security")
- if an implementation of the specified algorithm cannot be found
[NullPointerException](../../../../java/lang/NullPointerException.html "class in java.lang")
- if algorithm
is null
newCanonicalizationMethod
public abstract CanonicalizationMethod newCanonicalizationMethod(String algorithm, C14NMethodParameterSpec params) throws NoSuchAlgorithmException, InvalidAlgorithmParameterException
Creates a CanonicalizationMethod
for the specified algorithm URI and parameters.
Parameters:
algorithm
- the URI identifying the canonicalization algorithm
params
- algorithm-specific canonicalization parameters (may be null
)
Returns:
the CanonicalizationMethod
Throws:
[InvalidAlgorithmParameterException](../../../../java/security/InvalidAlgorithmParameterException.html "class in java.security")
- if the specified parameters are inappropriate for the requested algorithm
[NoSuchAlgorithmException](../../../../java/security/NoSuchAlgorithmException.html "class in java.security")
- if an implementation of the specified algorithm cannot be found
[NullPointerException](../../../../java/lang/NullPointerException.html "class in java.lang")
- if algorithm
is null
newCanonicalizationMethod
public abstract CanonicalizationMethod newCanonicalizationMethod(String algorithm, XMLStructure params) throws NoSuchAlgorithmException, InvalidAlgorithmParameterException
Creates a CanonicalizationMethod
for the specified algorithm URI and parameters. The parameters are specified as a mechanism-specific XMLStructure
(ex: DOMStructure). This method is useful when the parameters are in XML form or there is no standard class for specifying the parameters.
Parameters:
algorithm
- the URI identifying the canonicalization algorithm
params
- a mechanism-specific XML structure from which to unmarshal the parameters from (may be null
if not required or optional)
Returns:
the CanonicalizationMethod
Throws:
[ClassCastException](../../../../java/lang/ClassCastException.html "class in java.lang")
- if the type of params
is inappropriate for this XMLSignatureFactory
[InvalidAlgorithmParameterException](../../../../java/security/InvalidAlgorithmParameterException.html "class in java.security")
- if the specified parameters are inappropriate for the requested algorithm
[NoSuchAlgorithmException](../../../../java/security/NoSuchAlgorithmException.html "class in java.security")
- if an implementation of the specified algorithm cannot be found
[NullPointerException](../../../../java/lang/NullPointerException.html "class in java.lang")
- if algorithm
is null
getKeyInfoFactory
public final KeyInfoFactory getKeyInfoFactory()
Returns a KeyInfoFactory
that creates KeyInfo
objects. The returned KeyInfoFactory
has the same mechanism type and provider as this XMLSignatureFactory
.
Returns:
a KeyInfoFactory
Throws:
[NoSuchMechanismException](../../../../javax/xml/crypto/NoSuchMechanismException.html "class in javax.xml.crypto")
- if a KeyFactory
implementation with the same mechanism type and provider is not available
unmarshalXMLSignature
public abstract XMLSignature unmarshalXMLSignature(XMLValidateContext context) throws MarshalException
Unmarshals a new XMLSignature
instance from a mechanism-specific XMLValidateContext
instance.
Parameters:
context
- a mechanism-specific context from which to unmarshal the signature from
Returns:
the XMLSignature
Throws:
[NullPointerException](../../../../java/lang/NullPointerException.html "class in java.lang")
- if context
is null
[ClassCastException](../../../../java/lang/ClassCastException.html "class in java.lang")
- if the type of context
is inappropriate for this factory
[MarshalException](../../../../javax/xml/crypto/MarshalException.html "class in javax.xml.crypto")
- if an unrecoverable exception occurs during unmarshalling
unmarshalXMLSignature
public abstract XMLSignature unmarshalXMLSignature(XMLStructure xmlStructure) throws MarshalException
Unmarshals a new XMLSignature
instance from a mechanism-specific XMLStructure
instance. This method is useful if you only want to unmarshal (and not validate) an XMLSignature
.
Parameters:
xmlStructure
- a mechanism-specific XML structure from which to unmarshal the signature from
Returns:
the XMLSignature
Throws:
[NullPointerException](../../../../java/lang/NullPointerException.html "class in java.lang")
- if xmlStructure
is null
[ClassCastException](../../../../java/lang/ClassCastException.html "class in java.lang")
- if the type of xmlStructure
is inappropriate for this factory
[MarshalException](../../../../javax/xml/crypto/MarshalException.html "class in javax.xml.crypto")
- if an unrecoverable exception occurs during unmarshalling
isFeatureSupported
public abstract boolean isFeatureSupported(String feature)
Indicates whether a specified feature is supported.
Parameters:
feature
- the feature name (as an absolute URI)
Returns:
true
if the specified feature is supported,false
otherwise
Throws:
[NullPointerException](../../../../java/lang/NullPointerException.html "class in java.lang")
- if feature
is null
getURIDereferencer
public abstract URIDereferencer getURIDereferencer()
Returns a reference to the URIDereferencer
that is used by default to dereference URIs in Reference objects.
Returns:
a reference to the default URIDereferencer
(nevernull
)
Submit a bug or feature
For further API reference and developer documentation, see Java SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2015, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
Scripting on this page tracks web page traffic, but does not change the content in any way.