- java.lang.Object
-
- org.apache.xml.security.c14n.Canonicalizer
-
public final class Canonicalizer extends java.lang.Object
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.StringALGO_ID_C14N_EXCL_OMIT_COMMENTSThe URL defined in XML-SEC Rec for exclusive c14n without comments.static java.lang.StringALGO_ID_C14N_EXCL_WITH_COMMENTSThe URL defined in XML-SEC Rec for exclusive c14n with comments.static java.lang.StringALGO_ID_C14N_OMIT_COMMENTSThe URL defined in XML-SEC Rec for inclusive c14n without comments.static java.lang.StringALGO_ID_C14N_PHYSICALNon-standard algorithm to serialize the physical representation for XML Encryptionstatic java.lang.StringALGO_ID_C14N_WITH_COMMENTSThe URL defined in XML-SEC Rec for inclusive c14n with comments.static java.lang.StringALGO_ID_C14N11_OMIT_COMMENTSThe URI for inclusive c14n 1.1 without comments.static java.lang.StringALGO_ID_C14N11_WITH_COMMENTSThe URI for inclusive c14n 1.1 with comments.private static java.util.Map<java.lang.String,java.lang.Class<? extends CanonicalizerSpi>>canonicalizerHashprivate CanonicalizerSpicanonicalizerSpistatic java.lang.StringENCODINGThe output encoding of canonicalized datastatic java.lang.StringXPATH_C14N_WITH_COMMENTS_SINGLE_NODEXPath Expression for selecting every node and continuous comments joined in only one node
-
Constructor Summary
Constructors Modifier Constructor Description privateCanonicalizer(java.lang.String algorithmURI)Constructor Canonicalizer
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description voidcanonicalize(byte[] inputBytes, java.io.OutputStream writer, boolean secureValidation)This method tries to canonicalize the given bytes.voidcanonicalizeSubtree(org.w3c.dom.Node node, java.io.OutputStream writer)Canonicalizes the subtree rooted bynode.voidcanonicalizeSubtree(org.w3c.dom.Node node, java.lang.String inclusiveNamespaces, boolean propagateDefaultNamespace, java.io.OutputStream writer)Canonicalizes the subtree rooted bynode.voidcanonicalizeSubtree(org.w3c.dom.Node node, java.lang.String inclusiveNamespaces, java.io.OutputStream writer)Canonicalizes the subtree rooted bynode.voidcanonicalizeXPathNodeSet(java.util.Set<org.w3c.dom.Node> xpathNodeSet, java.io.OutputStream writer)Canonicalizes an XPath node set.voidcanonicalizeXPathNodeSet(java.util.Set<org.w3c.dom.Node> xpathNodeSet, java.lang.String inclusiveNamespaces, java.io.OutputStream writer)Canonicalizes an XPath node set.static CanonicalizergetInstance(java.lang.String algorithmURI)Method getInstancestatic voidregister(java.lang.String algorithmURI, java.lang.Class<? extends CanonicalizerSpi> implementingClass)Method registerstatic voidregister(java.lang.String algorithmURI, java.lang.String implementingClass)Method registerstatic voidregisterDefaultAlgorithms()This method registers the default algorithms.
-
-
-
Field Detail
-
ENCODING
public static final java.lang.String ENCODING
The output encoding of canonicalized data
-
XPATH_C14N_WITH_COMMENTS_SINGLE_NODE
public static final java.lang.String XPATH_C14N_WITH_COMMENTS_SINGLE_NODE
XPath Expression for selecting every node and continuous comments joined in only one node- See Also:
- Constant Field Values
-
ALGO_ID_C14N_OMIT_COMMENTS
public static final java.lang.String ALGO_ID_C14N_OMIT_COMMENTS
The URL defined in XML-SEC Rec for inclusive c14n without comments.- See Also:
- Constant Field Values
-
ALGO_ID_C14N_WITH_COMMENTS
public static final java.lang.String ALGO_ID_C14N_WITH_COMMENTS
The URL defined in XML-SEC Rec for inclusive c14n with comments.- See Also:
- Constant Field Values
-
ALGO_ID_C14N_EXCL_OMIT_COMMENTS
public static final java.lang.String ALGO_ID_C14N_EXCL_OMIT_COMMENTS
The URL defined in XML-SEC Rec for exclusive c14n without comments.- See Also:
- Constant Field Values
-
ALGO_ID_C14N_EXCL_WITH_COMMENTS
public static final java.lang.String ALGO_ID_C14N_EXCL_WITH_COMMENTS
The URL defined in XML-SEC Rec for exclusive c14n with comments.- See Also:
- Constant Field Values
-
ALGO_ID_C14N11_OMIT_COMMENTS
public static final java.lang.String ALGO_ID_C14N11_OMIT_COMMENTS
The URI for inclusive c14n 1.1 without comments.- See Also:
- Constant Field Values
-
ALGO_ID_C14N11_WITH_COMMENTS
public static final java.lang.String ALGO_ID_C14N11_WITH_COMMENTS
The URI for inclusive c14n 1.1 with comments.- See Also:
- Constant Field Values
-
ALGO_ID_C14N_PHYSICAL
public static final java.lang.String ALGO_ID_C14N_PHYSICAL
Non-standard algorithm to serialize the physical representation for XML Encryption- See Also:
- Constant Field Values
-
canonicalizerHash
private static java.util.Map<java.lang.String,java.lang.Class<? extends CanonicalizerSpi>> canonicalizerHash
-
canonicalizerSpi
private final CanonicalizerSpi canonicalizerSpi
-
-
Constructor Detail
-
Canonicalizer
private Canonicalizer(java.lang.String algorithmURI) throws InvalidCanonicalizerExceptionConstructor Canonicalizer- Parameters:
algorithmURI-- Throws:
InvalidCanonicalizerException
-
-
Method Detail
-
getInstance
public static Canonicalizer getInstance(java.lang.String algorithmURI) throws InvalidCanonicalizerException
Method getInstance- Parameters:
algorithmURI-- Returns:
- a Canonicalizer instance ready for the job
- Throws:
InvalidCanonicalizerException
-
register
public static void register(java.lang.String algorithmURI, java.lang.String implementingClass) throws AlgorithmAlreadyRegisteredException, java.lang.ClassNotFoundExceptionMethod register- Parameters:
algorithmURI-implementingClass-- Throws:
AlgorithmAlreadyRegisteredExceptionjava.lang.SecurityException- if a security manager is installed and the caller does not have permission to register the canonicalizerjava.lang.ClassNotFoundException
-
register
public static void register(java.lang.String algorithmURI, java.lang.Class<? extends CanonicalizerSpi> implementingClass) throws AlgorithmAlreadyRegisteredException, java.lang.ClassNotFoundExceptionMethod register- Parameters:
algorithmURI-implementingClass-- Throws:
AlgorithmAlreadyRegisteredExceptionjava.lang.SecurityException- if a security manager is installed and the caller does not have permission to register the canonicalizerjava.lang.ClassNotFoundException
-
registerDefaultAlgorithms
public static void registerDefaultAlgorithms()
This method registers the default algorithms.
-
canonicalize
public void canonicalize(byte[] inputBytes, java.io.OutputStream writer, boolean secureValidation) throws XMLParserException, java.io.IOException, CanonicalizationExceptionThis method tries to canonicalize the given bytes. It's possible to even canonicalize non-wellformed sequences if they are well-formed after being wrapped with a>a<...>/a<.- Parameters:
inputBytes-writer- OutputStream to write the canonicalization resultsecureValidation- Whether secure validation is enabled- Throws:
CanonicalizationExceptionjava.io.IOExceptionXMLParserException
-
canonicalizeSubtree
public void canonicalizeSubtree(org.w3c.dom.Node node, java.io.OutputStream writer) throws CanonicalizationExceptionCanonicalizes the subtree rooted bynode.- Parameters:
node- The node to canonicalizewriter- OutputStream to write the canonicalization result- Throws:
CanonicalizationException
-
canonicalizeSubtree
public void canonicalizeSubtree(org.w3c.dom.Node node, java.lang.String inclusiveNamespaces, java.io.OutputStream writer) throws CanonicalizationExceptionCanonicalizes the subtree rooted bynode.- Parameters:
node-inclusiveNamespaces-writer- OutputStream to write the canonicalization result- Throws:
CanonicalizationException
-
canonicalizeSubtree
public void canonicalizeSubtree(org.w3c.dom.Node node, java.lang.String inclusiveNamespaces, boolean propagateDefaultNamespace, java.io.OutputStream writer) throws CanonicalizationExceptionCanonicalizes the subtree rooted bynode.- Parameters:
node-inclusiveNamespaces-writer- OutputStream to write the canonicalization result- Throws:
CanonicalizationException
-
canonicalizeXPathNodeSet
public void canonicalizeXPathNodeSet(java.util.Set<org.w3c.dom.Node> xpathNodeSet, java.io.OutputStream writer) throws CanonicalizationExceptionCanonicalizes an XPath node set.- Parameters:
xpathNodeSet-writer- OutputStream to write the canonicalization result- Throws:
CanonicalizationException
-
canonicalizeXPathNodeSet
public void canonicalizeXPathNodeSet(java.util.Set<org.w3c.dom.Node> xpathNodeSet, java.lang.String inclusiveNamespaces, java.io.OutputStream writer) throws CanonicalizationExceptionCanonicalizes an XPath node set.- Parameters:
xpathNodeSet-inclusiveNamespaces-writer- OutputStream to write the canonicalization result- Throws:
CanonicalizationException
-
-