Class Transform
java.lang.Object
org.apache.xml.security.utils.ElementProxy
org.apache.xml.security.utils.SignatureElementProxy
org.apache.xml.security.transforms.Transform
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:
-
Field Summary
Fields inherited from class org.apache.xml.security.utils.ElementProxy
baseURI -
Constructor Summary
ConstructorsConstructorDescriptionGenerates a Transform object that implements the specifiedTransform algorithmURI.Generates a Transform object that implements the specifiedTransform algorithmURI.ConstructsTransform -
Method Summary
Modifier and TypeMethodDescriptionReturns the localname of the Elements of the sub-class.getURI()Returns the URI representation of Transformation algorithmbooleanTransforms the input, and generatesXMLSignatureInputas output.performTransform(XMLSignatureInput input, OutputStream os) Transforms the input, and generatesXMLSignatureInputas output.static voidregister(String algorithmURI, Class<? extends TransformSpi> implementingClass) Registers implementing class of the Transform algorithm with algorithmURIstatic voidRegisters implementing class of the Transform algorithm with algorithmURIstatic voidThis method registers the default algorithms.voidsetSecureValidation(boolean secureValidation) Methods inherited from class org.apache.xml.security.utils.SignatureElementProxy
getBaseNamespaceMethods 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
-
Constructor Details
-
Transform
Generates a Transform object that implements the specifiedTransform algorithmURI.- Parameters:
doc- the proxyDocumentalgorithmURI-Transform algorithmURI 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 specifiedTransform algorithmURI.- Parameters:
algorithmURI-Transform algorithmURI representation, such as specified in Transform algorithmcontextChild- the child element ofTransformelementdoc- the proxyDocument- Throws:
InvalidTransformException
-
Transform
public Transform(Document doc, String algorithmURI, NodeList contextNodes) throws InvalidTransformException ConstructsTransform- Parameters:
doc- theDocumentin whichTransformwill be placedalgorithmURI- URI representation ofTransform algorithmcontextNodes- the child node list ofTransformelement- Throws:
InvalidTransformException
-
Transform
public Transform(Element element, String baseURI) throws InvalidTransformException, TransformationException, XMLSecurityException - Parameters:
element-ds:TransformelementbaseURI- the URI of the resource where the XML instance was stored- Throws:
InvalidTransformExceptionTransformationExceptionXMLSecurityException
-
-
Method Details
-
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 ofTransform algorithmimplementingClass-implementingClassthe implementing class ofTransformSpi- Throws:
AlgorithmAlreadyRegisteredException- if specified algorithmURI is already registeredSecurityException- if a security manager is installed and the caller does not have permission to register the transformClassNotFoundExceptionInvalidTransformException
-
register
public static void register(String algorithmURI, Class<? extends TransformSpi> implementingClass) throws AlgorithmAlreadyRegisteredException Registers implementing class of the Transform algorithm with algorithmURI- Parameters:
algorithmURI- algorithmURI URI representation ofTransform algorithmimplementingClass-implementingClassthe implementing class ofTransformSpi- Throws:
AlgorithmAlreadyRegisteredException- if specified algorithmURI is already registeredSecurityException- 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
Returns the URI representation of Transformation algorithm- Returns:
- the URI representation of Transformation algorithm
-
performTransform
public XMLSignatureInput performTransform(XMLSignatureInput input) throws IOException, CanonicalizationException, InvalidCanonicalizerException, TransformationException Transforms the input, and generatesXMLSignatureInputas output.- Parameters:
input- inputXMLSignatureInputwhich can supplied Octet Stream and NodeSet as Input of Transformation- Returns:
- the
XMLSignatureInputclass as the result of transformation - Throws:
CanonicalizationExceptionIOExceptionInvalidCanonicalizerExceptionTransformationException
-
performTransform
public XMLSignatureInput performTransform(XMLSignatureInput input, OutputStream os) throws IOException, CanonicalizationException, InvalidCanonicalizerException, TransformationException Transforms the input, and generatesXMLSignatureInputas output.- Parameters:
input- inputXMLSignatureInputwhich can supplied Octect Stream and NodeSet as Input of Transformationos- where to output the result of the last transformation- Returns:
- the
XMLSignatureInputclass as the result of transformation - Throws:
CanonicalizationExceptionIOExceptionInvalidCanonicalizerExceptionTransformationException
-
getBaseLocalName
Returns the localname of the Elements of the sub-class.- Specified by:
getBaseLocalNamein classElementProxy- Returns:
- the localname of the Elements of the sub-class.
-
isSecureValidation
public boolean isSecureValidation() -
setSecureValidation
public void setSecureValidation(boolean secureValidation)
-