Skip navigation links

Oracle Fusion Middleware
Java API Reference for Oracle WebLogic Server
12c (12.2.1)

Part Number E55141-01
P4 Change 1723563 on 2015/10/09


weblogic.management.configuration
Interface XMLRegistryMBean

All Superinterfaces:
ConfigurationMBean, DescriptorBean, DynamicMBean, MBeanRegistration, NotificationBroadcaster, SettableBean, 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.


Field Summary

 

Fields inherited from interface weblogic.management.configuration.ConfigurationMBean
DEFAULT_EMPTY_BYTE_ARRAY

 

Method Summary
abstract  XMLEntitySpecRegistryEntryMBean createXMLEntitySpecRegistryEntry(String name)
           
abstract  XMLParserSelectRegistryEntryMBean createXMLParserSelectRegistryEntry(String name)
          creates an XMLParserSelectRegistryEntryMBean object
abstract  void destroyXMLEntitySpecRegistryEntry(XMLEntitySpecRegistryEntryMBean entry)
           
abstract  void destroyXMLParserSelectRegistryEntry(XMLParserSelectRegistryEntryMBean entry)
           
abstract  String getDocumentBuilderFactory()
          The fully qualified name of the class that implements the DocumentBuilderFactory interface.
abstract  XMLEntitySpecRegistryEntryMBean[] getEntitySpecRegistryEntries()
          Deprecated. 9.0.0.0
abstract  XMLParserSelectRegistryEntryMBean[] getParserSelectRegistryEntries()
          Deprecated. 9.0.0.0
abstract  XMLRegistryEntryMBean[] getRegistryEntries()
          Deprecated. 7.0.0.0 replaced by XMLRegistryMBean
abstract  String getSAXParserFactory()
          The fully qualified name of the class that implements the SAXParserFactory interface.
abstract  String getSchemaFactory()
          The fully qualified name of the class that implements the SchemaFactory interface.
abstract  String getTransformerFactory()
          The fully qualified name of the class that implements the TransformerFactory interface.
abstract  String getWhenToCache()
          Specifies when WebLogic Server should cache external entities that it retrieves from the Web.
abstract  XMLEntitySpecRegistryEntryMBean[] getXMLEntitySpecRegistryEntries()
          Provides a list of EntitySpec registry entries.
abstract  String getXMLEventFactory()
          The fully qualified name of the class that implements the XMLEventFactory interface.
abstract  String getXMLInputFactory()
          The fully qualified name of the class that implements the XMLInputFactory interface.
abstract  String getXMLOutputFactory()
          The fully qualified name of the class that implements the XMLOutputFactory interface.
abstract  XMLParserSelectRegistryEntryMBean[] getXMLParserSelectRegistryEntries()
          Provides a list of the set of ParserSelect registry entries.
abstract  String getXpathFactory()
          The fully qualified name of the class that implements the XPathFactory interface.
abstract  boolean isHandleEntityInvalidation()
          Whether cached DTD/schema is invalidated when parsing error is encountered.
abstract  void setDocumentBuilderFactory(String factoryClassName)
          Sets the value of the documentBuilderFactory attribute.
abstract  void setEntitySpecRegistryEntries(XMLEntitySpecRegistryEntryMBean[] entries)
          Sets the value of the entitySpecRegistryEntries attribute.
abstract  void setHandleEntityInvalidation(boolean enabled)
          Sets if cached DTD/schema is invalidated when parsing error is encountered.
abstract  void setParserSelectRegistryEntries(XMLParserSelectRegistryEntryMBean[] entries)
          Set the set of ParserSelect registry entries.
abstract  void setRegistryEntries(XMLRegistryEntryMBean[] entries)
          Deprecated. 7.0.0.0 replaced by XMLRegistryMBean
abstract  void setSAXParserFactory(String factoryClassName)
          Sets the value of the SAXParserFactory attribute.
abstract  void setSchemaFactory(String factoryClassName)
          Sets the value of the schemaFactory attribute.
abstract  void setTransformerFactory(String factoryClassName)
          Sets the value of the transformerFactory attribute.
abstract  void setWhenToCache(String cacheOnDeploy)
          Sets the value of the whenToCache attribute.
abstract  void setXMLEventFactory(String factoryClassName)
          Sets the value of the xmlEventFactory attribute.
abstract  void setXMLInputFactory(String factoryClassName)
          Sets the value of the xmlInputFactory attribute.
abstract  void setXMLOutputFactory(String factoryClassName)
          Sets the value of the xmlOutputFactory attribute.
abstract  void setXpathFactory(String factoryClassName)
          Sets the value of the xPathFactory attribute.

 

Methods inherited from interface weblogic.management.configuration.ConfigurationMBean
freezeCurrentValue, getId, getInheritedProperties, getName, getNotes, isDynamicallyCreated, isInherited, 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
addPropertyChangeListener, createChildCopyIncludingObsolete, getParentBean, isEditable, removePropertyChangeListener

 

