weblogic.management.configuration
Interface XMLRegistryMBean

All Superinterfaces:

ConfigurationMBean

public interface XMLRegistryMBean
extends ConfigurationMBean

Configure the behavior of JAXP (Java API for XML Parsing) in the server.

You configure this behavior by creating XML Registries that specify the default DOM and Sax factory implementation class, transformer factory implementation class, external entity resolution and caching.

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.

getDocumentBuilderFactory

String getDocumentBuilderFactory()

The fully qualified name of the class that implements the DocumentBuilderFactory interface.

The javax.xml.parsers.DocumentBuilderFactory factory API enables applications deployed to WebLogic Server to obtain an XML parser that produces DOM object trees from XML documents.

The built-in WebLogic Server DOM factory implementation class is com.sun.org.apache.xerces.internal.jaxp.DocumentBuilderFactoryImpl. This is the factory class applications deployed to WebLogic Server get by default when they request a DOM parser. You can change this default by updating this value.

Return the class name of the default DocumentBuilderFactory

Returns:

The documentBuilderFactory value

Default Value:

"weblogic.apache.xerces.jaxp.DocumentBuilderFactoryImpl"

setDocumentBuilderFactory

void setDocumentBuilderFactory(String factoryClassName)
                               throws InvalidAttributeValueException

Sets the value of the documentBuilderFactory attribute.

Parameters:

factoryClassName - The new documentBuilderFactory value

Throws:

InvalidAttributeValueException

See Also:

XMLRegistryMBean.getDocumentBuilderFactory()

getSAXParserFactory

String getSAXParserFactory()

The fully qualified name of the class that implements the SAXParserFactory interface.

The javax.xml.parsers.SAXParserFactory factory API enables applications deployed to WebLogic Server to configure and obtain a SAX-based XML parser to parse XML documents.

The built-in WebLogic Server SAX factory implementation class is com.sun.org.apache.xerces.internal.jaxp.SAXParserFactoryImpl. This is the factory class applications deployed to WebLogic Server get by default when they request a SAX parser. You can change this default by updating this value.

Return the class name of the default SAXParserFactory

Returns:

The sAXParserFactory value

Default Value:

"weblogic.apache.xerces.jaxp.SAXParserFactoryImpl"

setSAXParserFactory

void setSAXParserFactory(String factoryClassName)
                         throws InvalidAttributeValueException

Sets the value of the SAXParserFactory attribute.

Parameters:

factoryClassName - The new sAXParserFactory value

Throws:

InvalidAttributeValueException

See Also:

XMLRegistryMBean.getSAXParserFactory()

getTransformerFactory

String getTransformerFactory()

The fully qualified name of the class that implements the TransformerFactory interface.

The javax.xml.transform.TransformerFactory factory API enables applications deployed to WebLogic Server to configure and obtain a Transformer object used to transform XML data into another format.

The built-in WebLogic Server Transformer factory implementation class is com.sun.org.apache.xalan.internal.xsltc.trax.TransformerFactoryIml. This is the factory class applications deployed to WebLogic Server get by default when they request a Transformer object. You can change this default by updating this value.

Return the class name of the default TransformerFactory

Returns:

The transformerFactory value

Default Value:

"weblogic.xml.jaxp.WebLogicTransformerFactory"

setTransformerFactory

void setTransformerFactory(String factoryClassName)
                           throws InvalidAttributeValueException

Sets the value of the transformerFactory attribute.

Parameters:

factoryClassName - The new transformerFactory value

Throws:

InvalidAttributeValueException

See Also:

XMLRegistryMBean.getTransformerFactory()

getRegistryEntries

XMLRegistryEntryMBean[] getRegistryEntries()

Deprecated. 7.0.0.0 replaced by XMLRegistryMBean

Provides a list of the set of pre-Silversword style registry entries.

Returns:

The registryEntries value

setRegistryEntries

void setRegistryEntries(XMLRegistryEntryMBean[] entries)
                        throws InvalidAttributeValueException

