Package weblogic.management.configuration

Interface ConfigurationMBean

All Superinterfaces:

DescriptorBean, javax.management.DynamicMBean, javax.management.MBeanRegistration, javax.management.NotificationBroadcaster, SettableBean, WebLogicMBean

All Known Subinterfaces:

AdminConsoleMBean, AdminServerMBean, AppDeploymentMBean, ApplicationMBean, AuthConfigProviderMBean, AuthModuleMBean, BaseExecutorServiceMBean, BaseThreadFactoryMBean, BasicDeploymentMBean, BatchConfigMBean, BridgeDestinationCommonMBean, BridgeDestinationMBean, CacheAsyncListenersMBean, CacheExpirationMBean, CacheLoaderMBean, CacheMBean, CacheStoreMBean, CacheTransactionMBean, CapacityMBean, CdiContainerMBean, CertRevocCaMBean, CertRevocMBean, ClassDeploymentMBean, ClusterMBean, CoherenceCacheConfigMBean, CoherenceClusterSystemResourceMBean, CoherenceManagementAddressProviderMBean, CoherenceManagementClusterMBean, CoherenceMemberConfigMBean, CoherencePartitionCacheConfigMBean, CoherencePartitionCachePropertyMBean, CoherenceServerMBean, CoherenceServerStartMBean, CoherenceTierMBean, COMMBean, CommonLogMBean, ComponentMBean, ConfigurationExtensionMBean, ConfigurationPropertiesMBean, ConfigurationPropertyMBean, ConnectorComponentMBean, ContextCaseMBean, ContextRequestClassMBean, CpuUtilizationMBean, CustomAuthConfigProviderMBean, CustomResourceMBean, DatabaseLessLeasingBasisMBean, DatasourceInterceptorMBean, DataSourceLogFileMBean, DataSourceMBean, DataSourcePartitionMBean, DebugMBean, DebugPatchesMBean, DebugScopeMBean, DefaultFileStoreMBean, DeploymentConfigurationMBean, DeploymentMBean, DeploymentValidationPluginMBean, DomainMBean, DomainTargetedMBean, DynamicDeploymentMBean, DynamicServersMBean, EJBComponentMBean, EJBContainerMBean, EmbeddedLDAPMBean, ExecuteQueueMBean, FairShareConstraintMBean, FairShareRequestClassMBean, FederationServicesMBean, FileOpenMBean, FileStoreMBean, ForeignConnectionFactoryOverrideMBean, ForeignDestinationOverrideMBean, ForeignJMSConnectionFactoryMBean, ForeignJMSDestinationMBean, ForeignJMSServerMBean, ForeignJNDILinkMBean, ForeignJNDILinkOverrideMBean, ForeignJNDIObjectMBean, ForeignJNDIProviderMBean, ForeignJNDIProviderOverrideMBean, ForeignServerOverrideMBean, GenericFileStoreMBean, GenericJDBCStoreMBean, GzipCompressionMBean, HeapRetainedMBean, HTTPProxyMBean, IIOPMBean, InterceptorMBean, InterceptorsMBean, JASPICMBean, JDBCPropertyOverrideMBean, JDBCStoreMBean, JDBCSystemResourceMBean, JDBCSystemResourceOverrideMBean, JMSBridgeDestinationMBean, JMSConnectionConsumerMBean, JMSConnectionFactoryMBean, JMSDestCommonMBean, JMSDestinationKeyMBean, JMSDestinationMBean, JMSDistributedDestinationMBean, JMSDistributedDestinationMemberMBean, JMSDistributedQueueMBean, JMSDistributedQueueMemberMBean, JMSDistributedTopicMBean, JMSDistributedTopicMemberMBean, JMSFileStoreMBean, JMSInteropModuleMBean, JMSJDBCStoreMBean, JMSMessageLogFileMBean, JMSQueueMBean, JMSSAFMessageLogFileMBean, JMSServerMBean, JMSSessionPoolMBean, JMSStoreMBean, JMSSystemResourceMBean, JMSSystemResourceOverrideMBean, JMSTemplateMBean, JMSTopicMBean, JMSVirtualDestinationMBean, JMXMBean, JoltConnectionPoolMBean, JPAMBean, JTAClusterMBean, JTAMBean, JTAMigratableTargetMBean, JTAPartitionMBean, KernelDebugMBean, KernelMBean, LibraryMBean, LifecycleManagerConfigMBean, LifecycleManagerEndPointMBean, LogFileMBean, LogFilterMBean, LogMBean, MachineMBean, MailSessionMBean, MailSessionOverrideMBean, ManagedExecutorServiceTemplateMBean, ManagedExternalServerMBean, ManagedExternalServerStartMBean, ManagedScheduledExecutorServiceTemplateMBean, ManagedThreadFactoryTemplateMBean, MaxThreadsConstraintMBean, MessagingBridgeMBean, MigratableTargetMBean, MinThreadsConstraintMBean, NetworkAccessPointMBean, NetworkChannelMBean, NodeManagerMBean, OptionalFeatureDeploymentMBean, OptionalFeatureMBean, OsgiFrameworkMBean, OverloadProtectionMBean, ParameterMBean, PartitionFileSystemMBean, PartitionLogMBean, PartitionMBean, PartitionPropertyMBean, PartitionUserFileSystemMBean, PartitionWorkManagerMBean, PathServiceMBean, PersistentStoreMBean, PostProcessorScriptMBean, PreProcessorScriptMBean, RCMResourceFairShareMBean, RCMResourceMBean, ReplicatedStoreMBean, ResourceGroupMBean, ResourceGroupTemplateMBean, ResourceManagementMBean, ResourceManagerMBean, ResponseTimeRequestClassMBean, RestartLoopProtectionMBean, RestfulManagementServicesMBean, RMCFactoryMBean, SAFAgentMBean, ScriptInterceptorMBean, ScriptMBean, SecureModeMBean, SecurityConfigurationMBean, SelfTuningMBean, ServerDebugMBean, ServerFailureTriggerMBean, ServerMBean, ServerStartMBean, ServerTemplateMBean, ShutdownClassMBean, SingleSignOnServicesMBean, SingletonServiceAppScopedMBean, SingletonServiceBaseMBean, SingletonServiceMBean, SNMPAgentDeploymentMBean, SNMPAgentMBean, SNMPAttributeChangeMBean, SNMPCounterMonitorMBean, SNMPGaugeMonitorMBean, SNMPJMXMonitorMBean, SNMPLogFilterMBean, SNMPProxyMBean, SNMPStringMonitorMBean, SNMPTrapDestinationMBean, SNMPTrapSourceMBean, SSLMBean, StartupClassMBean, SubDeploymentMBean, SystemComponentMBean, SystemComponentStartMBean, SystemResourceMBean, TargetInfoMBean, TargetMBean, TLSMBean, TransactionLogJDBCStoreMBean, weblogic.management.configuration.TransactionLogStoreMBean, TriggerMBean, UnixMachineMBean, VirtualDestinationMBean, VirtualHostMBean, VirtualTargetMBean, WebAppComponentMBean, WebAppContainerMBean, WebDeploymentMBean, WebServerLogMBean, WebServerMBean, WebServiceBufferingMBean, WebServiceBufferingQueueMBean, WebServiceComponentMBean, WebserviceCredentialProviderMBean, WebServiceLogicalStoreMBean, WebServiceMBean, WebServicePersistenceMBean, WebServicePhysicalStoreMBean, WebServiceReliabilityMBean, WebServiceRequestBufferingQueueMBean, WebServiceResiliencyMBean, WebServiceResponseBufferingQueueMBean, WebserviceSecurityConfigurationMBean, WebserviceSecurityMBean, WebserviceSecurityTokenMBean, WebserviceTestpageMBean, WebserviceTimestampMBean, WebserviceTokenHandlerMBean, WLDFDataRetirementByAgeMBean, WLDFDataRetirementMBean, WLDFServerDiagnosticMBean, WLDFSystemResourceMBean, WLSAuthConfigProviderMBean, WorkManagerMBean, WorkManagerShutdownTriggerMBean, WSReliableDeliveryPolicyMBean, WTCExportMBean, WTCImportMBean, WTCLocalTuxDomMBean, WTCPasswordMBean, WTCRemoteTuxDomMBean, WTCResourcesMBean, WTCServerMBean, WTCtBridgeGlobalMBean, WTCtBridgeRedirectMBean, XMLEntityCacheMBean, XMLEntitySpecRegistryEntryMBean, XMLParserSelectRegistryEntryMBean, XMLRegistryEntryMBean, XMLRegistryMBean

