iaik.ixsil.util

Class DOMUtils

java.lang.Object

iaik.ixsil.util.DOMUtils

public class DOMUtils
extends java.lang.Object

Encapsulates all utility methods regarding DOM manipulation. The actual computation is delegated to a class implementing the DOMUtilsInterface. Which class is to be used by IXSIL, must be specified by an IXSIL init property.

Field Summary

Fields

Modifier and Type	Field and Description
protected static DOMUtilsInterface	implementation Reference to the actual implementation of the DOM utility methods.
static int	VALIDATION_DYNAMIC_ Indicates that the DOM parser should validate the document if it finds hint in the XML source about the underlying grammar.
static int	VALIDATION_NO_ Indicates that the DOM parser must not validate the document.
static int	VALIDATION_YES_ Indicates that the DOM parser must validate the document.

Constructor Summary

Constructors

Constructor and Description
DOMUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	checkExpandedElementName(org.w3c.dom.Element element, java.lang.String namespaceURI, java.lang.String localName)
static org.w3c.dom.Document	createDocumentFromScratch()
static org.w3c.dom.Document	createDocumentFromXMLInstance(java.io.InputStream xmlDocStream, URI xmlDocBaseURI, int validate, java.lang.String noNamespaceSchemaLocation, java.lang.String schemaLocations)
static java.lang.String	getCharacterData(org.w3c.dom.Element parent)
static org.w3c.dom.Element	getChildElementByTagNameNS(org.w3c.dom.Element parent, java.lang.String namespaceURI, java.lang.String localName, int instance)
static org.w3c.dom.traversal.DocumentTraversal	getDocumentTraversal(org.w3c.dom.Document doc)
protected static void	instantiateImplClass() Instantiates the class specified by the IXSIL init property named DOMUtils.ImplementingClass, which will be used to perform the actual computing of the DOM utility methods.
static org.w3c.dom.NodeList	listToNodeList(java.util.List list)
static void	registerID(org.w3c.dom.Document owningDoc, org.w3c.dom.Element candidate, java.lang.String idValue)
static void	replaceSignatureElement(org.w3c.dom.Element oldSigElem, org.w3c.dom.Element newSigElem)
static org.w3c.dom.Element	schemaValidateSignatureElement(org.w3c.dom.Element signatureDOMElem, java.lang.String additionalNoNamespaceSchemaLocation, java.lang.String additionalSchemaLocations)
static void	serializeDocument(org.w3c.dom.Document doc, java.io.OutputStream documentSurface)
static void	serializeDocument(org.w3c.dom.Document doc, java.io.OutputStream documentSurface, java.lang.String encoding)
static void	serializeElement(org.w3c.dom.Element elem, java.io.OutputStream elementSurface)
static void	setAttribute(org.w3c.dom.Element element, java.lang.String namespaceURI, java.lang.String namespacePrefix, java.lang.String localName, java.lang.String value)
static void	unregisterID(org.w3c.dom.Document owningDoc, java.lang.String idValue)

Methods inherited from class java.lang.Object

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

Field Detail

VALIDATION_YES_

public static final int VALIDATION_YES_

Indicates that the DOM parser must validate the document.

See Also:

Constant Field Values

VALIDATION_NO_

public static final int VALIDATION_NO_

Indicates that the DOM parser must not validate the document.

See Also:

Constant Field Values

VALIDATION_DYNAMIC_

public static final int VALIDATION_DYNAMIC_

Indicates that the DOM parser should validate the document if it finds hint in the XML source about the underlying grammar.

See Also:

Constant Field Values

implementation

protected static DOMUtilsInterface implementation

Reference to the actual implementation of the DOM utility methods.

Constructor Detail

DOMUtils

public DOMUtils()

Method Detail

schemaValidateSignatureElement

public static org.w3c.dom.Element schemaValidateSignatureElement(org.w3c.dom.Element signatureDOMElem,
                                                 java.lang.String additionalNoNamespaceSchemaLocation,
                                                 java.lang.String additionalSchemaLocations)
                                                          throws DOMUtilsException

Throws:

DOMUtilsException

See Also:

DOMUtilsInterface.schemaValidateSignatureElement(org.w3c.dom.Element, java.lang.String, java.lang.String)

replaceSignatureElement

public static void replaceSignatureElement(org.w3c.dom.Element oldSigElem,
                           org.w3c.dom.Element newSigElem)
                                    throws DOMUtilsException

