Type-Safe Access to BEA WebLogic Server 9.0 MBeans (Deprecated)

(Methods marked with @since 9.0.0.0 are not available through the deprecated MBeanHome interface.)

weblogic.management.configuration
Interface XMLRegistryMBean

All Superinterfaces:

ConfigurationMBean, weblogic.descriptor.DescriptorBean, DynamicMBean, MBeanRegistration, NotificationBroadcaster, weblogic.descriptor.SettableBean, weblogic.management.WebLogicMBean

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. For more information, see "Developing Manageable Applications with JMX" on http://www.oracle.com/technology/documentation/index.html.

Copyright © 2005 BEA Systems, Inc. All Rights Reserved.

Field Summary

Fields inherited from interface weblogic.management.configuration.ConfigurationMBean

DEFAULT_EMPTY_BYTE_ARRAY

Method Summary

XMLEntitySpecRegistryEntryMBean	createXMLEntitySpecRegistryEntry(String name)
XMLParserSelectRegistryEntryMBean	createXMLParserSelectRegistryEntry(String name) creates an XMLParserSelectRegistryEntryMBean object
void	destroyXMLEntitySpecRegistryEntry(XMLEntitySpecRegistryEntryMBean entry)
void	destroyXMLParserSelectRegistryEntry(XMLParserSelectRegistryEntryMBean entry)
String	getDocumentBuilderFactory() The fully qualified name of the class that implements the DocumentBuilderFactory interface.
XMLEntitySpecRegistryEntryMBean[]	getEntitySpecRegistryEntries() Deprecated. 9.0.0.0
XMLParserSelectRegistryEntryMBean[]	getParserSelectRegistryEntries() Deprecated. 9.0.0.0
XMLRegistryEntryMBean[]	getRegistryEntries() Deprecated. 7.0.0.0 replaced by XMLRegistryMBean
String	getSAXParserFactory() The fully qualified name of the class that implements the SAXParserFactory interface.
String	getTransformerFactory() The fully qualified name of the class that implements the TransformerFactory interface.
String	getWhenToCache() Specifies when WebLogic Server should cache external entities that it retrieves from the Web.
XMLEntitySpecRegistryEntryMBean[]	getXMLEntitySpecRegistryEntries() Provides a list of EntitySpec registry entries.
XMLParserSelectRegistryEntryMBean[]	getXMLParserSelectRegistryEntries() Provides a list of the set of ParserSelect registry entries.
void	setDocumentBuilderFactory(String factoryClassName) Sets the value of the documentBuilderFactory attribute.
void	setEntitySpecRegistryEntries(XMLEntitySpecRegistryEntryMBean[] entries) Sets the value of the entitySpecRegistryEntries attribute.
void	setParserSelectRegistryEntries(XMLParserSelectRegistryEntryMBean[] entries) Set the set of ParserSelect registry entries.
void	setRegistryEntries(XMLRegistryEntryMBean[] entries) Deprecated. 7.0.0.0 replaced by XMLRegistryMBean
void	setSAXParserFactory(String factoryClassName) Sets the value of the SAXParserFactory attribute.
void	setTransformerFactory(String factoryClassName) Sets the value of the transformerFactory attribute.
void	setWhenToCache(String cacheOnDeploy) Sets the value of the whenToCache attribute.

Methods inherited from interface weblogic.management.configuration.ConfigurationMBean

freezeCurrentValue, getName, getNotes, isSet, restoreDefaultValue, setComments, setDefaultedMBean, setName, setNotes, setPersistenceEnabled, unSet

Methods inherited from interface weblogic.management.WebLogicMBean

getMBeanInfo, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setParent

Methods inherited from interface javax.management.DynamicMBean

getAttribute, getAttributes, invoke, setAttribute, setAttributes

Methods inherited from interface javax.management.MBeanRegistration

postDeregister, postRegister, preDeregister, preRegister

Methods inherited from interface javax.management.NotificationBroadcaster

addNotificationListener, getNotificationInfo, removeNotificationListener

Methods inherited from interface weblogic.descriptor.DescriptorBean

addBeanUpdateListener, addPropertyChangeListener, createChildCopy, createChildCopyIncludingObsolete, getDescriptor, getParentBean, isEditable, removeBeanUpdateListener, removePropertyChangeListener

