DOMUtilsImplBase ("Entrust Authority Security Toolkit for the Java Platform")

java.lang.Object
- com.entrust.toolkit.xml.util.DOMUtilsImplBase

All Implemented Interfaces:

DOMUtilsInterface

Direct Known Subclasses:

DOMUtilsImplApache
```
public abstract class DOMUtilsImplBase
extends java.lang.Object
implements DOMUtilsInterface
```
DOMUtilsImplBase is the abstract base class for Toolkit classes that support the DOMUtilsInterface through the JAXP API. The DOMUtilsImplBase superclass implements the methods from DOMUtilsInterface that are not specific to any particular JAXP library. Other methods in the DOMUtilsInterface might need to set particular parser attributes or invoke parser methods specific to a particular JAXP implementation or outside of JAXP. For example, Apache parsers require that ID attributes be "registered". Those methods are declared abstract in this DOMUtilsImplBase superclass, and they must be implemented by a parser-specific subclass.
DOMUtilsImplBase also provides an inner class that is an ErrorHandler.
Note

The Toolkit uses this class internally, but your application should not invoke its methods directly. Instead, invoke methods in the class iaik.ixsil.util.DOMUtils. Internally, the Toolkit finds an implementation based on the Java property DOMUtils.ImplementingClass in the init.properties file.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected class DOMUtilsImplBase.NodeListImpl
Simple implementation for the DOM NodeList interface.

Nested Classes
Modifier and Type	Class and Description
`protected class`	`DOMUtilsImplBase.NodeListImpl` Simple implementation for the DOM `NodeList` interface.

Constructor Summary

Constructors
Constructor and Description

DOMUtilsImplBase()

Constructors
Constructor and Description
`DOMUtilsImplBase()`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`checkExpandedElementName(org.w3c.dom.Element element, java.lang.String namespaceURI, java.lang.String localName)` Checks if the expanded name of the specified element corresponds with the specified namespace URI and local name.
`abstract org.w3c.dom.Document`	`createDocumentFromScratch()` Creates a new, empty DOM document.
`abstract org.w3c.dom.Document`	`createDocumentFromXMLInstance(java.io.InputStream xmlDocStream, URI xmlDocBaseURI, int validate, java.lang.String noNamespaceSchemaLocation, java.lang.String schemaLocations)` The DOM parser is configured not to report any Warnings, Errors or FatalErrors.
`org.w3c.dom.Element`	`getChildElementByTagNameNS(org.w3c.dom.Element parent, java.lang.String namespaceURI, java.lang.String localName, int instance)` Returns the child element of the specified parent element, which matches the specified namespace URI and the specified local name.
`abstract org.w3c.dom.traversal.DocumentTraversal`	`getDocumentTraversal(org.w3c.dom.Document doc)` Gets a DOM level 2 `DocumentTraversal` interface, which allows the creation of DOM level 2 `NodeIterator` and `TreeWalker` interfaces, for the specified DOM document.
`protected java.lang.String`	`getNamespaceOfElement(org.w3c.dom.Element element)` Gets the namespace URI which is in scope for the specified element.
`org.w3c.dom.NodeList`	`listToNodeList(java.util.List list)` Converts a `List` object into a `NodeList` object.
`abstract void`	`registerID(org.w3c.dom.Document owningDoc, org.w3c.dom.Element candidate, java.lang.String idValue)` Registers a candidate DOM element with the value of its ID attribute at its owning DOM document.
`abstract void`	`replaceSignatureElement(org.w3c.dom.Element oldSigElem, org.w3c.dom.Element newSigElem)` Replaces an old signature element, which is part of document A, with a new signature element, which is part of document B.
`abstract org.w3c.dom.Element`	`schemaValidateSignatureElement(org.w3c.dom.Element signatureDOMElem, java.lang.String additionalNoNamespaceSchemaLocation, java.lang.String additionalSchemaLocations)` Validates a specified DOM element representing a XML signature against the signature schema specified in the IXSIL init properties.
`void`	`serializeDocument(org.w3c.dom.Document doc, java.io.OutputStream os)` Serializes the specified DOM document to the specified output stream.
`void`	`serializeDocument(org.w3c.dom.Document doc, java.io.OutputStream os, java.lang.String encoding)` Serializes the specified DOM Document to the specified output stream.
`void`	`serializeElement(org.w3c.dom.Element elem, java.io.OutputStream elementSurface)` Serializes the specified DOM element to the specified output stream.
`void`	`setAttribute(org.w3c.dom.Element element, java.lang.String namespaceURI, java.lang.String namespacePrefix, java.lang.String localName, java.lang.String value)` Creates a DOM attribute from the specified parameters and adds it to the specified DOM element.
`abstract void`	`unregisterID(org.w3c.dom.Document owningDoc, java.lang.String idValue)` Unregisters a candidate DOM element, which has been registerred with method `DOMUtilsInterface.registerID(org.w3c.dom.Document, org.w3c.dom.Element, java.lang.String)` before, at its owning DOM document.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface iaik.ixsil.util.DOMUtilsInterface
getCharacterData