public interface ConfigurationMBean
extends WebLogicMBean, DescriptorBean, SettableBean

The tagging interface for configuration MBeans.

Field Summary

Fields

Modifier and Type	Field	Description
static byte[]	DEFAULT_EMPTY_BYTE_ARRAY

Method Summary

Modifier and Type	Method	Description
void	freezeCurrentValue(java.lang.String attributeName)	Deprecated. 9.0.0.0
long	getId()	Return the unique id of this MBean instance
java.lang.String[]	getInheritedProperties(java.lang.String[] propertyNames)	Return all properties' names whose value is inherited from template mbean.
java.lang.String	getName()	The user-specified name of this MBean instance.
java.lang.String	getNotes()	Optional information that you can include to describe this configuration.
boolean	isDynamicallyCreated()	Return whether the MBean was created dynamically or is persisted to config.xml
boolean	isInherited(java.lang.String propertyName)	Check if the value of a property is inherited from template mbean or not.
boolean	isSet(java.lang.String propertyName)	Returns true if the specified attribute has been set explicitly in this MBean instance.
void	restoreDefaultValue(java.lang.String attributeName)	Deprecated. 9.0.0.0
void	setComments(java.lang.String comments)	Sets the comments attribute of the ConfigurationMBean object
void	setDefaultedMBean(boolean defaulted)	Deprecated. 9.0.0.0
void	setName(java.lang.String name)	Sets the value of the Name attribute.
void	setNotes(java.lang.String notes)	Sets the Notes attribute of the ConfigurationMBean object
void	setPersistenceEnabled(boolean persist)	Deprecated. 9.0.0.0
void	unSet(java.lang.String propertyName)	Restore the given property to its default value.

