weblogic.management.configuration

Interface WLDFSystemResourceMBean

All Superinterfaces:

BasicDeploymentMBean, ConfigurationExtensionMBean, ConfigurationMBean, DescriptorBean, DynamicMBean, MBeanRegistration, NotificationBroadcaster, SettableBean, SystemResourceMBean, TargetInfoMBean, WebLogicMBean

public interface WLDFSystemResourceMBean
extends SystemResourceMBean

This bean defines a system-level WebLogic Diagnostic Framework (WLDF) resource. It links a separate descriptor that specifies the definition.

Access limited to the following security roles:

Deployer

Field Summary

Fields inherited from interface weblogic.management.configuration.ConfigurationMBean

DEFAULT_EMPTY_BYTE_ARRAY

Method Summary

Modifier and Type	Method and Description
String	getDescription() Optional short description of this WLDFSystemResource.
String	getDescriptorFileName() The name of the descriptor file that contains the XML configuration information for this system-level resource.
String	getName() The user-specified name of this MBean instance.
WLDFResourceBean	getWLDFResource() A WLDF resource defines a system-level or an application-level diagnostic resource.
void	setDescription(String description) Sets the value of the Description attribute.

Methods inherited from interface weblogic.management.configuration.SystemResourceMBean

getResource, getSourcePath, setName

Methods inherited from interface weblogic.management.configuration.BasicDeploymentMBean

createSubDeployment, destroySubDeployment, getDeploymentOrder, getDeploymentPrincipalName, getSubDeployments, lookupSubDeployment, setDeploymentOrder, setDeploymentPrincipalName, setSourcePath

Methods inherited from interface weblogic.management.configuration.TargetInfoMBean

addTarget, getCompatibilityName, getTargets, removeTarget, setCompatibilityName, setModuleType, setTargets

Methods inherited from interface weblogic.management.configuration.ConfigurationMBean

freezeCurrentValue, getId, getInheritedProperties, getNotes, isDynamicallyCreated, isInherited, isSet, restoreDefaultValue, setComments, setDefaultedMBean, 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

Methods inherited from interface weblogic.management.configuration.ConfigurationExtensionMBean

setDescriptorFileName

Method Detail

getName

String getName()

The user-specified name of this MBean instance.

This name is included as one of the key properties in the MBean's javax.management.ObjectName:

Name=user-specified-name

Specified by:

getName in interface ConfigurationMBean

Specified by:

getName in interface TargetInfoMBean

Specified by:

getName in interface WebLogicMBean

getWLDFResource

WLDFResourceBean getWLDFResource()

A WLDF resource defines a system-level or an application-level diagnostic resource.

A system-level WLDF resource is a diagnostic resource whose scope is system-wide; its descriptor file, by default, resides in the DOMAIN_NAME/config/diagnostics directory.

An application-level WLDF resource is a diagnostic resource whose scope is application-wide; its descriptor file, weblogic-diagnostics.xml is contained within the application archive.

Returns:

root bean of the WLDF descriptor

getDescriptorFileName

String getDescriptorFileName()

The name of the descriptor file that contains the XML configuration information for this system-level resource. The location of this file is a relative path rooted at DOMAIN_DIR/config. By default the file resides in the DOMAIN_DIR/config/diagnostics directory, and derives its name from the bean name using the following pattern:

<beanName>.xml

Note that the filename is a read-only property, which is set when the WLDF resource is created.

Specified by:

getDescriptorFileName in interface ConfigurationExtensionMBean

Returns:

name of descriptor file

getDescription

String getDescription()

Optional short description of this WLDFSystemResource. If provided, the WebLogic Server Administration Console will display the resource description.

Returns:

The WLDFSystemResource description

Default Value:

null

setDescription

void setDescription(String description)
             throws InvalidAttributeValueException

Sets the value of the Description attribute.

Parameters:

description - The new WLDFSystemResource description

Throws:

InvalidAttributeValueException

See Also:

WLDFSystemResourceMBean.getDescription()