- Constructor Detail
  - DOMUtilsImplBase
```
public DOMUtilsImplBase()
```
- Method Detail
  - registerID
```
public abstract void registerID(org.w3c.dom.Document owningDoc,
              org.w3c.dom.Element candidate,
              java.lang.String idValue)
                         throws DOMUtilsException
```
    Description copied from interface: DOMUtilsInterface
    
    Registers a candidate DOM element with the value of its ID attribute at its owning DOM document. After this registration, the DOM element can be queried at its owning DOM document using the DOM interface method Document.getElementById(java.lang.String). If a DOM element is already registerred under the specified ID value, this method will have no effect.
    
    Specified by:
    
    registerID in interface DOMUtilsInterface
    
    Parameters:
    owningDoc - The DOM document which owns the candidate DOM element. Must not be null.
    candidate - The candidate DOM element to be registerred. Must not be null.
    idValue - The value of the candidate's ID attribute. Must not be null.
    
    Throws:
    
    DOMUtilsException - if registration fails for any reason.
    See Also:
    DOMUtilsInterface.registerID(org.w3c.dom.Document, org.w3c.dom.Element, java.lang.String)
  - unregisterID
```
public abstract void unregisterID(org.w3c.dom.Document owningDoc,
                java.lang.String idValue)
                           throws DOMUtilsException
```
    Description copied from interface: DOMUtilsInterface
    
    Unregisters a candidate DOM element, which has been registerred with method DOMUtilsInterface.registerID(org.w3c.dom.Document, org.w3c.dom.Element, java.lang.String) before, at its owning DOM document. If no DOM element is registerred under the specified ID value at the DOM document, this method will have no effect.
    
    Specified by:
    
    unregisterID in interface DOMUtilsInterface
    
    Parameters:
    owningDoc - The DOM document which owns the candidate DOM element. Must not be null.
    idValue - The value of the candidate's ID attribute. Must not be null.
    
    Throws:
    
    DOMUtilsException - if undoing the registration fails for any reason.
    See Also:
    DOMUtilsInterface.unregisterID(org.w3c.dom.Document, java.lang.String)
  - schemaValidateSignatureElement
```
public abstract org.w3c.dom.Element schemaValidateSignatureElement(org.w3c.dom.Element signatureDOMElem,
                                                 java.lang.String additionalNoNamespaceSchemaLocation,
                                                 java.lang.String additionalSchemaLocations)
                                                            throws DOMUtilsException
```
    Description copied from interface: DOMUtilsInterface
    
    Validates a specified DOM element representing a XML signature against the signature schema specified in the IXSIL init properties.
    Specified by:
    
    schemaValidateSignatureElement in interface DOMUtilsInterface
    
    Parameters:
    signatureDOMElem - The signature DOM element to be schema validated. Must not be null.
    additionalNoNamespaceSchemaLocation - Provides an additional schema apart from the XMLDSIG schema for elements in the no-namespace. Such a schema can be pro- vided for the content of Object or SignatureProperty elements. The parameter contains the location URI for such a schema. May be null.
    additionalSchemaLocations - Provides additional schemas apart from the XMLDSIG schema to be used for validation. Such schemas can be provided for the content of Object or SignatureProperty elements. Must either be null or conform to the following rules:
    additionalSchemas ::= additionalSchema (space additionalSchema)* additionalSchema ::= schemaNamespaceURI space schemaLocationURI
    For example, "http://foo.org/mySchema http://repository.foo.org/mySchema.xsd".
    Returns:
    the validated signature DOM element. If this element or descending elements have ID attributes, the returned element's implementation must provide marks for such special elements. The marks are evaluated by other methods of this interface!
    
    Throws:
    
    DOMUtilsException - if the validation fails for some reason.
    See Also:
    DOMUtilsInterface.schemaValidateSignatureElement(org.w3c.dom.Element, java.lang.String, java.lang.String)
  - replaceSignatureElement