Throws:

DOMUtilsException

See Also:

DOMUtilsInterface.replaceSignatureElement(org.w3c.dom.Element, org.w3c.dom.Element)

createDocumentFromXMLInstance

public static org.w3c.dom.Document createDocumentFromXMLInstance(java.io.InputStream xmlDocStream,
                                                 URI xmlDocBaseURI,
                                                 int validate,
                                                 java.lang.String noNamespaceSchemaLocation,
                                                 java.lang.String schemaLocations)
                                                          throws DOMUtilsException

Throws:

DOMUtilsException

See Also:

DOMUtilsInterface.createDocumentFromXMLInstance(java.io.InputStream, iaik.ixsil.util.URI, int, java.lang.String, java.lang.String)

createDocumentFromScratch

public static org.w3c.dom.Document createDocumentFromScratch()

See Also:

DOMUtilsInterface.createDocumentFromScratch()

getDocumentTraversal

public static org.w3c.dom.traversal.DocumentTraversal getDocumentTraversal(org.w3c.dom.Document doc)

See Also:

DOMUtilsInterface.getDocumentTraversal(org.w3c.dom.Document)

getChildElementByTagNameNS

public static org.w3c.dom.Element getChildElementByTagNameNS(org.w3c.dom.Element parent,
                                             java.lang.String namespaceURI,
                                             java.lang.String localName,
                                             int instance)

See Also:

DOMUtilsInterface.getChildElementByTagNameNS(org.w3c.dom.Element, java.lang.String, java.lang.String, int)

getCharacterData

public static java.lang.String getCharacterData(org.w3c.dom.Element parent)

See Also:

DOMUtilsInterface.getCharacterData(org.w3c.dom.Element)

checkExpandedElementName

public static boolean checkExpandedElementName(org.w3c.dom.Element element,
                               java.lang.String namespaceURI,
                               java.lang.String localName)

setAttribute

public static void setAttribute(org.w3c.dom.Element element,
                java.lang.String namespaceURI,
                java.lang.String namespacePrefix,
                java.lang.String localName,
                java.lang.String value)

See Also:

DOMUtilsInterface.setAttribute(org.w3c.dom.Element, java.lang.String, java.lang.String, java.lang.String, java.lang.String)

listToNodeList

public static org.w3c.dom.NodeList listToNodeList(java.util.List list)

See Also:

DOMUtilsInterface.listToNodeList(java.util.List)

registerID

public static void registerID(org.w3c.dom.Document owningDoc,
              org.w3c.dom.Element candidate,
              java.lang.String idValue)
                       throws DOMUtilsException

Throws:

DOMUtilsException

See Also:

DOMUtilsInterface.registerID(org.w3c.dom.Document, org.w3c.dom.Element, java.lang.String)

unregisterID

public static void unregisterID(org.w3c.dom.Document owningDoc,
                java.lang.String idValue)
                         throws DOMUtilsException

Throws:

DOMUtilsException

See Also:

DOMUtilsInterface.unregisterID(org.w3c.dom.Document, java.lang.String)

serializeDocument

public static void serializeDocument(org.w3c.dom.Document doc,
                     java.io.OutputStream documentSurface)
                              throws DOMUtilsException

Throws:

DOMUtilsException

Since:

Entrust 7.0

See Also:

DOMUtilsInterface.serializeDocument(org.w3c.dom.Document, java.io.OutputStream)

serializeDocument

public static void serializeDocument(org.w3c.dom.Document doc,
                     java.io.OutputStream documentSurface,
                     java.lang.String encoding)
                              throws DOMUtilsException

Throws:

DOMUtilsException

Since:

Entrust 7.0

See Also:

DOMUtilsInterface.serializeDocument(org.w3c.dom.Document, java.io.OutputStream)

serializeElement

public static void serializeElement(org.w3c.dom.Element elem,
                    java.io.OutputStream elementSurface)
                             throws DOMUtilsException

Throws:

DOMUtilsException

Since:

Entrust 7.0

See Also:

DOMUtilsInterface.serializeElement(org.w3c.dom.Element, java.io.OutputStream)

instantiateImplClass

protected static void instantiateImplClass()

Instantiates the class specified by the IXSIL init property named DOMUtils.ImplementingClass, which will be used to perform the actual computing of the DOM utility methods.