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

Part Number E41849-02

Package weblogic.management.configuration

Contains classes and interfaces for configuring a WebLogic Server domain.

See:
          Description

Interface Summary
AdminConsoleMBean AdminConsoleMBean is a console specific MBean to configure weblogic administration console attributes.
AdminServerMBean Deprecated. 9.0.0.0
AppDeploymentMBean This MBean is used to configure all physical package types which can be deployed on a WebLogic domain, for instance, EAR files and standalone Java EE and non-Java EE modules.
ApplicationMBean Deprecated. 9.0.0.0 Replaced by AppDeploymentMBean
AuthConfigProviderMBean  
AuthModuleMBean  
BasicDeploymentMBean This bean represents a file or archive that is deployed to a set of targets in the domain.
BasicRealmMBean This MBean is the base class for alternative security realms.
BridgeDestinationCommonMBean This MBean represents a bridge destination for a messaging bridge instance.
BridgeDestinationMBean Deprecated. 9.0.0.0 Replaced with nothing (upgrade to JMSBridgeDestination if it maps to a JMS destination).
CacheAsyncListenersMBean  
CacheExpirationMBean  
CacheLoaderMBean  
CacheMBean  
CacheStoreMBean  
CacheTransactionMBean  
CapacityMBean CapacityMBean defines the maximum number of requests that can be enqueued by all the work managers that share it.
CertRevocCaMBean This MBean represents the configuration of certificate revocation checking for a specific certificate authority.
CertRevocMBean This MBean represents the configuration of the certificate revocation checking across all certificate authorities.
ClassDeploymentMBean Temporary MBean for startup and shutdown classes.
ClusterMBean This bean represents a cluster in the domain.
CoherenceCacheConfigMBean Information that represents a Coherence cache configuration.
CoherenceClusterSystemResourceMBean This bean defines a system-level Coherence cluster resource.
CoherenceManagementClusterMBean This class is used to hold JMX information about a coherence cluster in both the standalone case and WLS managed cluster case.
CoherenceManagementJMXAddressMBean This class holds the JMX connection information needed to connect to a management server.
CoherenceMemberConfigMBean This class represents Coherence Operational Configuration for a WLS Server that is part of a Coherence Cluster.
CoherenceServerMBean This class represents a Coherence stand-alone server.
CoherenceServerStartMBean This bean is used to configure the attributes necessary to start up a server on a remote machine.
CoherenceTierMBean This class represents Coherence Tier.
COMMBean This bean represents the server-wide configuration of COM
CommonLogMBean Configures the basic configuration for the logging system.
ComponentMBean Deprecated. 9.0.0.0 in favor of AppDeploymentMBean
ConfigurationExtensionMBean This MBean is a reference to a system configuration extension.
ConfigurationMBean The tagging interface for configuration MBeans.
ConfigurationPropertyMBean Encapsulates information about a property, such as its value and whether it is encrypted.
ConnectorComponentMBean Deprecated. 9.0.0.0 in favor of AppDeploymentMBean
ContextCaseMBean This mbean defines the mapping between the current context (security principal, group etc) and the request class to use.
ContextRequestClassMBean This mbean defines the mapping between the current context (security principal, group) and the request class to use.
CustomAuthConfigProviderMBean  
CustomResourceMBean A CustomResource is an untyped SystemResource for which creator of the bean defines the name of the class that will be used when the resource is deployed on the managed server.
DatabaseLessLeasingBasisMBean DatabaseLessLeasingBasisMBean defines attributes related to the functioning of singleton services and server migration without the use of a HA database.
DataSourceLogFileMBean Defines the logging configuration for a DataSource.
DataSourceMBean This bean represents a DataSource within a Weblogic Server instance.
DebugMBean The parent interface for the kernel and server debug mbeans.
DebugScopeMBean This interface captures whether the enabled state of a debug scope.
DefaultFileStoreMBean This MBean describes the configuration of the default file store.
DeploymentConfigurationMBean Specifies the domain-level deployment configuration attributes.
DeploymentMBean A Deployment is any MBean that may be deployed on one or more targets, such as a Component, a Web Server personality, a JMS Front-end or back-end or a JDBC connection pool.
DeploymentValidationPluginMBean Specifies the deployment validation plug-in configuration attributes.
DomainLogFilterMBean Deprecated. 9.0.0.0 Replaced by LogFilterMBean
DomainMBean A WebLogic Domain is a group of servers and/or clusters which are administered as a group.
DomainTargetedMBean This is a marker interface for TargetInfoMBeans (and their descendants) that are targeted to the entire domain.
DynamicServersMBean Contains the properties used to control how dynamic servers are created.
EJBComponentMBean Deprecated. 9.0.0.0 in favor of AppDeploymentMBean
EJBContainerMBean This MBean is used to specify EJB container-wide settings.
EmbeddedLDAPMBean The MBean that defines the configuration properties for the embedded LDAP server for the WebLogic domain.
ErrorHandlingMBean Error Handling MBean
ExecuteQueueMBean This bean is used to configure an execute queue and its associated thread pool.
FairShareRequestClassMBean This mbean defines the fair share value to use for this request class.
FederationServicesMBean This MBean represents configuration for SAML 1.1-based Federation Services, including the intersite transfer service, assertion consumer service, and assertion retrieval service.
FileStoreMBean Defines an instance of the persistent store on the specified target that will keep its persistent objects in files on the filesystem.
ForeignJMSConnectionFactoryMBean Deprecated. 9.0.0.0 Replaced by the ForeignConnectionFactoryBean type in the new JMS module.
ForeignJMSDestinationMBean Deprecated. 9.0.0.0 Replaced by the ForeignDestinationBean type in the new JMS module.
ForeignJMSServerMBean Deprecated. 9.0.0.0 Replaced by the ForeignServerBean type in the new JMS module.
ForeignJNDILinkMBean This class represents a JNDI link that is outside the WebLogic server.
ForeignJNDIProviderMBean This class represents a JNDI provider that is outside the WebLogic server.
GenericFileStoreMBean This MBean defines common parameters for file stores.
GenericJDBCStoreMBean This MBean defines the parameters for the JDBC store.
HTTPProxyMBean This class represents the HTTP proxy configuration.
IIOPMBean Configuration for IIOP properties.
JASPICMBean Provides configuration for JASPIC (JSR-196) Auth Config Providers on the domain.
JDBCConnectionPoolMBean Deprecated. 9.0.0.0 Replaced by JDBCSystemResourceMBean
JDBCDataSourceFactoryMBean Deprecated. 9.0.0.0 Replaced by AppDeploymentMBean
JDBCDataSourceMBean Deprecated. 9.0.0.0 Replaced by JDBCSystemResourceMBean
JDBCMultiPoolMBean Deprecated. 9.0.0.0 Replaced by JDBCSystemResourceMBean
JDBCStoreMBean Defines an instance of the persistent store that stores its persistent records in a JDBC-accessible database.
JDBCSystemResourceMBean This bean defines a system-level JDBC resource.
JDBCTxDataSourceMBean Deprecated. 9.0.0.0 Replaced by JDBCSystemResourceMBean
JMSBridgeDestinationMBean This MBean represents a messaging bridge destination for a JMS messaging product.
JMSConnectionConsumerMBean Deprecated. 9.0.0.0 This functionality will be removed in a future release.
JMSConnectionFactoryMBean Deprecated. 9.0.0.0 Replaced by JMSConnectionFactoryBean
JMSConstants This class holds the JMS constant property/attribute names and values.
JMSDestCommonMBean Deprecated. 9.0.0.0 Replaced by DestinationBean
JMSDestinationKeyMBean Deprecated. 8.1.0.0 Replaced by DestinationKeyBean
JMSDestinationMBean Deprecated. 9.0.0.0 Replaced by DestinationBean
JMSDistributedDestinationMBean Deprecated. 9.0.0.0 Replaced by and weblogic.j2ee.descriptor.wl.UnifrormDistributedDestinationBean
JMSDistributedDestinationMemberMBean Deprecated. 9.0.0.0 Replaced by DistributedDestinationMemberBean
JMSDistributedQueueMBean Deprecated. 9.0.0.0 Replaced by DistributedQueueBean
JMSDistributedQueueMemberMBean Deprecated. 9.0.0.0 Replaced by DistributedDestinationMemberBean
JMSDistributedTopicMBean Deprecated. 9.0.0.0 Replaced by DistributedTopicBean
JMSDistributedTopicMemberMBean Deprecated. 9.0.0.0 Replaced by DistributedDestinationMemberBean
JMSFileStoreMBean Deprecated. 9.0.0.0 Replaced by FileStoreMBean
JMSInteropModuleMBean This bean defines a system-level JMS resource.
JMSJDBCStoreMBean Deprecated. 9.0.0.0 Replaced by JDBCStoreMBean
JMSMessageLogFileMBean This defines the configuration aspects of the logs for a jms server.
JMSQueueMBean Deprecated. 9.0.0.0 Replaced by QueueBean
JMSSAFMessageLogFileMBean This defines the configuration aspects of the logs for a jms server.
JMSServerMBean This class represents a JMS server.
JMSSessionPoolMBean Deprecated. 9.0.0.0 Replaced with message-dirven beans.
JMSStoreMBean Deprecated. 9.0.0.0 Replaced by PersistentStoreMBean
JMSSystemResourceMBean This bean defines a system-level JMS resource.
JMSTemplateMBean Deprecated. 9.0.0.0 Replaced by TemplateBean
JMSTopicMBean Deprecated. 9.0.0.0 Replaced by TopicBean
JMSVirtualDestinationMBean Deprecated. 9.0.0.0 Replaced by DistributedDestinationBean
JMXMBean Controls which JMX agents are initialized in the current WebLogic Server domain.
JoltConnectionPoolMBean This bean defines a Jolt connection pool.
JPAMBean This interface provides access to the JPA configuration attributes.
JTAClusterMBean This interface provides access to the JTA configuration attributes.
JTAMBean This interface provides access to the JTA configuration attributes.
JTAMigratableTargetMBean The target that is used internally to register the JTA recovery manager to the Migration Manager.
KernelDebugMBean Defines the debug attributes that are common to WebLogic Server and Client.
KernelMBean This bean represents the configuration of the core message passing kernel on both WebLogic clients and servers.
LibraryMBean Configuration bean for Libraries.
LogFileMBean Configures the location, file-rotation criteria, and number of files that a WebLogic Server uses to store log messages.
LogFilterMBean This MBean represents a filter to qualify log messages which are selected by the specified filter expression criteria.
LogMBean Configures the threshold severity level and filter settings for logging output.
MachineMBean This bean represents a machine on which servers may be booted.
MailSessionMBean Facilitates using the JavaMail APIs, which provide applications and other Java EE modules with access to Internet Message Access Protocol (IMAP)- and Simple Mail Transfer Protocol (SMTP)-capable mail servers on your network or the Internet.
ManagedExternalServerMBean Used to configure an external server that can be managed by Node Manager.
ManagedExternalServerStartMBean This bean is used to configure the attributes necessary to start up a server on a remote machine.
MaxThreadsConstraintMBean This MBean defines the max number of concurrent threads that can execute requests sharing this max constraint.
MessagingBridgeMBean This MBean represents a WebLogic messaging bridge.
MigratableTargetMBean A target that is suitable for services that shall be active on at most one server of a cluster at a time.
MinThreadsConstraintMBean This MBean defines the minimum number of concurrent threads that should allocated to this constraint provided there are enough pending requests.
NetworkAccessPointMBean A server can specifiy additional network connections by using a NetworkAccessPointMBean.
NetworkChannelMBean Deprecated. 7.0.0.0 use NetworkAccessPointMBean
NodeManagerMBean This bean is represents a Node Manager that is associated with a machine.
OsgiFrameworkMBean An MBean representing an OSGi framework.
OverloadProtectionMBean This Mbean has attributes concerning server overload protection.
ParameterMBean Specifies the parameters used to configure the DeploymentValidationPluginMBean.
PathServiceMBean This class represents a path service.
PersistentStoreMBean This MBean is the parent of the GenericFileStoreMBean and GenericJDBCStoreMBean.
RemoteEnumeration  
RemoteSAFContextMBean Fake RemoteSAFContextMBean
ReplicatedStoreMBean Defines an instance of a Replicated Store.
ResponseTimeRequestClassMBean This MBean defines the response time goal for this request class.
RestfulManagementServicesMBean Controls the configuration of the RESTful Management Services interfaces to WebLogic Server.
RMCFactoryMBean Represents a Java EE resource manager connection factory in a Java EE app.
SAFAgentMBean This class represents a Store-and-Forward (SAF) agent.
SecurityConfigurationMBean Provides domain-wide security configuration information.
SecurityMBean Deprecated. 9.0.0.0 Replaced by SecurityConfigurationMBean
SelfTuningMBean SelfTuningMBean holds global work manager component mbeans.
ServerDebugMBean Defines the debug attributes that are specific to WebLogic Server.
ServerFailureTriggerMBean Configuration to mark the server as failed when threads are stuck.
ServerMBean This class represents a individual WebLogic Server.
ServerStartMBean This bean is used to configure the attributes necessary to start up a server on a remote machine.
ServerTemplateMBean This class represents a WebLogic Server.
ShutdownClassMBean Provides methods for configuring a shutdown class.
SingleSignOnServicesMBean This MBean represents configuration for SAML 2.0-based local site Single Sign-On Services.
SingletonServiceAppScopedMBean A service that will be automatically maintained as a Singleton in a cluster.
SingletonServiceBaseMBean A service that will be automatically maintained as a Singleton in a cluster.
SingletonServiceMBean A service that will be automatically maintained as a Singleton in a cluster.
SNMPAgentDeploymentMBean This MBean is an SNMP agent that can be targeted to instances of WebLogic Server.
SNMPAgentMBean This singleton MBean represents an SNMP agent that is scoped to a WebLogic Server domain.
SNMPAttributeChangeMBean This class describes the settings to receive MBean-attribute change notification.
SNMPCounterMonitorMBean This class describes the criteria for a Counter-based Monitor.
SNMPGaugeMonitorMBean This class describes the criteria for a Gauge-based Monitor.
SNMPJMXMonitorMBean This is a base class for Monitor based trap configuration MBeans : SNMPCounterMonitorMBean, SNMPStringMonitorMBean and SNMPGaugeMonitorMBean.
SNMPLogFilterMBean This MBean represents a filter to qualify log messages which are logged to the server logfile.
SNMPProxyMBean This MBean represents an SNMP agent that is proxied by a WebLogic Server SNMP agent.
SNMPStringMonitorMBean This class describes the criteria for a String-based Monitor.
SNMPTrapDestinationMBean This MBean describes a destination to which an SNMP agent sends SNMP TRAP and INFORM notifications.
SNMPTrapSourceMBean This MBean is the base of SNMP TRAP related configuration MBeans.
SSLMBean This MBean represents the configuration of the SSL protocol.
StartupClassMBean Provides methods that configure startup classes.
SubDeploymentMBean This bean represents an individually targetable entity within a deployment package, which is deployable on WLS.
SystemComponentMBean  
SystemComponentStartMBean The NodeManager does not directly create the command to start a SystemComponent.
SystemResourceMBean A system resource is a resource whose definition is part of the system configuration rather than an application.
TargetInfoMBean This bean represents any weblogic entity which can be targeted.
TargetMBean A tagging interface that designates a class as a target for deployment of a AppDeploymentMBean.
TransactionLogJDBCStoreMBean This class represents a Transaction Log JDBC Store configuration.
TransactionLogStoreMBean  
UnixMachineMBean This bean represents a machine that is running the UNIX operating system.
VirtualDestinationMBean This class represents a virtual destination.
VirtualHostMBean This bean represents the configuration of virtual web server within a WebLogic Server instance.
WebAppComponentMBean Deprecated. 9.0.0.0 in favor of AppDeploymentMBean
WebAppContainerMBean This MBean is used to specify domain-wide defaults for the WebApp container.
WebDeploymentMBean A Web Deployment is any MBean that may be deployed on one or more target or WebServers.
WebServerLogMBean Aggregates the logging attributes for the WebServerMBean.
WebServerMBean This bean represents the configuration of virtual web server within a weblogic server.
WebServiceBufferingMBean Represents buffering configuration for web services.
WebServiceBufferingQueueMBean Represents buffering queue configuration for web services (either for requests or responses).
WebServiceComponentMBean Deprecated. 9.0.0.0 in favor of AppDeploymentMBean
WebserviceCredentialProviderMBean Encapsulates information about a particular credential provider that has been configured for a Web Service security configuration.
WebServiceLogicalStoreMBean Represents a logical store for web services.
WebServiceMBean Encapsulates information about a Web Service configuration.
WebServicePersistenceMBean Represents persistence configuration for web services.
WebServicePhysicalStoreMBean Represents a physical store for web services.
WebServiceReliabilityMBean Represents reliability configuration for web services.
WebServiceRequestBufferingQueueMBean Represents request buffering queue configuration for web services.
WebServiceResponseBufferingQueueMBean Represents response buffering queue configuration for web services.
WebserviceSecurityConfigurationMBean Encapsulates information about a Web Service security configuration.
WebserviceSecurityMBean Encapsulates information about a Web Service security configuration.
WebserviceSecurityTokenMBean Encapsulates information about a particular token that has been configured for a Web Service security configuration.
WebserviceTestpageMBean Controls the configuration of the Web Service Test Page.
WebserviceTimestampMBean Encapsulates the timestamp information that is associated with a Web Service security configuration.
WebserviceTokenHandlerMBean Encapsulates information about a particular token handler that has been configured for a Web Service security configuration.
WLDFDataRetirementByAgeMBean This MBean specifies how data retirement for a WLDF archive will be performed based on the age of records in WLDF archives.
WLDFDataRetirementMBean This MBean specifies how data retirement for a WLDF archive will be performed.
WLDFServerDiagnosticMBean Use this interface to configure the WebLogic Diagnostic Framework (WLDF) components that are defined for each WebLogic Server instance.
WLDFSystemResourceMBean This bean defines a system-level WebLogic Diagnostic Framework (WLDF) resource.
WLECConnectionPoolMBean This bean defines a WLEC connection pool.
WLSAuthConfigProviderMBean  
WorkManagerMBean Configuration MBean representing WorkManager parameters.
WorkManagerShutdownTriggerMBean This MBean is used to configure the trigger that shuts down the WorkManager.
WSReliableDeliveryPolicyMBean This class represents the reliable messaging delivery policy for the current WebLogic Server as both a sender and a receiver of a reliable SOAP message to and from a Web service running on a different WebLogic Server.
WTCExportMBean This interface provides access to the WTC export configuration attributes.
WTCImportMBean This interface provides access to the WTC import configuration attributes.
WTCLocalTuxDomMBean This interface provides access to the WTC local Tuxedo Domain configuration attributes.
WTCPasswordMBean This interface provides access to the WTC password configuration attributes.
WTCRemoteTuxDomMBean This interface provides access to the WTC remote Tuxedo Domain configuration attributes.
WTCResourcesMBean This interface provides access to the WTC resources configuration attributes.
WTCServerMBean This MBean defines a WTC Server.
WTCtBridgeGlobalMBean This interface provides access to the WTC tBridge Global configuration attributes.
WTCtBridgeRedirectMBean This interface provides access to the WTC tBridge Redirect configuration attributes.
XMLEntityCacheMBean Configure the behavior of JAXP (Java API for XML Parsing) in the server.
XMLEntitySpecRegistryEntryMBean An Entity Spec Entry specifies how to resolve an external entity based its public and system IDs.
XMLParserSelectRegistryEntryMBean A Parser Select Entry specifies the SAX/DOM parser factory implementation classes for a particular document type.
XMLRegistryEntryMBean Deprecated. 7.0.0.0 replaced by XMLRegistryMBean.
XMLRegistryMBean Configure the behavior of JAXP (Java API for XML Parsing) in the server.
 