Deprecated. 7.0.0.0 replaced by XMLRegistryMBean

Sets the value of the registryEntries attribute.

Parameters:

entries - The new registryEntries value

Throws:

InvalidAttributeValueException

See Also:

XMLRegistryMBean.getRegistryEntries()

createXMLParserSelectRegistryEntry

XMLParserSelectRegistryEntryMBean createXMLParserSelectRegistryEntry(String name)

creates an XMLParserSelectRegistryEntryMBean object

destroyXMLParserSelectRegistryEntry

void destroyXMLParserSelectRegistryEntry(XMLParserSelectRegistryEntryMBean entry)

Parameters:

XMLParserSelectRegistryEntry - object

getXMLParserSelectRegistryEntries

XMLParserSelectRegistryEntryMBean[] getXMLParserSelectRegistryEntries()

Provides a list of the set of ParserSelect registry entries.

Returns:

The parserSelectRegistryEntries value

getParserSelectRegistryEntries

XMLParserSelectRegistryEntryMBean[] getParserSelectRegistryEntries()

Deprecated. 9.0.0.0

Provides a list of the set of ParserSelect registry entries.

Returns:

The parserSelectRegistryEntries value

setParserSelectRegistryEntries

void setParserSelectRegistryEntries(XMLParserSelectRegistryEntryMBean[] entries)
                                    throws InvalidAttributeValueException

Set the set of ParserSelect registry entries.

Parameters:

entries - The new parserSelectRegistryEntries value

Throws:

InvalidAttributeValueException

getEntitySpecRegistryEntries

XMLEntitySpecRegistryEntryMBean[] getEntitySpecRegistryEntries()

Deprecated. 9.0.0.0

Provides a list of EntitySpec registry entries.

Returns:

The entitySpecRegistryEntries value

getXMLEntitySpecRegistryEntries

XMLEntitySpecRegistryEntryMBean[] getXMLEntitySpecRegistryEntries()

Provides a list of EntitySpec registry entries.

Returns:

The XMLentitySpecRegistryEntries value

createXMLEntitySpecRegistryEntry

XMLEntitySpecRegistryEntryMBean createXMLEntitySpecRegistryEntry(String name)

Returns:

XMLEntitySpecRegistryEntry object

destroyXMLEntitySpecRegistryEntry

void destroyXMLEntitySpecRegistryEntry(XMLEntitySpecRegistryEntryMBean entry)

Parameters:

XMLEntitySpecRegistryEntry - object

setEntitySpecRegistryEntries

void setEntitySpecRegistryEntries(XMLEntitySpecRegistryEntryMBean[] entries)
                                  throws InvalidAttributeValueException

Sets the value of the entitySpecRegistryEntries attribute.

Parameters:

entries - The new entitySpecRegistryEntries value

Throws:

InvalidAttributeValueException

See Also:

XMLRegistryMBean.getEntitySpecRegistryEntries()

getWhenToCache

String getWhenToCache()

Specifies when WebLogic Server should cache external entities that it retrieves from the Web.

When WebLogic Server resolves an external entity within an XML file and retrieves the entity from the Web, you can specify that WebLogic Server cache this entity only when the entity is first referenced, when WebLogic Server first starts up, or not at all.

Returns:

The whenToCache value

Default Value:

"cache-on-reference"

Valid Values:

"cache-on-reference","cache-at-initialization","cache-never"

setWhenToCache

void setWhenToCache(String cacheOnDeploy)

Sets the value of the whenToCache attribute.

Parameters:

cacheOnDeploy - The new whenToCache value

See Also:

XMLRegistryMBean.getWhenToCache()

isHandleEntityInvalidation

boolean isHandleEntityInvalidation()

Whether cached DTD/schema is invalidated when parsing error is encountered.

Returns:

true if invalidation, otherwise false.

Default Value:

false

setHandleEntityInvalidation

void setHandleEntityInvalidation(boolean enabled)

Sets if cached DTD/schema is invalidated when parsing error is encountered.

Parameters:

enabled - true if invalidation enabled, otherwise false.