Methods inherited from interface weblogic.descriptor.DescriptorBean

addPropertyChangeListener, createChildCopyIncludingObsolete, getParentBean, isEditable, removePropertyChangeListener

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.management.WebLogicMBean

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

Field Detail

DEFAULT_EMPTY_BYTE_ARRAY

static final byte[] DEFAULT_EMPTY_BYTE_ARRAY

Method Detail

getName

java.lang.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 WebLogicMBean

setName

void setName(java.lang.String name)
      throws javax.management.InvalidAttributeValueException,
             ManagementException

Sets the value of the Name attribute.

Specified by:

setName in interface WebLogicMBean

Throws:

javax.management.InvalidAttributeValueException

ManagementException

This property cannot be null.

This property cannot have a value of length zero.

getNotes

java.lang.String getNotes()

Optional information that you can include to describe this configuration.

WebLogic Server 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

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

setNotes

void setNotes(java.lang.String notes)
       throws javax.management.InvalidAttributeValueException,
              DistributedManagementException

Sets the Notes attribute of the ConfigurationMBean object

Parameters:

notes - The new notes value

Throws:

javax.management.InvalidAttributeValueException

DistributedManagementException

Access limited to the following security roles:

Deployer, Operator

setPersistenceEnabled

@Deprecated
void setPersistenceEnabled(boolean persist)

Deprecated.

9.0.0.0

Sets the persistenceEnabled attribute of the ConfigurationMBean object

Parameters:

persist - The new persistenceEnabled value

setDefaultedMBean

@Deprecated
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(java.lang.String comments)

Sets the comments attribute of the ConfigurationMBean object

Parameters:

comments - The new comments value

freezeCurrentValue

@Deprecated
void freezeCurrentValue(java.lang.String attributeName)
                 throws javax.management.AttributeNotFoundException,
                        javax.management.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:

javax.management.AttributeNotFoundException

javax.management.MBeanException

restoreDefaultValue

@Deprecated
void restoreDefaultValue(java.lang.String attributeName)
                  throws javax.management.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:

javax.management.AttributeNotFoundException

isSet

boolean isSet(java.lang.String propertyName)

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

Specified by:

isSet in interface SettableBean

Parameters:

propertyName - property to check

Returns:

true if set, false if default

unSet

void unSet(java.lang.String propertyName)

Restore the given property to its default value.

Specified by:

unSet in interface SettableBean

Parameters:

propertyName - property to restore

Throws:

java.lang.UnsupportedOperationException - if called on a runtime implementation.

isInherited

boolean isInherited(java.lang.String propertyName)

Check if the value of a property is inherited from template mbean or not.

Parameters:

propertyName - the name of the property

Returns:

true if the value of the property is inherited from template mbean

Throws:

java.lang.IllegalArgumentException - if property is invalid

getInheritedProperties

java.lang.String[] getInheritedProperties(java.lang.String[] propertyNames)

Return all properties' names whose value is inherited from template mbean. this is a convenient method to get inheritance info on multiple properties in one jmx call.

Parameters:

propertyNames - properties to check

Returns:

properties's names whose value inherited

isDynamicallyCreated

boolean isDynamicallyCreated()

Return whether the MBean was created dynamically or is persisted to config.xml

Returns:

true if dynamically created, false otherwise.

Default Value:

false

getId

long getId()

Return the unique id of this MBean instance

Returns:

the id value