| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public abstract class TransformService extends Object implements Transform
A Service Provider Interface for transform and canonicalization algorithms.
Each instance of TransformService
supports a specific
transform or canonicalization algorithm and XML mechanism type. To create a
TransformService
, call one of the static
{@link #getInstance getInstance} methods, passing in the algorithm URI and
XML mechanism type desired, for example:
TransformService ts = TransformService.getInstance(Transform.XPATH2, "DOM");
TransformService
implementations are registered and loaded
using the {@link java.security.Provider} mechanism. Each
TransformService
service provider implementation should include
a MechanismType
service attribute that identifies the XML
mechanism type that it supports. If the attribute is not specified,
"DOM" is assumed. For example, a service provider that supports the
XPath Filter 2 Transform and DOM mechanism would be specified in the
Provider
subclass as:
put("TransformService." + Transform.XPATH2, "org.example.XPath2TransformService"); put("TransformService." + Transform.XPATH2 + " MechanismType", "DOM");
TransformService
implementations that support the DOM
mechanism type must abide by the DOM interoperability requirements defined
in the
DOM Mechanism Requirements section of the API overview. See the
Service Providers section of the API overview for a list of standard
mechanism types.
Once a TransformService
has been created, it can be used
to process Transform
or CanonicalizationMethod
objects. If the Transform
or CanonicalizationMethod
exists in XML form (for example, when validating an existing
XMLSignature
), the {@link #init(XMLStructure, XMLCryptoContext)}
method must be first called to initialize the transform and provide document
context (even if there are no parameters). Alternatively, if the
Transform
or CanonicalizationMethod
is being
created from scratch, the {@link #init(TransformParameterSpec)} method
is called to initialize the transform with parameters and the
{@link #marshalParams marshalParams} method is called to marshal the
parameters to XML and provide the transform with document context. Finally,
the {@link #transform transform} method is called to perform the
transformation.
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 TransformService
instance
concurrently should synchronize amongst themselves and provide the
necessary locking. Multiple threads each manipulating a different
TransformService
instance need not synchronize.
Constructor Summary | |
---|---|
protected |
Default constructor, for invocation by subclasses. |
Method Summary | |
---|---|
String |
Returns the URI of the algorithm supported by this TransformService .
|
static TransformService |
getInstance(String algorithm, String mechanismType) Returns a TransformService that supports the specified
algorithm URI (ex: javax.xml.crypto.dsig.Transform.XPATH2) and mechanism type
(ex: DOM).
|
static TransformService |
getInstance(String algorithm, String mechanismType, Provider provider) Returns a TransformService that supports the specified
algorithm URI (ex: javax.xml.crypto.dsig.Transform.XPATH2) and mechanism type
(ex: DOM) as supplied by the specified provider.
|
static TransformService |
getInstance(String algorithm, String mechanismType, String provider) Returns a TransformService that supports the specified
algorithm URI (ex: javax.xml.crypto.dsig.Transform.XPATH2) and mechanism type
(ex: DOM) as supplied by the specified provider.
|
String |
Returns the mechanism type supported by this TransformService .
|
Provider |
Returns the provider of this TransformService .
|
abstract void |
init(TransformParameterSpec params) Initializes this TransformService with the specified
parameters.
|
abstract void |
init(XMLStructure parent, XMLCryptoContext context) Initializes this TransformService with the specified
parameters and document context.
|
abstract void |
marshalParams(XMLStructure parent, XMLCryptoContext context) Marshals the algorithm-specific parameters. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
protected TransformService()
Method Detail |
---|
public final String getAlgorithm()
TransformService
.
public static TransformService getInstance(String algorithm, String mechanismType) throws NoSuchAlgorithmException
TransformService
that supports the specified
algorithm URI (ex: {@link Transform#XPATH2}) and mechanism type
(ex: DOM).
This method uses the standard JCA provider lookup mechanism to
locate and instantiate a TransformService
implementation
of the desired algorithm and MechanismType
service
attribute. It traverses the list of registered security
Provider
s, starting with the most preferred
Provider
. A new TransformService
object
from the first Provider
that supports the specified
algorithm and mechanism type is returned.
Note that the list of registered providers may be retrieved via the {@link Security#getProviders() Security.getProviders()} method.
algorithm
- the URI of the algorithmmechanismType
- the type of the XML processing mechanism and
representationTransformService
NoSuchAlgorithmException
- if no Provider
supports a
TransformService
implementation for the specified
algorithm and mechanism typepublic static TransformService getInstance(String algorithm, String mechanismType, Provider provider) throws NoSuchAlgorithmException
TransformService
that supports the specified
algorithm URI (ex: {@link Transform#XPATH2}) and mechanism 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.
algorithm
- the URI of the algorithmmechanismType
- the type of the XML processing mechanism and
representationprovider
- the Provider
objectTransformService
NoSuchAlgorithmException
- if a TransformService
implementation for the specified algorithm and mechanism type is not
available from the specified Provider
objectpublic static TransformService getInstance(String algorithm, String mechanismType, String provider) throws NoSuchAlgorithmException, NoSuchProviderException
TransformService
that supports the specified
algorithm URI (ex: {@link Transform#XPATH2}) and mechanism 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 {@link Security#getProviders() Security.getProviders()} method.
algorithm
- the URI of the algorithmmechanismType
- the type of the XML processing mechanism and
representationprovider
- the string name of the providerTransformService
NoSuchAlgorithmException
- if a TransformService
implementation for the specified algorithm and mechanism type is not
available from the specified providerNoSuchProviderException
- if the specified provider is not
registered in the security provider listpublic final String getMechanismType()
TransformService
.
public final Provider getProvider()
TransformService
.
public abstract void init(TransformParameterSpec params) throws InvalidAlgorithmParameterException
TransformService
with the specified
parameters.
If the parameters exist in XML form, the
{@link #init(XMLStructure, XMLCryptoContext)} method should be used to
initialize the TransformService
.
params
- the algorithm parameters (may be null
if
not required or optional)InvalidAlgorithmParameterException
- if the specified parameters
are invalid for this algorithmpublic abstract void init(XMLStructure parent, XMLCryptoContext context) throws InvalidAlgorithmParameterException
TransformService
with the specified
parameters and document context.
parent
- a mechanism-specific structure containing the parent
structurecontext
- the XMLCryptoContext
containing
additional context (may be null
if not applicable)InvalidAlgorithmParameterException
- if the specified parameters
are invalid for this algorithmpublic abstract void marshalParams(XMLStructure parent, XMLCryptoContext context) throws MarshalException
parent
- a mechanism-specific structure containing the parent
node that the marshalled parameters should be appended tocontext
- the XMLCryptoContext
containing
additional context (may be null
if not applicable)MarshalException
- if the parameters cannot be marshalled
| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |