oracle.jdeveloper.deploy.common

Class DescriptorIO

java.lang.Object

oracle.jdeveloper.deploy.common.DescriptorIO

public abstract class DescriptorIO
extends java.lang.Object

A concrete instance of DescriptorIO manages the operations required to create, load, and persist an instance of an XML deployment descriptor. Each concrete subclass of DescriptorIO is intended to support a single version of a particular deployment descriptor.

Methods that take a descriptor object require that the descriptor object be of the correct type. Methods that return a descriptor object will return an object that can be cast to the descriptor object type.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DescriptorIO(java.lang.Class descriptorClass, java.lang.String rootElem, java.lang.String publicID, java.lang.String systemID)

Method Summary

Methods

Modifier and Type	Method and Description
void	checkDescriptorClass(java.lang.Object descriptor) Runtime type checking.
protected int	compareVersions(java.lang.String systemID1, java.lang.String systemID2) Compares two system ID version strings.
java.lang.Class	getDescriptorClass() Returns the class of the descriptor type that is managed by the DescriptorIO implementation.
protected abstract java.lang.String	getMinimumRequiredVersion(java.lang.Object descriptor) Correct subclass implementation is required to guarantee proper behavior for multi-version support.
java.lang.String	getPublicID() Returns the XML public ID of the descriptor.
java.lang.String	getRootElement() Returns the XML root element name of the descriptor.
java.lang.String	getSystemID() Returns the XML system ID of the descriptor.
oracle.xml.parser.v2.XMLDocument	getXMLDocument(java.lang.Object descriptor)
oracle.xml.parser.v2.XMLDocument	getXMLDocument(java.lang.Object descriptor, java.lang.String encoding)
java.lang.Object	load(java.io.Reader reader)
java.lang.Object	load(java.io.Reader reader, oracle.xml.parser.v2.DTD dtd, int reportLevel, Object2DomLogger logger)
java.lang.Object	load(java.net.URL url)
protected oracle.xml.parser.v2.XMLDocument	loadXml(java.net.URL url)
protected abstract int	mapVersionToInt(java.lang.String systemID) Maps a version string to an integer to simplify the algorithm for comparing version strings.
void	maybeUpdateDoctype(oracle.xml.parser.v2.XMLDocument doc, java.lang.Object descriptor) Checks whether the doctype declaration of the XMLDocument is appropriate for the descriptor object.
protected abstract DescriptorIO	newDescriptorIO(java.lang.String systemID) Correct subclass implementation is required to guarantee proper behavior for multi-version support.
void	save(java.lang.Object descriptor, java.io.PrintWriter printWriter)
void	save(java.lang.Object descriptor, java.net.URL url)
void	saveWithXMLDiff(java.lang.Object descriptor, java.net.URL url)
void	setDoctype(oracle.xml.parser.v2.XMLDocument xmlDocument)
java.lang.String	toString(java.lang.Object descriptor)

Methods inherited from class java.lang.Object

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

Constructor Detail

DescriptorIO

protected DescriptorIO(java.lang.Class descriptorClass,
            java.lang.String rootElem,
            java.lang.String publicID,
            java.lang.String systemID)

Method Detail

getDescriptorClass

public java.lang.Class getDescriptorClass()

Returns the class of the descriptor type that is managed by the DescriptorIO implementation.

getRootElement

public java.lang.String getRootElement()

Returns the XML root element name of the descriptor.

getPublicID

public java.lang.String getPublicID()

Returns the XML public ID of the descriptor.

getSystemID

public java.lang.String getSystemID()

Returns the XML system ID of the descriptor.

save

public void save(java.lang.Object descriptor,
        java.net.URL url)
          throws java.io.IOException

Throws:

java.io.IOException

saveWithXMLDiff

public void saveWithXMLDiff(java.lang.Object descriptor,
                   java.net.URL url)
                     throws java.io.IOException

Throws:

java.io.IOException

save

public void save(java.lang.Object descriptor,
        java.io.PrintWriter printWriter)
          throws java.io.IOException

Throws:

java.io.IOException

toString

public java.lang.String toString(java.lang.Object descriptor)

load

public java.lang.Object load(java.net.URL url)
                      throws java.io.IOException

Throws:

java.io.IOException

load

public java.lang.Object load(java.io.Reader reader)
                      throws java.io.IOException

Throws:

java.io.IOException

load

public java.lang.Object load(java.io.Reader reader,
                    oracle.xml.parser.v2.DTD dtd,
                    int reportLevel,
                    Object2DomLogger logger)
                      throws java.io.IOException

Throws:

java.io.IOException

getXMLDocument

public oracle.xml.parser.v2.XMLDocument getXMLDocument(java.lang.Object descriptor)

Throws:

java.lang.NullPointerException - if the specified descriptor is null.

getXMLDocument

public oracle.xml.parser.v2.XMLDocument getXMLDocument(java.lang.Object descriptor,
                                              java.lang.String encoding)

setDoctype

public void setDoctype(oracle.xml.parser.v2.XMLDocument xmlDocument)

checkDescriptorClass

public void checkDescriptorClass(java.lang.Object descriptor)
                          throws java.lang.IllegalArgumentException

Runtime type checking.

Throws:

java.lang.IllegalArgumentException - if the specified descriptor object is of the wrong type or is null.

maybeUpdateDoctype

public void maybeUpdateDoctype(oracle.xml.parser.v2.XMLDocument doc,
                      java.lang.Object descriptor)

Checks whether the doctype declaration of the XMLDocument is appropriate for the descriptor object. This check is performed in case new tags are added to an old version of a descriptor. When that happens, this is the mechanism that detects that newer tags have been added, so the doctype version is updated. This method depends on proper implementation of these methods: getMinimumRequiredVersion( Object descriptor ); compareVersions( String systemID1, String systemID2 ); newDescriptorIO( String systemID );

getMinimumRequiredVersion

protected abstract java.lang.String getMinimumRequiredVersion(java.lang.Object descriptor)

Correct subclass implementation is required to guarantee proper behavior for multi-version support.

compareVersions

protected int compareVersions(java.lang.String systemID1,
                  java.lang.String systemID2)

Compares two system ID version strings.

Returns:

0 if the version strings are equivalent; positive int if systemID1 is newer than systemID2; negative int if systemID1 is older than systemID2.

mapVersionToInt

protected abstract int mapVersionToInt(java.lang.String systemID)

Maps a version string to an integer to simplify the algorithm for comparing version strings. If the system ID is not recognized, it is assumed to be newer than any of the supported versions. All system IDs that are not recognized are assumed to be equivalent, so all unrecognized system IDs should return the same int.

Higher ints correspond to newer versions. Lower ints correspond to older versions. The actual int value returned is not important. Only the relative ordering of the ints is important.

newDescriptorIO

protected abstract DescriptorIO newDescriptorIO(java.lang.String systemID)

Correct subclass implementation is required to guarantee proper behavior for multi-version support.

loadXml

protected oracle.xml.parser.v2.XMLDocument loadXml(java.net.URL url)
                                            throws org.xml.sax.SAXException,
                                                   java.io.IOException

Throws:

org.xml.sax.SAXException

java.io.IOException