com.sun.jbi.management.internal.support

Class XmlReader

java.lang.Object

com.sun.jbi.management.internal.support.XmlReader

All Implemented Interfaces:

EntityResolver, ErrorHandler

public class XmlReader
extends Object
implements ErrorHandler, EntityResolver

XmlReader -- read in and print out expected values from the specified file (supposedly the jbi.xml file from the archive).

Author:

Sun Microsystems, Inc.

Constructor Summary

Constructors

Constructor and Description
XmlReader() Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	error(SAXParseException aSaxException) This is a callback from the XML parser used to handle errors.
void	fatalError(SAXParseException aSaxException) This is a callback from the XML parser used to handle errors.
String	getBootstrapClassName() Function to return the last bootstrap class parsed.
Vector	getBootstrapClassPath() Function to return the last bootstrap classpath parsed.
DocumentFragment	getComponentDocumentFragment() Return the XML Document Fragment from the component section.
String	getDescription() Function to return the last description parsed.
String	getId() Function to return the last component ID parsed.
DocumentFragment	getIdentificationDocumentFragment() Return the XML Document Fragment from the identification section.
ComponentInstallationContext	getInstallationContext() Function to return the installation context for the component.
Vector	getLifecycleClassNames() Function to return the last lifecycle classes parsed.
Vector	getLifecycleClassPath() Function to return the last lifecycle classpath parsed.
Vector	getSharedLibraryIds() Function to return the last list of shared library ids parsed.
Document	getXmlDocument() Return the XML Document.
boolean	isAlternateBootstrapClassLoaderDelegation() Function to specify if the parsed component had an alternate bootstrap class loader delegation.
boolean	isAlternateComponentClassLoaderDelegation() Function to specify if the parsed component had an alternate component class loader delegation.
boolean	isAlternateSharedLibraryClassLoaderDelegation() Function to specify if the parsed shared library had an alternate class loader delegation.
boolean	isBinding() Function to specify if the parsed component was a binding.
boolean	isDeployment() Function to specify if the parsed component was a deployment.
boolean	isEngine() Function to specify if the parsed component was an engine.
boolean	isSharedLibrary() Function to specify if the parsed component was a shared library.
String	loadAndParse(String aFileName, boolean isOnlyIdNeeded) Extract all information from the jbi.xml file.
InputSource	resolveEntity(String publicId, String systemId) The resolveEntity method resolves schema references only, a reference to the XML definition of the XML configuration file is resolved to return an InputSource created for the local schema definition file.
void	setEnvironmentContext(EnvironmentContext aContext) Specify the global environment context.
boolean	validate(InputStream istr) Validate the jbi.xml file.
boolean	validate(String aFileName) Validate the jbi.xml file.
boolean	validateManagementMessage(String aMMsgStr) Validate management message.
void	warning(SAXParseException aSaxException) This is a callback from the XML parser used to handle warnings.

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlReader

public XmlReader()

Default constructor.

Method Detail

loadAndParse

public String loadAndParse(String aFileName,
                  boolean isOnlyIdNeeded)
                    throws Exception

Extract all information from the jbi.xml file.

Parameters:

aFileName - the specified "jbi.xml" file

isOnlyIdNeeded - true if we want to return Id (only)

Returns:

the UUID of the JBI component

Throws:

Exception - when unable to process a valid configuration file.

validate

public boolean validate(InputStream istr)
                 throws Exception

Validate the jbi.xml file.

Parameters:

istr - is the InputStream to the "jbi.xml" file

Returns:

true iff the file passes validation

Throws:

Exception - when unable to process a valid configuration file.

validate

public boolean validate(String aFileName)
                 throws Exception

Validate the jbi.xml file.

Parameters:

aFileName - the specified "jbi.xml" file

Returns:

true iff the file passes validation

Throws:

Exception - when unable to process a valid configuration file.

validateManagementMessage

public boolean validateManagementMessage(String aMMsgStr)
                                  throws Exception

Validate management message.

Parameters:

aMMsgStr - management message string

Returns:

true iff the file passes validation

Throws:

Exception - when unable to process a valid configuration file.

error

public void error(SAXParseException aSaxException)
           throws SAXException

This is a callback from the XML parser used to handle errors.

Specified by:

error in interface ErrorHandler

Parameters:

aSaxException - SAXParseException is the error.

Throws:

SAXException - when finished logging.

