weblogic.management.configuration
Interface ConfigurationMBean

All Known Subinterfaces:

AdminServerMBean, ApplicationMBean, BridgeDestinationCommonMBean, BridgeDestinationMBean, ClassDeploymentMBean, ClusterMBean, COMMBean, ComponentMBean, ConfigurationExtensionMBean, ConnectorComponentMBean, ContextCaseMBean, DeploymentConfigurationMBean, DeploymentMBean, DomainLogFilterMBean, DomainMBean, DomainTargetedMBean, EJBComponentMBean, EJBContainerMBean, EmbeddedLDAPMBean, ErrorHandlingMBean, ExecuteQueueMBean, ForeignJMSServerMBean, ForeignJNDILinkMBean, ForeignJNDIProviderMBean, HTTPProxyMBean, IIOPMBean, JDBCConnectionPoolMBean, JDBCDataSourceFactoryMBean, JDBCDataSourceMBean, JDBCMultiPoolMBean, JDBCSystemResourceMBean, JDBCTxDataSourceMBean, JMSBridgeDestinationMBean, JMSConnectionConsumerMBean, JMSConnectionFactoryMBean, JMSDestCommonMBean, JMSDestinationKeyMBean, JMSDestinationMBean, JMSDistributedDestinationMBean, JMSDistributedDestinationMemberMBean, JMSDistributedQueueMBean, JMSDistributedQueueMemberMBean, JMSDistributedTopicMBean, JMSDistributedTopicMemberMBean, JMSFileStoreMBean, JMSInteropModuleMBean, JMSJDBCStoreMBean, JMSMessageLogFileMBean, JMSQueueMBean, JMSServerMBean, JMSSessionPoolMBean, JMSStoreMBean, JMSSystemResourceMBean, JMSTemplateMBean, JMSTopicMBean, JMSVirtualDestinationMBean, JMXMBean, JoltConnectionPoolMBean, JTAMBean, JTAMigratableTargetMBean, KernelMBean, LogFileMBean, MachineMBean, MailSessionMBean, MessagingBridgeMBean, MigratableTargetMBean, MinThreadsConstraintMBean, NetworkAccessPointMBean, NetworkChannelMBean, NodeManagerMBean, OverloadProtectionMBean, PathServiceMBean, RemoteSAFContextMBean, RMCFactoryMBean, SecurityConfigurationMBean, SecurityMBean, SelfTuningMBean, ServerFailureTriggerMBean, ServerMBean, ServerStartMBean, ShutdownClassMBean, SNMPAgentMBean, SNMPAttributeChangeMBean, SNMPCounterMonitorMBean, SNMPGaugeMonitorMBean, SNMPJMXMonitorMBean, SNMPLogFilterMBean, SNMPProxyMBean, SNMPStringMonitorMBean, SNMPTrapDestinationMBean, SNMPTrapSourceMBean, SSLMBean, StartupClassMBean, SubDeploymentMBean, SystemResourceMBean, TargetInfoMBean, TargetMBean, UnixMachineMBean, VirtualDestinationMBean, VirtualHostMBean, WebAppComponentMBean, WebAppContainerMBean, WebDeploymentMBean, WebServerLogMBean, WebServerMBean, WebServiceComponentMBean, WLECConnectionPoolMBean, WSReliableDeliveryPolicyMBean, WTCExportMBean, WTCImportMBean, WTCLocalTuxDomMBean, WTCPasswordMBean, WTCRemoteTuxDomMBean, WTCResourcesMBean, WTCServerMBean, WTCtBridgeGlobalMBean, WTCtBridgeRedirectMBean, XMLEntityCacheMBean, XMLEntitySpecRegistryEntryMBean, XMLParserSelectRegistryEntryMBean, XMLRegistryEntryMBean, XMLRegistryMBean

public interface ConfigurationMBean

The tagging interface for configuration MBeans.

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

DEFAULT_EMPTY_BYTE_ARRAY

static final byte[] DEFAULT_EMPTY_BYTE_ARRAY

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

setName

void setName(String name)
             throws InvalidAttributeValueException,
                    ManagementException

Sets the value of the Name attribute.

Throws:

InvalidAttributeValueException

ManagementException

This method can NOT set a null value.

This method can NOT set a value of zero length.

getNotes

String getNotes()

Optional information that you can include to describe this configuration.

WebLogic Sever saves this note in the domain's configuration file (config.xml) as XML PCDATA. All left angle brackets (<) are converted to the XML entity <. Carriage returns/line feeds are preserved.

Note:

If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.

Returns:

The notes value

setNotes

void setNotes(String notes)
              throws InvalidAttributeValueException,
                     DistributedManagementException

Sets the Notes attribute of the ConfigurationMBean object

Parameters:

notes - The new notes value

Throws:

InvalidAttributeValueException

DistributedManagementException

setPersistenceEnabled

void setPersistenceEnabled(boolean persist)

Deprecated. 9.0.0.0

Sets the persistenceEnabled attribute of the ConfigurationMBean object

Parameters:

persist - The new persistenceEnabled value

setDefaultedMBean

void setDefaultedMBean(boolean defaulted)

Deprecated. 9.0.0.0

Sets the defaultedMBean attribute of the ConfigurationMBean object

Parameters:

defaulted - The new defaultedMBean value

setComments

void setComments(String comments)

Sets the comments attribute of the ConfigurationMBean object

Parameters:

comments - The new comments value

freezeCurrentValue

void freezeCurrentValue(String attributeName)
                        throws AttributeNotFoundException,
                               MBeanException

Deprecated. 9.0.0.0

If the specified attribute has not been set explicitly, and if the attribute has a default value, this operation forces the MBean to persist the default value.

Unless you use this operation, the default value is not saved and is subject to change if you update to a newer release of WebLogic Server. Invoking this operation isolates this MBean from the effects of such changes.

Note:

To insure that you are freezing the default value, invoke the restoreDefaultValue operation before you invoke this.

This operation has no effect if you invoke it on an attribute that does not provide a default value or on an attribute for which some other value has been set.

Parameters:

attributeName -

Throws:

AttributeNotFoundException

MBeanException

restoreDefaultValue

void restoreDefaultValue(String attributeName)
                         throws AttributeNotFoundException

Deprecated. 9.0.0.0

If the specified attribute has a default value, this operation removes any value that has been set explicitly and causes the attribute to use the default value.

Default values are subject to change if you update to a newer release of WebLogic Server. To prevent the value from changing if you update to a newer release, invoke the freezeCurrentValue operation.

This operation has no effect if you invoke it on an attribute that does not provide a default value or on an attribute that is already using the default.

Parameters:

attributeName -

Throws:

AttributeNotFoundException

isSet

boolean isSet(String propertyName)

Returns true if the specified attribute has been set explicitly in this MBean instance.

Parameters:

propertyName - property to check

Returns:

true if set, false if default

unSet

void unSet(String propertyName)

Restore the given property to its default value.

Parameters:

propertyName - property to restore

Throws:

UnsupportedOperationException - if called on a runtime implementation.