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

Part Number E27170-02

weblogic.management.configuration
Interface XMLEntitySpecRegistryEntryMBean

All Superinterfaces:
ConfigurationMBean, DescriptorBean, DynamicMBean, MBeanRegistration, NotificationBroadcaster, SettableBean, WebLogicMBean

public interface XMLEntitySpecRegistryEntryMBean
extends ConfigurationMBean

An Entity Spec Entry specifies how to resolve an external entity based its public and system IDs.

When WebLogic Server is parsing an XML document and it encounters the specified external entity, WebLogic Server resolves the entity according to the values entered for this entry. You can specify that the external entity resolve to a particular resource whose location is either a pathname reachable by the Administration Server or a URI to a local repository.

An Entity Spec entry is part of an XML Registry.

For this type of registry entry the document type is identified by either or both of: 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") This configuration information is used by the WebLogic JAXP implementation to set up SAX EntityResolvers.


Field Summary
 
Fields inherited from interface weblogic.management.configuration.ConfigurationMBean
DEFAULT_EMPTY_BYTE_ARRAY
 
Method Summary
 int getCacheTimeoutInterval()
          Specifies the default timeout interval (in seconds) of the external entity cache.
 String getEntityURI()
          The location of the external entity, either a pathname or URI.
 String getHandleEntityInvalidation()
          Whether cached DTD/schema is invalidated when parsing error is encountered.
 String getPublicId()
          The public ID of the external entity.
 String getSystemId()
          The system ID of the external entity.
 String getWhenToCache()
          Specifies when WebLogic Server should cache the external entities it retrieves from the Web.
 void setCacheTimeoutInterval(int interval)
          Sets the value of the CacheTimeoutInterval attribute.
 void setEntityURI(String uri)
          Sets the value of the EntityURI attribute.
 void setHandleEntityInvalidation(String enabled)
          Sets if cached DTD/schema is invalidated when parsing error is encountered.
 void setPublicId(String publicId)
          Set the public id of the document type represented by this registry entry.
 void setSystemId(String systemId)
          Set the system id of the document type represented by this registry entry.
 void setWhenToCache(String cacheOnDeploy)
          Sets the value of the WhenToCache 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

getPublicId

String getPublicId()

The public ID of the external entity.

When WebLogic Server is parsing an XML document and it encounters an external entity with this public ID, WebLogic Server resolves the entity (to either a local file or a URL resource) according to the values set for this Entity spec entry.

Returns:
The publicId value

setPublicId

void setPublicId(String publicId)
                 throws InvalidAttributeValueException

Set the public id of the document type represented by this registry entry.

Parameters:
publicId - The new publicId value
Throws:
InvalidAttributeValueException

getSystemId

String getSystemId()

The system ID of the external entity.

When WebLogic Server is parsing an XML document and it encounters an external entity with this system ID, WebLogic Server resolves the entity (to either a local file or a URL resource) according to the values set for this Entity spec entry.

Returns:
The systemId value

setSystemId

void setSystemId(String systemId)
                 throws InvalidAttributeValueException

Set the system id of the document type represented by this registry entry.

Parameters:
systemId - The new systemId value
Throws:
InvalidAttributeValueException

getEntityURI

String getEntityURI()

The location of the external entity, either a pathname or URI.

The location of the external entity can be either a pathname relative to the XML Registry directories, reachable by the Administration Server, or a URI of the entity location in some local repository.

Returns:
The entityURI value

setEntityURI

void setEntityURI(String uri)
                  throws InvalidAttributeValueException

Sets the value of the EntityURI attribute.

Parameters:
uri - The new entityURI value
Throws:
InvalidAttributeValueException

getWhenToCache

String getWhenToCache()

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

WebLogic Server can cache the entities when they are referenced, as soon as possible (that is, on initialization) or never. Additionally, WebLogic Server can defer to the XML registry's cache setting.

Returns:
The whenToCache value
Default Value:
"defer-to-registry-setting"
Valid Values:
"cache-on-reference","cache-at-initialization","cache-never","defer-to-registry-setting"

setWhenToCache

void setWhenToCache(String cacheOnDeploy)

Sets the value of the WhenToCache attribute.

Parameters:
cacheOnDeploy - The new whenToCache value

getCacheTimeoutInterval

int getCacheTimeoutInterval()

Specifies the default timeout interval (in seconds) of the external entity cache.

A value of -1 means that the entity cache timeout interval defers to the one specified for the XML registry of which this Entity Spec entry is a part.

Returns:
The cacheTimeoutInterval value
Default Value:
-1
Minimum Value:
-1

setCacheTimeoutInterval

void setCacheTimeoutInterval(int interval)
                             throws InvalidAttributeValueException

Sets the value of the CacheTimeoutInterval attribute.

Parameters:
interval - The new cacheTimeoutInterval value
Throws:
InvalidAttributeValueException

getHandleEntityInvalidation

String getHandleEntityInvalidation()

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

Returns:
true string if invalidation, otherwise false string.
defer-to-registry-setting string indicates the value is inherited from parent mbean.
Default Value:
"defer-to-registry-setting"
Valid Values:
"true","false","defer-to-registry-setting"

setHandleEntityInvalidation

void setHandleEntityInvalidation(String enabled)

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

Parameters:
enabled - true string if invalidation enabled, otherwise false string.
If setting defer-to-registry-setting string, then the value is inherited from parent mbean.

Copyright 1996, 2013, 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.1.2)

Part Number E27170-02