Class Summary
ListResults  
NMPasswordValidator  
 

Exception Summary
ConfigurationException  
OutOfDateConfigurationException  
 

Package weblogic.management.configuration Description

Contains classes and interfaces for configuring a WebLogic Server domain. All interfaces in this package are Dynamic Managed Beans (javax.management.DynamicMBean), as defined by the Sun Microsystems, Inc. Java Management Extensions (JMX) 1.0 specification.

In addition, all MBeans in this package extend ConfigurationMBean.

To change the configuration of a WebLogic Server resource, you modify the values in the Configuration MBeans, which are hosted on the domain's Administration Server. The Administration Server saves these changes to the domain's config.xml file.

To enhance performance, each Managed Server creates local replicas of the Configuration MBeans for its own managed resources. Oracle recommends that you change only the values of Configuration MBeans on the Administration Server (Administration MBeans). Do not change attribute values in the local MBean replicas (Local Configuration MBeans).

To look up a Configuration MBean:

  1. Use the Helper class to look up weblogic.management.MBeanHome on the Administration Server.

    Alternately, you can use Environment and javax.naming.Context to look up the MBeanHome interface from a server instance's JNDI tree.

  2. Use MBeanHome to retrieve a type-safe stub for the MBean, which makes it appear as though you can invoke an MBean's methods directly.

    Alternately, you can use the weblogic.management.MBeanHome interface to look up the RemoteMBeanServer interface or the standard JMX MBeanServer interface. With these interfaces, you use standard JMX techniques for invoking operations on MBeans.

Package Specification

The classes and interfaces in this package implement the Sun Microsystems, Inc. Java Management Extensions (JMX) 1.0 specification to provide open and extensible management services. WebLogic Server adds its own set of convenience methods and other extensions to facilitate working in the WebLogic Server distributed environment.

You can download the JMX 1.0 specification and API documentation from http://jcp.org/aboutJava/communityprocess/final/jsr003/index.html.

Related Documentation

For overviews, examples, and guides, please see:

Deprecation of MBeanHome and Type-Safe Interfaces

The classes in this package are type-safe interfaces for WebLogic Server MBeans, 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" on http://www.oracle.com/technology/products/weblogic/index.html.

See Also:
WebLogicObjectName

Copyright 1996, 2014, 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.3)

Part Number E41849-02