fatalError

public void fatalError(SAXParseException aSaxException)
                throws SAXException

This is a callback from the XML parser used to handle errors.

Specified by:

fatalError in interface ErrorHandler

Parameters:

aSaxException - SAXParseException is the error.

Throws:

SAXException - when finished logging.

resolveEntity

public InputSource resolveEntity(String publicId,
                        String systemId)

The resolveEntity method resolves schema references only, a reference to the XML definition of the XML configuration file is resolved to return an InputSource created for the local schema definition file. The schema definition file should be present in the EntityResolvers work directory. If the referenced entity is not the schema definition a null value is returned such that the XML parser can apply the default entity resolution logic.

Specified by:

resolveEntity in interface EntityResolver

Parameters:

publicId - - The public identifier of the external entity being referenced, or null if none was supplied.

systemId - - The schemaorg_apache_xmlbeans.system identifier of the external entity being referenced.

Returns:

An InputSource object describing the new input source, or null to request that the parser open a regular URI connection to the schemaorg_apache_xmlbeans.system identifier

See Also:

EntityResolver

warning

public void warning(SAXParseException aSaxException)
             throws SAXException

This is a callback from the XML parser used to handle warnings.

Specified by:

warning in interface ErrorHandler

Parameters:

aSaxException - SAXParseException is the warning.

Throws:

SAXException - when finished logging.

isBinding

public boolean isBinding()

Function to specify if the parsed component was a binding.

Returns:

true iff the last component parsed was a binding

isEngine

public boolean isEngine()

Function to specify if the parsed component was an engine.

Returns:

true iff the last component parsed was an engine

isDeployment

public boolean isDeployment()

Function to specify if the parsed component was a deployment.

Returns:

true iff the last component parsed was a deployment

isSharedLibrary

public boolean isSharedLibrary()

Function to specify if the parsed component was a shared library.

Returns:

true iff the last component parsed was a shared library

getDescription

public String getDescription()

Function to return the last description parsed.

Returns:

the last description we saw

getId

public String getId()

Function to return the last component ID parsed.

Returns:

the last component ID we saw

getBootstrapClassName

public String getBootstrapClassName()

Function to return the last bootstrap class parsed.

Returns:

the bootstrap class name

getBootstrapClassPath

public Vector getBootstrapClassPath()

Function to return the last bootstrap classpath parsed.

Returns:

the bootstrap class path

getLifecycleClassNames

public Vector getLifecycleClassNames()

Function to return the last lifecycle classes parsed.

Returns:

the lifecycle classes names

getLifecycleClassPath

public Vector getLifecycleClassPath()

Function to return the last lifecycle classpath parsed.

Returns:

the lifecycle class path

getSharedLibraryIds

public Vector getSharedLibraryIds()

Function to return the last list of shared library ids parsed.

Returns:

the shared Library Ids list

getInstallationContext

public ComponentInstallationContext getInstallationContext()

Function to return the installation context for the component.

Returns:

the installation context for the component.

isAlternateBootstrapClassLoaderDelegation

public boolean isAlternateBootstrapClassLoaderDelegation()

Function to specify if the parsed component had an alternate bootstrap class loader delegation.

Returns:

true iff the last component parsed had an alternate bootstrap class loader delegation.

isAlternateComponentClassLoaderDelegation

public boolean isAlternateComponentClassLoaderDelegation()

Function to specify if the parsed component had an alternate component class loader delegation.

Returns:

true iff the last component parsed had an alternate component class loader delegation.

isAlternateSharedLibraryClassLoaderDelegation

public boolean isAlternateSharedLibraryClassLoaderDelegation()

Function to specify if the parsed shared library had an alternate class loader delegation.

Returns:

true iff the last shared library parsed had an alternate class loader delegation.

setEnvironmentContext

public void setEnvironmentContext(EnvironmentContext aContext)

Specify the global environment context.

Parameters:

aContext - the global environment context

getXmlDocument

public Document getXmlDocument()

Return the XML Document.

Returns:

the document as a DOM tree

getComponentDocumentFragment

public DocumentFragment getComponentDocumentFragment()

Return the XML Document Fragment from the component section.

Returns:

the document fragment from the component section.

getIdentificationDocumentFragment

public DocumentFragment getIdentificationDocumentFragment()

Return the XML Document Fragment from the identification section.

Returns:

the document fragment from the identification section.