Method Detail

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

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

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

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()

getXpathFactory

String getXpathFactory()

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

The javax.xml.xpath.XPathFactory factory API enables applications deployed to WebLogic Server to configure and obtain a XPath object used to search XML elements.

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

Return the class name of the default XPathFactory

Returns:
The xPathFactory value

setXpathFactory

void setXpathFactory(String factoryClassName)
                     throws InvalidAttributeValueException

Sets the value of the xPathFactory attribute.

Parameters:
factoryClassName - The new xPathFactory value
Throws:
InvalidAttributeValueException
See Also:
XMLRegistryMBean.getXpathFactory()

getSchemaFactory

String getSchemaFactory()

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

The javax.xml.validation.SchemaFactory factory API enables applications deployed to WebLogic Server to configure and obtain a Schema object used to validate XML document using schema.

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

Return the class name of the default SchemaFactory

Returns:
The schemaFactory value

setSchemaFactory

void setSchemaFactory(String factoryClassName)
                      throws InvalidAttributeValueException

Sets the value of the schemaFactory attribute.

Parameters:
factoryClassName - The new schemaFactory value
Throws:
InvalidAttributeValueException
See Also:
XMLRegistryMBean.getSchemaFactory()

getXMLInputFactory

String getXMLInputFactory()

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

The javax.xml.stream.XMLInputFactory factory API enables applications deployed to WebLogic Server to configure and obtain a XMLEventReader/XMLStreamReader object used to read XML streams.

The built-in WebLogic Server XML Input factory implementation class is com.ctc.wstx.stax.WstxInputFactory. This is the factory class applications deployed to WebLogic Server get by default when they request a XMLEventReader/XMLStreamReader object. You can change this default by updating this value.

Return the class name of the default XMLInputFactory

Returns:
The xmlInputFactory value

setXMLInputFactory

void setXMLInputFactory(String factoryClassName)
                        throws InvalidAttributeValueException

Sets the value of the xmlInputFactory attribute.

Parameters:
factoryClassName - The new xmlInputFactory value
Throws:
InvalidAttributeValueException
See Also:
XMLRegistryMBean.getXMLInputFactory()

getXMLOutputFactory

String getXMLOutputFactory()

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

The javax.xml.stream.XMLOutputFactory factory API enables applications deployed to WebLogic Server to configure and obtain a XMLEventWriter/XMLStreamWriter object used to write XML streams.

The built-in WebLogic Server XML Output factory implementation class is com.ctc.wstx.stax.WstxOutputFactory. This is the factory class applications deployed to WebLogic Server get by default when they request a XMLEventWriter/XMLStreamWriter object. You can change this default by updating this value.

Return the class name of the default XMLOutputFactory

Returns:
The xmlOutputFactory value

setXMLOutputFactory

void setXMLOutputFactory(String factoryClassName)
                         throws InvalidAttributeValueException

Sets the value of the xmlOutputFactory attribute.

Parameters:
factoryClassName - The new xmlOutputFactory value
Throws:
InvalidAttributeValueException
See Also:
XMLRegistryMBean.getXMLOutputFactory()

getXMLEventFactory

String getXMLEventFactory()

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

The javax.xml.stream.XMLEventFactory factory API enables applications deployed to WebLogic Server to configure and obtain a XMLEvent object used to parse or build XML streams.

The built-in WebLogic Server XMLEvent factory implementation class is com.ctc.wstx.stax.WstxEventFactory. This is the factory class applications deployed to WebLogic Server get by default when they request a XMLEvent object. You can change this default by updating this value.

Return the class name of the default XMLEventFactory

Returns:
The xmlEventFactory value

setXMLEventFactory

void setXMLEventFactory(String factoryClassName)
                        throws InvalidAttributeValueException

Sets the value of the xmlEventFactory attribute.

Parameters:
factoryClassName - The new xmlEventFactory value
Throws:
InvalidAttributeValueException
See Also:
XMLRegistryMBean.getXMLEventFactory()

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

Parameters:
name -

destroyXMLParserSelectRegistryEntry

void destroyXMLParserSelectRegistryEntry(XMLParserSelectRegistryEntryMBean entry)
Parameters:
entry - 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)
Parameters:
name -
Returns:
XMLEntitySpecRegistryEntry object

destroyXMLEntitySpecRegistryEntry

void destroyXMLEntitySpecRegistryEntry(XMLEntitySpecRegistryEntryMBean entry)
Parameters:
entry - 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

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.

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.

Skip navigation links

Copyright 1996, 2015, Oracle and/or its affiliates. All rights reserved. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners.

Oracle Fusion Middleware
Java API Reference for Oracle WebLogic Server
12c (12.2.1)

Part Number E55141-01
P4 Change 1723563 on 2015/10/09