Module org.apache.santuario.xmlsec

Package org.apache.xml.security.transforms

Class Transform

java.lang.Object

org.apache.xml.security.utils.ElementProxy

org.apache.xml.security.utils.SignatureElementProxy

org.apache.xml.security.transforms.Transform

public final class Transform
extends SignatureElementProxy

Implements the behaviour of the ds:Transform element. This Transform(Factory) class acts as the Factory and Proxy of the implementing class that supports the functionality of a Transform algorithm. Implements the Factory and Proxy pattern for ds:Transform algorithms.

See Also:

Transforms, TransformSpi

Field Summary

Fields inherited from class org.apache.xml.security.utils.ElementProxy

baseURI

Constructor Summary

Constructors

Constructor	Description
Transform(Document doc, String algorithmURI)	Generates a Transform object that implements the specified Transform algorithm URI.
Transform(Document doc, String algorithmURI, Element contextChild)	Generates a Transform object that implements the specified Transform algorithm URI.
Transform(Document doc, String algorithmURI, NodeList contextNodes)	Constructs Transform
Transform(Element element, String baseURI)

Method Summary

Modifier and Type	Method	Description
String	getBaseLocalName()	Returns the localname of the Elements of the sub-class.
String	getURI()	Returns the URI representation of Transformation algorithm
XMLSignatureInput	performTransform(XMLSignatureInput input, boolean secureValidation)	Transforms the input, and generates XMLSignatureInput as output.
XMLSignatureInput	performTransform(XMLSignatureInput input, OutputStream os, boolean secureValidation)	Transforms the input, and generates XMLSignatureInput as output.
static void	register(String algorithmURI, Class<? extends TransformSpi> implementingClass)	Registers implementing class of the Transform algorithm with algorithmURI
static void	register(String algorithmURI, String implementingClass)	Registers implementing class of the Transform algorithm with algorithmURI
static void	registerDefaultAlgorithms()	This method registers the default algorithms.

Methods inherited from class org.apache.xml.security.utils.SignatureElementProxy

getBaseNamespace

Methods inherited from class org.apache.xml.security.utils.ElementProxy

addBase64Element, addBase64Text, addBigIntegerElement, addReturnToSelf, addText, addTextElement, appendOther, appendSelf, appendSelf, createElementForFamily, createElementForFamilyLocal, createText, getBaseURI, getBigIntegerFromChildElement, getBytesFromTextChild, getDefaultPrefix, getDocument, getElement, getElementPlusReturns, getFirstChild, getLocalAttribute, getTextFromChildElement, getTextFromTextChild, length, registerDefaultPrefixes, setDefaultPrefix, setDocument, setElement, setElement, setLocalAttribute, setLocalIdAttribute, setXPathNamespaceContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Transform

public Transform(Document doc,
                 String algorithmURI)
          throws InvalidTransformException

Generates a Transform object that implements the specified Transform algorithm URI.

Parameters:

doc - the proxy Document

algorithmURI - Transform algorithm URI representation, such as specified in Transform algorithm

Throws:

InvalidTransformException

Transform

public Transform(Document doc,
                 String algorithmURI,
                 Element contextChild)
          throws InvalidTransformException

Generates a Transform object that implements the specified Transform algorithm URI.

Parameters:

algorithmURI - Transform algorithm URI representation, such as specified in Transform algorithm

contextChild - the child element of Transform element

doc - the proxy Document

Throws:

InvalidTransformException

Transform

public Transform(Document doc,
                 String algorithmURI,
                 NodeList contextNodes)
          throws InvalidTransformException

Constructs Transform

Parameters:

doc - the Document in which Transform will be placed

algorithmURI - URI representation of Transform algorithm

contextNodes - the child node list of Transform element

Throws:

InvalidTransformException

Transform

public Transform(Element element,
                 String baseURI)
          throws InvalidTransformException,
                 TransformationException,
                 XMLSecurityException

Parameters:

element - ds:Transform element

baseURI - the URI of the resource where the XML instance was stored

Throws:

InvalidTransformException

TransformationException

XMLSecurityException

Method Detail

register

public static void register(String algorithmURI,
                            String implementingClass)
                     throws AlgorithmAlreadyRegisteredException,
                            ClassNotFoundException,
                            InvalidTransformException

Registers implementing class of the Transform algorithm with algorithmURI

Parameters:

algorithmURI - algorithmURI URI representation of Transform algorithm

implementingClass - implementingClass the implementing class of TransformSpi

Throws:

AlgorithmAlreadyRegisteredException - if specified algorithmURI is already registered

ClassNotFoundException - if the implementing Class cannot be found

InvalidTransformException - if the implementing Class cannot be instantiated

SecurityException - if a security manager is installed and the caller does not have permission to register the transform

register

public static void register(String algorithmURI,
                            Class<? extends TransformSpi> implementingClass)
                     throws AlgorithmAlreadyRegisteredException,
                            InvalidTransformException

Registers implementing class of the Transform algorithm with algorithmURI

Parameters:

algorithmURI - algorithmURI URI representation of Transform algorithm

implementingClass - implementingClass the implementing class of TransformSpi

Throws:

AlgorithmAlreadyRegisteredException - if specified algorithmURI is already registered

InvalidTransformException - if the implementing Class cannot be instantiated

SecurityException - if a security manager is installed and the caller does not have permission to register the transform

registerDefaultAlgorithms

public static void registerDefaultAlgorithms()

This method registers the default algorithms.

getURI

public String getURI()

Returns the URI representation of Transformation algorithm

Returns:

the URI representation of Transformation algorithm

performTransform

public XMLSignatureInput performTransform(XMLSignatureInput input,
                                          boolean secureValidation)
                                   throws IOException,
                                          CanonicalizationException,
                                          InvalidCanonicalizerException,
                                          TransformationException

Transforms the input, and generates XMLSignatureInput as output.

Parameters:

input - input XMLSignatureInput which can supplied Octet Stream and NodeSet as Input of Transformation

secureValidation - Whether secure validation is enabled

Returns:

the XMLSignatureInput class as the result of transformation

Throws:

CanonicalizationException

IOException

InvalidCanonicalizerException

TransformationException

performTransform

public XMLSignatureInput performTransform(XMLSignatureInput input,
                                          OutputStream os,
                                          boolean secureValidation)
                                   throws IOException,
                                          CanonicalizationException,
                                          InvalidCanonicalizerException,
                                          TransformationException

Transforms the input, and generates XMLSignatureInput as output.

Parameters:

input - input XMLSignatureInput which can supplied Octet Stream and NodeSet as Input of Transformation

os - where to output the result of the last transformation

secureValidation - Whether secure validation is enabled

Returns:

the XMLSignatureInput class as the result of transformation

Throws:

CanonicalizationException

IOException

InvalidCanonicalizerException

TransformationException

getBaseLocalName

public String getBaseLocalName()

Returns the localname of the Elements of the sub-class.

Specified by:

getBaseLocalName in class ElementProxy

Returns:

the localname of the Elements of the sub-class.