weblogic.management.configuration
Interface XMLParserSelectRegistryEntryMBean

All Superinterfaces:

ConfigurationMBean

public interface XMLParserSelectRegistryEntryMBean
extends ConfigurationMBean

A Parser Select Entry specifies the SAX/DOM parser factory implementation classes for a particular document type.

By default, WebLogic server uses either the built-in (out-of-the-box) or default SAX/DOM parser factory implementation classes when it parses an XML document. However, you can specify that particular XML documents, based on their public IDs, system IDs, or root elements, use different parser factory implementation classes than the default. You do this by first creating an XML Registry and then creating a Parser Select entry and specifying how to identify the document and then the desired implementation classes. The XML document type is identified by one or more of the following: 1) a public ID (e.g, "-//Sun Microsystems, Inc.//DTD Enterprise JavaBeans 2.0//EN" 2) a system ID (e.g, "http://java.sun.com/j2ee/dtds/ejb-jar_2_0.dtd") 3) a document root tag name (e.g., "ejb-jar") This configuration information is used by the WebLogic JAXP implementation to choose the appropriate parser factories (SAX and DOM).

Deprecation of MBeanHome and Type-Safe Interfaces

This is a type-safe interface for a WebLogic Server MBean, which you can import into your client classes and access through weblogic.management.MBeanHome. As of 9.0, the MBeanHome interface and all type-safe interfaces for WebLogic Server MBeans are deprecated. Instead, client classes that interact with WebLogic Server MBeans should use standard JMX design patterns in which clients use the javax.management.MBeanServerConnection interface to discover MBeans, attributes, and attribute types at runtime.

getPublicId

String getPublicId()

Specifies the public ID of the XML document type for which this XML registry entry is being configured.

When WebLogic Server starts to parse an XML document that is identified with this public ID, it uses the SAX or DOM parser factory implementation class specified by this registry entry, rather than the built-in or default, when obtaining a SAX or DOM parser.

Returns:

The publicId value

setPublicId

void setPublicId(String publicId)
                 throws InvalidAttributeValueException

Sets the value of the publicId attribute.

Parameters:

publicId - The new publicId value

Throws:

InvalidAttributeValueException

See Also:

XMLParserSelectRegistryEntryMBean.getPublicId()

getSystemId

String getSystemId()

Specifies the system ID of the XML document type for which this XML registry entry is being configured.

When WebLogic Server starts to parse an XML document that is identified with this system ID, it uses the SAX or DOM parser factory implementation class specified by this registry entry, rather than the built-in or default, when obtaining a SAX or DOM parser.

Returns:

The systemId value

setSystemId

void setSystemId(String systemId)
                 throws InvalidAttributeValueException

Sets the value of the systemId attribute.

Parameters:

systemId - The new systemId value

Throws:

InvalidAttributeValueException

See Also:

XMLParserSelectRegistryEntryMBean.getSystemId()

getRootElementTag

String getRootElementTag()

Specifies the root element of the XML document type for which this XML registry entry is being configured.

When WebLogic Server starts to parse an XML document that is identified with this root element, it uses the SAX or DOM parser factory implementation class specified by this registry entry, rather than the built-in or default, when obtaining a SAX or DOM parser.

Returns:

The rootElementTag value

setRootElementTag

void setRootElementTag(String tagName)
                       throws InvalidAttributeValueException

Sets the value of the rootElementTag attribute.

Parameters:

tagName - The new rootElementTag value

Throws:

InvalidAttributeValueException

See Also:

XMLParserSelectRegistryEntryMBean.getRootElementTag()

getDocumentBuilderFactory

String getDocumentBuilderFactory()

Specifies the fully qualified name of the class that implements the DocumentBuilderFactory API.

When WebLogic Server begins to parse an XML document identified by either the public ID, system ID, or root element specified in this entry, and the applications specifies it wants a DOM parser, then WebLogic Server uses this implementation class when using the javax.xml.parsers.DocumentBuilderFactory to obtain the DOM parser.

Returns:

The documentBuilderFactory value

setDocumentBuilderFactory

void setDocumentBuilderFactory(String factoryClassName)
                               throws InvalidAttributeValueException

Sets the value of the documentBuilderFactory attribute.

Parameters:

factoryClassName - The new documentBuilderFactory value

Throws:

InvalidAttributeValueException

See Also:

XMLParserSelectRegistryEntryMBean.getDocumentBuilderFactory()

getSAXParserFactory

String getSAXParserFactory()

Specifies the fully qualified name of the class that implements the SAXParserFactory API.

When WebLogic Server begins to parse an XML document identified by either the public ID, system ID, or root element specified in this entry, and the applications specifies it wants a SAX parser, then WebLogic Server uses this implementation class when using the javax.xml.parsers.SAXParserFactory to obtain the SAX parser.

Returns:

The SAXParserFactory value

setSAXParserFactory

void setSAXParserFactory(String factoryClassName)
                         throws InvalidAttributeValueException

Sets the value of the sAXParserFactory attribute.

Parameters:

factoryClassName - The new sAXParserFactory value

Throws:

InvalidAttributeValueException

See Also:

XMLParserSelectRegistryEntryMBean.getSAXParserFactory()

getTransformerFactory

String getTransformerFactory()

Specifies the fully qualified name of the class that implements the TransformerFactory API.

When WebLogic Server begins to transform an XML document identified by either the public ID, system ID, or root element specified in this entry, then WebLogic Server uses this implementation class when using the javax.xml.transform.TranformerFactory factory to obtain a Transformer object.

Returns:

The transformerFactory value

setTransformerFactory

void setTransformerFactory(String factoryClassName)
                           throws InvalidAttributeValueException

Sets the value of the transformerFactory attribute.

Parameters:

factoryClassName - The new transformerFactory value

Throws:

InvalidAttributeValueException

See Also:

XMLParserSelectRegistryEntryMBean.getTransformerFactory()

getParserClassName

String getParserClassName()

Deprecated. 

Provides the class name of any custom XML parser that is associated with this parser select entry.

Return class name of any custom XML parser that is associated with the registry entry.

Returns:

The parserClassName value

setParserClassName

void setParserClassName(String publicId)
                        throws InvalidAttributeValueException

Deprecated. 

Sets the value of the parserClassName attribute.

Parameters:

publicId - The new parserClassName value

Throws:

InvalidAttributeValueException

See Also:

XMLParserSelectRegistryEntryMBean.getParserClassName()