Method Detail

createXMLEntitySpecRegistryEntry

public XMLEntitySpecRegistryEntryMBean createXMLEntitySpecRegistryEntry(String name)

Returns:

XMLEntitySpecRegistryEntry object

createXMLParserSelectRegistryEntry

public XMLParserSelectRegistryEntryMBean createXMLParserSelectRegistryEntry(String name)

creates an XMLParserSelectRegistryEntryMBean object

destroyXMLEntitySpecRegistryEntry

public void destroyXMLEntitySpecRegistryEntry(XMLEntitySpecRegistryEntryMBean entry)

destroyXMLParserSelectRegistryEntry

public void destroyXMLParserSelectRegistryEntry(XMLParserSelectRegistryEntryMBean entry)

getDocumentBuilderFactory

public 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"

getEntitySpecRegistryEntries

public XMLEntitySpecRegistryEntryMBean[] getEntitySpecRegistryEntries()

Deprecated. 9.0.0.0

Provides a list of EntitySpec registry entries.

Returns:

The entitySpecRegistryEntries value

getParserSelectRegistryEntries

public XMLParserSelectRegistryEntryMBean[] getParserSelectRegistryEntries()

Deprecated. 9.0.0.0

Provides a list of the set of ParserSelect registry entries.

Returns:

The parserSelectRegistryEntries value

getRegistryEntries

public 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

getSAXParserFactory

public 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"

getTransformerFactory

public 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:

"org.apache.xalan.processor.TransformerFactoryImpl"

getWhenToCache

public 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"

Legal values:

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

getXMLEntitySpecRegistryEntries

public XMLEntitySpecRegistryEntryMBean[] getXMLEntitySpecRegistryEntries()

Provides a list of EntitySpec registry entries.

Returns:

The XMLentitySpecRegistryEntries value

getXMLParserSelectRegistryEntries

public XMLParserSelectRegistryEntryMBean[] getXMLParserSelectRegistryEntries()

Provides a list of the set of ParserSelect registry entries.

Returns:

The parserSelectRegistryEntries value

setDocumentBuilderFactory

public void setDocumentBuilderFactory(String factoryClassName)
                               throws InvalidAttributeValueException

Sets the value of the documentBuilderFactory attribute.

Parameters:

factoryClassName - The new documentBuilderFactory value

Throws:

InvalidAttributeValueException

See Also:

getDocumentBuilderFactory()

A dynamic MBean attribute.

setEntitySpecRegistryEntries

public void setEntitySpecRegistryEntries(XMLEntitySpecRegistryEntryMBean[] entries)
                                  throws InvalidAttributeValueException

Sets the value of the entitySpecRegistryEntries attribute.

Parameters:

entries - The new entitySpecRegistryEntries value

Throws:

InvalidAttributeValueException

See Also:

getEntitySpecRegistryEntries()

A dynamic MBean attribute.

setParserSelectRegistryEntries

public void setParserSelectRegistryEntries(XMLParserSelectRegistryEntryMBean[] entries)
                                    throws InvalidAttributeValueException

Set the set of ParserSelect registry entries.

Parameters:

entries - The new parserSelectRegistryEntries value

Throws:

InvalidAttributeValueException

A dynamic MBean attribute.

setRegistryEntries

public 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:

getRegistryEntries()

A dynamic MBean attribute.

setSAXParserFactory

public void setSAXParserFactory(String factoryClassName)
                         throws InvalidAttributeValueException

Sets the value of the SAXParserFactory attribute.

Parameters:

factoryClassName - The new sAXParserFactory value

Throws:

InvalidAttributeValueException

See Also:

getSAXParserFactory()

A dynamic MBean attribute.

setTransformerFactory

public void setTransformerFactory(String factoryClassName)
                           throws InvalidAttributeValueException

Sets the value of the transformerFactory attribute.

Parameters:

factoryClassName - The new transformerFactory value

Throws:

InvalidAttributeValueException

See Also:

getTransformerFactory()

A dynamic MBean attribute.

setWhenToCache

public void setWhenToCache(String cacheOnDeploy)

Sets the value of the whenToCache attribute.

Parameters:

cacheOnDeploy - The new whenToCache value

See Also:

getWhenToCache()

A dynamic MBean attribute.