```
public abstract void replaceSignatureElement(org.w3c.dom.Element oldSigElem,
                           org.w3c.dom.Element newSigElem)
                                      throws DOMUtilsException
```
    Description copied from interface: DOMUtilsInterface
    
    Replaces an old signature element, which is part of document A, with a new signature element, which is part of document B. The method must also take into account marks made by the underlying document implementation, regarding elements of the document, which have an ID attribute declared.
    
    Specified by:
    
    replaceSignatureElement in interface DOMUtilsInterface
    
    Parameters:
    oldSigElem - The old Signature DOM element which should be replaced. Must not be null.
    newSigElem - The new Signature DOM element which should replace the old one. Must not be null.
    
    Throws:
    
    DOMUtilsException - if the transfer fails for some reason.
    See Also:
    DOMUtilsInterface.replaceSignatureElement(org.w3c.dom.Element, org.w3c.dom.Element)
  - createDocumentFromScratch
```
public abstract org.w3c.dom.Document createDocumentFromScratch()
```
    Description copied from interface: DOMUtilsInterface
    
    Creates a new, empty DOM document.
    
    Specified by:
    
    createDocumentFromScratch in interface DOMUtilsInterface
    
    Returns:
    the new, empty DOM document.
    See Also:
    DOMUtilsInterface.createDocumentFromScratch()
  - getDocumentTraversal
```
public abstract org.w3c.dom.traversal.DocumentTraversal getDocumentTraversal(org.w3c.dom.Document doc)
```
    Description copied from interface: DOMUtilsInterface
    
    Gets a DOM level 2 DocumentTraversal interface, which allows the creation of DOM level 2 NodeIterator and TreeWalker interfaces, for the specified DOM document.
    
    Specified by:
    
    getDocumentTraversal in interface DOMUtilsInterface
    
    Parameters:
    doc - The DOM document, for which a DocumentTraversal should be returned.
    
    Returns:
    a DocumentTraversal interface for the specified DOM document.
    See Also:
    DOMUtilsInterface.getDocumentTraversal(org.w3c.dom.Document)
  - createDocumentFromXMLInstance
