|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.apache.xml.security.c14n.Canonicalizer
public class Canonicalizer
| Field Summary | |
|---|---|
static java.lang.String |
ALGO_ID_C14N_EXCL_OMIT_COMMENTS
The URL defined in XML-SEC Rec for exclusive c14n without comments. |
static java.lang.String |
ALGO_ID_C14N_EXCL_WITH_COMMENTS
The URL defined in XML-SEC Rec for exclusive c14n with comments. |
static java.lang.String |
ALGO_ID_C14N_OMIT_COMMENTS
The URL defined in XML-SEC Rec for inclusive c14n without comments. |
static java.lang.String |
ALGO_ID_C14N_PHYSICAL
Non-standard algorithm to serialize the physical representation for XML Encryption |
static java.lang.String |
ALGO_ID_C14N_WITH_COMMENTS
The URL defined in XML-SEC Rec for inclusive c14n with comments. |
static java.lang.String |
ALGO_ID_C14N11_OMIT_COMMENTS
The URI for inclusive c14n 1.1 without comments. |
static java.lang.String |
ALGO_ID_C14N11_WITH_COMMENTS
The URI for inclusive c14n 1.1 with comments. |
static java.lang.String |
ENCODING
The output encoding of canonicalized data |
static java.lang.String |
XPATH_C14N_WITH_COMMENTS_SINGLE_NODE
XPath Expression for selecting every node and continuous comments joined in only one node |
| Method Summary | |
|---|---|
byte[] |
canonicalize(byte[] inputBytes)
This method tries to canonicalize the given bytes. |
byte[] |
canonicalizeSubtree(org.w3c.dom.Node node)
Canonicalizes the subtree rooted by node. |
byte[] |
canonicalizeSubtree(org.w3c.dom.Node node,
java.lang.String inclusiveNamespaces)
Canonicalizes the subtree rooted by node. |
byte[] |
canonicalizeXPathNodeSet(org.w3c.dom.NodeList xpathNodeSet)
Canonicalizes an XPath node set. |
byte[] |
canonicalizeXPathNodeSet(org.w3c.dom.NodeList xpathNodeSet,
java.lang.String inclusiveNamespaces)
Canonicalizes an XPath node set. |
byte[] |
canonicalizeXPathNodeSet(java.util.Set<org.w3c.dom.Node> xpathNodeSet)
Canonicalizes an XPath node set. |
byte[] |
canonicalizeXPathNodeSet(java.util.Set<org.w3c.dom.Node> xpathNodeSet,
java.lang.String inclusiveNamespaces)
Canonicalizes an XPath node set. |
java.lang.String |
getImplementingCanonicalizerClass()
Returns the name of the implementing CanonicalizerSpi class |
boolean |
getIncludeComments()
Method getIncludeComments |
static Canonicalizer |
getInstance(java.lang.String algorithmURI)
Method getInstance |
java.lang.String |
getURI()
Method getURI |
boolean |
isSecureValidation()
|
void |
notReset()
Set the canonicalizer behaviour to not reset. |
static void |
register(java.lang.String algorithmURI,
java.lang.Class<CanonicalizerSpi> implementingClass)
Method register |
static void |
register(java.lang.String algorithmURI,
java.lang.String implementingClass)
Method register |
static void |
registerDefaultAlgorithms()
This method registers the default algorithms. |
void |
setSecureValidation(boolean secureValidation)
|
void |
setWriter(java.io.OutputStream os)
Sets the writer where the canonicalization ends. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
public static final java.lang.String ENCODING
public static final java.lang.String XPATH_C14N_WITH_COMMENTS_SINGLE_NODE
public static final java.lang.String ALGO_ID_C14N_OMIT_COMMENTS
public static final java.lang.String ALGO_ID_C14N_WITH_COMMENTS
public static final java.lang.String ALGO_ID_C14N_EXCL_OMIT_COMMENTS
public static final java.lang.String ALGO_ID_C14N_EXCL_WITH_COMMENTS
public static final java.lang.String ALGO_ID_C14N11_OMIT_COMMENTS
public static final java.lang.String ALGO_ID_C14N11_WITH_COMMENTS
public static final java.lang.String ALGO_ID_C14N_PHYSICAL
| Method Detail |
|---|
public static final Canonicalizer getInstance(java.lang.String algorithmURI)
throws InvalidCanonicalizerException
algorithmURI -
InvalidCanonicalizerException
public static void register(java.lang.String algorithmURI,
java.lang.String implementingClass)
throws AlgorithmAlreadyRegisteredException,
java.lang.ClassNotFoundException
algorithmURI - implementingClass -
AlgorithmAlreadyRegisteredException
java.lang.ClassNotFoundException
public static void register(java.lang.String algorithmURI,
java.lang.Class<CanonicalizerSpi> implementingClass)
throws AlgorithmAlreadyRegisteredException,
java.lang.ClassNotFoundException
algorithmURI - implementingClass -
AlgorithmAlreadyRegisteredException
java.lang.ClassNotFoundExceptionpublic static void registerDefaultAlgorithms()
public final java.lang.String getURI()
public boolean getIncludeComments()
public byte[] canonicalize(byte[] inputBytes)
throws javax.xml.parsers.ParserConfigurationException,
java.io.IOException,
org.xml.sax.SAXException,
CanonicalizationException
>a<...>/a<.
inputBytes -
CanonicalizationException
java.io.IOException
javax.xml.parsers.ParserConfigurationException
org.xml.sax.SAXException
public byte[] canonicalizeSubtree(org.w3c.dom.Node node)
throws CanonicalizationException
node.
node - The node to canonicalize
CanonicalizationException
public byte[] canonicalizeSubtree(org.w3c.dom.Node node,
java.lang.String inclusiveNamespaces)
throws CanonicalizationException
node.
node - inclusiveNamespaces -
CanonicalizationException
public byte[] canonicalizeXPathNodeSet(org.w3c.dom.NodeList xpathNodeSet)
throws CanonicalizationException
xpathNodeSet is treated
as a list of XPath nodes, not as a list of subtrees.
xpathNodeSet -
CanonicalizationException
public byte[] canonicalizeXPathNodeSet(org.w3c.dom.NodeList xpathNodeSet,
java.lang.String inclusiveNamespaces)
throws CanonicalizationException
xpathNodeSet is treated
as a list of XPath nodes, not as a list of subtrees.
xpathNodeSet - inclusiveNamespaces -
CanonicalizationException
public byte[] canonicalizeXPathNodeSet(java.util.Set<org.w3c.dom.Node> xpathNodeSet)
throws CanonicalizationException
xpathNodeSet -
CanonicalizationException
public byte[] canonicalizeXPathNodeSet(java.util.Set<org.w3c.dom.Node> xpathNodeSet,
java.lang.String inclusiveNamespaces)
throws CanonicalizationException
xpathNodeSet - inclusiveNamespaces -
CanonicalizationExceptionpublic void setWriter(java.io.OutputStream os)
os - public java.lang.String getImplementingCanonicalizerClass()
CanonicalizerSpi class
CanonicalizerSpi classpublic void notReset()
public boolean isSecureValidation()
public void setSecureValidation(boolean secureValidation)
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||