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 theds:Transform
element. ThisTransform
(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 Modifier and Type Field Description private static org.slf4j.Logger
LOG
private boolean
secureValidation
private TransformSpi
transformSpi
private static java.util.Map<java.lang.String,java.lang.Class<? extends TransformSpi>>
transformSpiHash
All available Transform classes are registered here-
Fields inherited from class org.apache.xml.security.utils.ElementProxy
baseURI
-
-
Constructor Summary
Constructors Constructor Description Transform(org.w3c.dom.Document doc, java.lang.String algorithmURI)
Generates a Transform object that implements the specifiedTransform algorithm
URI.Transform(org.w3c.dom.Document doc, java.lang.String algorithmURI, org.w3c.dom.Element contextChild)
Generates a Transform object that implements the specifiedTransform algorithm
URI.Transform(org.w3c.dom.Document doc, java.lang.String algorithmURI, org.w3c.dom.NodeList contextNodes)
ConstructsTransform
Transform(org.w3c.dom.Element element, java.lang.String baseURI)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getBaseLocalName()
Returns the localname of the Elements of the sub-class.java.lang.String
getURI()
Returns the URI representation of Transformation algorithmprivate TransformSpi
initializeTransform(java.lang.String algorithmURI, org.w3c.dom.NodeList contextNodes)
Initialize the transform object.boolean
isSecureValidation()
XMLSignatureInput
performTransform(XMLSignatureInput input)
Transforms the input, and generatesXMLSignatureInput
as output.XMLSignatureInput
performTransform(XMLSignatureInput input, java.io.OutputStream os)
Transforms the input, and generatesXMLSignatureInput
as output.static void
register(java.lang.String algorithmURI, java.lang.Class<? extends TransformSpi> implementingClass)
Registers implementing class of the Transform algorithm with algorithmURIstatic void
register(java.lang.String algorithmURI, java.lang.String implementingClass)
Registers implementing class of the Transform algorithm with algorithmURIstatic void
registerDefaultAlgorithms()
This method registers the default algorithms.void
setSecureValidation(boolean secureValidation)
-
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
-
-
-
-
Field Detail
-
LOG
private static final org.slf4j.Logger LOG
-
transformSpiHash
private static java.util.Map<java.lang.String,java.lang.Class<? extends TransformSpi>> transformSpiHash
All available Transform classes are registered here
-
transformSpi
private final TransformSpi transformSpi
-
secureValidation
private boolean secureValidation
-
-
Constructor Detail
-
Transform
public Transform(org.w3c.dom.Document doc, java.lang.String algorithmURI) throws InvalidTransformException
Generates a Transform object that implements the specifiedTransform algorithm
URI.- Parameters:
doc
- the proxyDocument
algorithmURI
-Transform algorithm
URI representation, such as specified in Transform algorithm- Throws:
InvalidTransformException
-
Transform
public Transform(org.w3c.dom.Document doc, java.lang.String algorithmURI, org.w3c.dom.Element contextChild) throws InvalidTransformException
Generates a Transform object that implements the specifiedTransform algorithm
URI.- Parameters:
algorithmURI
-Transform algorithm
URI representation, such as specified in Transform algorithmcontextChild
- the child element ofTransform
elementdoc
- the proxyDocument
- Throws:
InvalidTransformException
-
Transform
public Transform(org.w3c.dom.Document doc, java.lang.String algorithmURI, org.w3c.dom.NodeList contextNodes) throws InvalidTransformException
ConstructsTransform
- Parameters:
doc
- theDocument
in whichTransform
will be placedalgorithmURI
- URI representation ofTransform algorithm
contextNodes
- the child node list ofTransform
element- Throws:
InvalidTransformException
-
Transform
public Transform(org.w3c.dom.Element element, java.lang.String baseURI) throws InvalidTransformException, TransformationException, XMLSecurityException
- Parameters:
element
-ds:Transform
elementbaseURI
- the URI of the resource where the XML instance was stored- Throws:
InvalidTransformException
TransformationException
XMLSecurityException
-
-
Method Detail
-
register
public static void register(java.lang.String algorithmURI, java.lang.String implementingClass) throws AlgorithmAlreadyRegisteredException, java.lang.ClassNotFoundException, InvalidTransformException
Registers implementing class of the Transform algorithm with algorithmURI- Parameters:
algorithmURI
- algorithmURI URI representation ofTransform algorithm
implementingClass
-implementingClass
the implementing class ofTransformSpi
- Throws:
AlgorithmAlreadyRegisteredException
- if specified algorithmURI is already registeredjava.lang.SecurityException
- if a security manager is installed and the caller does not have permission to register the transformjava.lang.ClassNotFoundException
InvalidTransformException
-
register
public static void register(java.lang.String algorithmURI, java.lang.Class<? extends TransformSpi> implementingClass) throws AlgorithmAlreadyRegisteredException
Registers implementing class of the Transform algorithm with algorithmURI- Parameters:
algorithmURI
- algorithmURI URI representation ofTransform algorithm
implementingClass
-implementingClass
the implementing class ofTransformSpi
- Throws:
AlgorithmAlreadyRegisteredException
- if specified algorithmURI is already registeredjava.lang.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 java.lang.String getURI()
Returns the URI representation of Transformation algorithm- Returns:
- the URI representation of Transformation algorithm
-
performTransform
public XMLSignatureInput performTransform(XMLSignatureInput input) throws java.io.IOException, CanonicalizationException, InvalidCanonicalizerException, TransformationException
Transforms the input, and generatesXMLSignatureInput
as output.- Parameters:
input
- inputXMLSignatureInput
which can supplied Octet Stream and NodeSet as Input of Transformation- Returns:
- the
XMLSignatureInput
class as the result of transformation - Throws:
CanonicalizationException
java.io.IOException
InvalidCanonicalizerException
TransformationException
-
performTransform
public XMLSignatureInput performTransform(XMLSignatureInput input, java.io.OutputStream os) throws java.io.IOException, CanonicalizationException, InvalidCanonicalizerException, TransformationException
Transforms the input, and generatesXMLSignatureInput
as output.- Parameters:
input
- inputXMLSignatureInput
which can supplied Octect Stream and NodeSet as Input of Transformationos
- where to output the result of the last transformation- Returns:
- the
XMLSignatureInput
class as the result of transformation - Throws:
CanonicalizationException
java.io.IOException
InvalidCanonicalizerException
TransformationException
-
getBaseLocalName
public java.lang.String getBaseLocalName()
Returns the localname of the Elements of the sub-class.- Specified by:
getBaseLocalName
in classElementProxy
- Returns:
- the localname of the Elements of the sub-class.
-
initializeTransform
private TransformSpi initializeTransform(java.lang.String algorithmURI, org.w3c.dom.NodeList contextNodes) throws InvalidTransformException
Initialize the transform object.- Throws:
InvalidTransformException
-
isSecureValidation
public boolean isSecureValidation()
-
setSecureValidation
public void setSecureValidation(boolean secureValidation)
-
-