```
public abstract org.w3c.dom.Document createDocumentFromXMLInstance(java.io.InputStream xmlDocStream,
                                                 URI xmlDocBaseURI,
                                                 int validate,
                                                 java.lang.String noNamespaceSchemaLocation,
                                                 java.lang.String schemaLocations)
                                                            throws DOMUtilsException
```
    The DOM parser is configured not to report any Warnings, Errors or FatalErrors. An instance of the class DOMUtilsErrorHandler is registered at the parser. This error handler treats Warnings, Errors and FatalErrors as specified by corresponding IXSIL properties.
    Specified by:
    
    createDocumentFromXMLInstance in interface DOMUtilsInterface
    
    Parameters:
    xmlDocStream - The stream representation of the XML document.
    xmlDocBaseURI - Holds the base URI for the XML document used to resolve relative URIs.
    validate - Determines wheter the document should be validated or not. Please see the constants DOMUtils.VALIDATION_YES_, DOMUtils.VALIDATION_NO_, DOMUtils.VALIDATION_DYNAMIC_ for further information.
    noNamespaceSchemaLocation - This URI string can be used to provide a Schema for the no-namespace in cases where the DOM document should be created by a validating parser (see also parameter validate). May be null . Valid example: "http://repository.foo.org/mySchema.xsd".
    schemaLocations - This parameter can be used to provide schemas for various namespaces in cases where the DOM document should be created by a validating parser (see also parameter validate). Must either be null or conform to the following rules: additionalSchemas ::= additionalSchema (space additionalSchema)* additionalSchema ::= schemaNamespaceURI space schemaLocationURI For example, "http://foo.org/mySchema http://repository.foo.org/mySchema.xsd".
    Returns: the created DOM document. Throws: DOMUtilsException - if creating the DOM document failed for any reason. See Also: DOMUtilsInterface.createDocumentFromXMLInstance(java.io.InputStream, iaik.ixsil.util.URI, int, java.lang.String, java.lang.String)
  serializeDocument public void serializeDocument(org.w3c.dom.Document doc, java.io.OutputStream os) throws DOMUtilsException Serializes the specified DOM document to the specified output stream. Uses XSLT to perform the transformation. The document is printed as-is, i. e. no pretty printing will be done. Character encoding will be set to UTF-8. Specified by: serializeDocument in interface DOMUtilsInterface Parameters: doc - The DOM Document to be serialized. Must not be null. os - The output stream where the serialization result is printed. Must not be null. Throws: DOMUtilsException serializeDocument public void serializeDocument(org.w3c.dom.Document doc, java.io.OutputStream os, java.lang.String encoding) throws DOMUtilsException Serializes the specified DOM Document to the specified output stream. Uses XSLT to perform the transformation. A property is set in the XSLT Transformer object, so it should use the specified character encoding. If the Transformer does not support the encoding on a particular platform, a warning is written and the document is encoded into UTF-8. Specified by: serializeDocument in interface DOMUtilsInterface Parameters: doc - The DOM document to be serialized. Must not be null. os - An output stream where the serialization result is printed. Must not be null. encoding - The character encoding string that will be set in the XML declaration. Must not be null. Throws: DOMUtilsException serializeElement public void serializeElement(org.w3c.dom.Element elem, java.io.OutputStream elementSurface) throws DOMUtilsException Serializes the specified DOM element to the specified output stream. The element is printed as-is, i. e. no pretty printing will be done. Specified by: serializeElement in interface DOMUtilsInterface Parameters: elem - The DOM element to be serialized. Must not be null. elementSurface - The output stream where the serialization result is printed to. Must not be null. Throws: DOMUtilsException getChildElementByTagNameNS public org.w3c.dom.Element getChildElementByTagNameNS(org.w3c.dom.Element parent, java.lang.String namespaceURI, java.lang.String localName, int instance) Description copied from interface: DOMUtilsInterface Returns the child element of the specified parent element, which matches the specified namespace URI and the specified local name. Specified by: getChildElementByTagNameNS in interface DOMUtilsInterface Parameters: parent - The parent element bearing the requested child element. Must not be null. namespaceURI - The namespace URI of the requested child element. May be null to indicate that the attribute should be in no namespace. localName - The local name of the requested child element. Must not be null. instance - A value of i will return the (i)th occurence of the requested element in the parent element. Must be greater than or equal to 1. Returns: The requested child element, or null if there is no such child element. See Also: DOMUtilsInterface.getChildElementByTagNameNS(Element, String, String, int) checkExpandedElementName public boolean checkExpandedElementName(org.w3c.dom.Element element, java.lang.String namespaceURI, java.lang.String localName) Description copied from interface: DOMUtilsInterface Checks if the expanded name of the specified element corresponds with the specified namespace URI and local name. Specified by: checkExpandedElementName in interface DOMUtilsInterface Parameters: element - The candidate element. Must not be null. namespaceURI - The namespace URI part of the expanded name. May be null if the candidate element should be in no namespace. localName - The local name part of the expanded name. Must not be null. Returns: true, if the expanded name of the specified element corresponds with the specified namespace URI and local name; false otherwise. See Also: DOMUtilsInterface.checkExpandedElementName(Element, String, String) setAttribute public void setAttribute(org.w3c.dom.Element element, java.lang.String namespaceURI, java.lang.String namespacePrefix, java.lang.String localName, java.lang.String value) Description copied from interface: DOMUtilsInterface Creates a DOM attribute from the specified parameters and adds it to the specified DOM element. If such a DOM attribute already exists, its value will be overwritten. If the value parameter equals null, the possibly existing DOM attribute will be removed from the DOM element. Specified by: setAttribute in interface DOMUtilsInterface Parameters: element - The DOM element, which will become the owner of the new DOM attribute. Must not be null. namespaceURI - The namespace URI for the attribute. May be null to indicate that the attribute should be in no namespace. namespacePrefix - The namespace prefix for the attribute (including the final colon). Must not be null. Use an empty string to indicate that no namespace prefix should be used. localName - The local name for the attribute. Must not be null. value - The value for the attribute. May be null to indicate that the specified DOM attribute should be removed from the specified DOM element. See Also: DOMUtilsInterface.setAttribute(Element, String, String, String, String) listToNodeList public org.w3c.dom.NodeList listToNodeList(java.util.List list) Description copied from interface: DOMUtilsInterface Converts a List object into a NodeList object. Specified by: listToNodeList in interface DOMUtilsInterface Parameters: list - A List object constisting purely of Node objects. Returns: a NodeList containing the specified nodes as member, or an empty NodeList if the specified List equals null. See Also: DOMUtilsInterface.listToNodeList(java.util.List) getNamespaceOfElement protected java.lang.String getNamespaceOfElement(org.w3c.dom.Element element) Gets the namespace URI which is in scope for the specified element. Parameters: element - The element for which the namespace URI should be detected. Must not be null . Returns: the namespace URI, or null, if no namespace attribute has been found, or if a namespace attribute has been found, but its value is an empty string.

Class DOMUtilsImplBase

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface iaik.ixsil.util.DOMUtilsInterface

Constructor Detail

DOMUtilsImplBase

Method Detail

registerID

unregisterID

schemaValidateSignatureElement

replaceSignatureElement

createDocumentFromScratch

getDocumentTraversal

createDocumentFromXMLInstance

serializeDocument

serializeDocument

serializeElement

getChildElementByTagNameNS

checkExpandedElementName

setAttribute

listToNodeList

getNamespaceOfElement