|
Oracle Fusion Middleware Java API Reference for Oracle WebLogic Server 12c (12.2.1) Part Number E55141-01 P4 Change 1723563 on 2015/10/09 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ServerRuntimeMBean
Provides methods for retrieving runtime information about a server instance and for transitioning a server from one state to another.
Field Summary |
---|
Fields inherited from interface weblogic.server.ServerStates |
---|
ACTIVATE_LATER, ADMIN, FAILED, FAILED_NOT_RESTARTABLE, FAILED_RESTARTING, FORCE_SHUTTING_DOWN, FORCE_SUSPENDING, RESUMING, RUNNING, SHUTDOWN, SHUTDOWN_IN_PROCESS, SHUTDOWN_PENDING, SHUTTING_DOWN, STANDBY, STARTING, SUSPENDING, UNKNOWN |
Method Summary | |
---|---|
abstract void |
forceShutdown() Force shutdown the server. |
abstract void |
forceShutdownResourceGroup(String resourceGroupName) Force shutdown the resource group. |
abstract void |
forceSuspend() Transitions the server from RUNNING to ADMIN state forcefully cancelling inflight work. |
abstract void |
forceSuspendResourceGroup(String resourceGroupName) Transitions the resource group from RUNNING to ADMIN state forcefully cancelling inflight work. |
abstract long |
getActivationTime() The time when the server was started. |
abstract int |
getAdministrationPort() Deprecated. 9.0.0.0 Replaced by ServerRuntimeMBean.getAdministrationURL() |
abstract String |
getAdministrationURL() The URL that the server and its clients use for administrative connections. |
abstract String |
getAdminServerHost() The address on which the Administration Server is listening for connections. |
abstract int |
getAdminServerListenPort() The port on which the Administration Server is listening for connections. |
abstract ApplicationRuntimeMBean[] |
getApplicationRuntimes() Returns the list of currently running Applications |
abstract AsyncReplicationRuntimeMBean |
getAsyncReplicationRuntime() Return an MBean which represents this server's view of its AsyncReplicationRuntime, if any. |
abstract ClassLoaderRuntimeMBean |
getClassLoaderRuntime() Get statistics for system-level class loading. |
abstract ClusterRuntimeMBean |
getClusterRuntime() Return an MBean which represents this server's view of its cluster, if any. |
abstract ConcurrentManagedObjectsRuntimeMBean |
getConcurrentManagedObjectsRuntime() The ConcurrentManagedObjectsRuntimeMBean for this server. |
abstract ConnectorServiceRuntimeMBean |
getConnectorServiceRuntime() The access point for server wide control and monitoring of the Connector Container. |
abstract String |
getCurrentDirectory() The absolute path of the directory from which the server was started. |
abstract String |
getCurrentMachine() Return the machine on which the server is running. |
abstract ExecuteQueueRuntimeMBean |
getDefaultExecuteQueueRuntime() Return an MBean which exposes this server's default execute queue. |
abstract String |
getDefaultURL() The URL that clients use to connect to this server's default network channel. |
abstract EntityCacheCumulativeRuntimeMBean |
getEntityCacheCumulativeRuntime() Return an MBean which represents Cumulative Status of the XML Cache. |
abstract EntityCacheCurrentStateRuntimeMBean |
getEntityCacheCurrentStateRuntime() Return an MBean which represents Current Status of the XML Cache. |
abstract EntityCacheCumulativeRuntimeMBean |
getEntityCacheHistoricalRuntime() Return an MBean which represents Historical Status of the XML Cache. |
abstract ExecuteQueueRuntimeMBean[] |
getExecuteQueueRuntimes() Returns an array of MBeans which exposes this server's active execute queues. |
abstract HealthState |
getHealthState() The health state of the server as reported by the server's self-health monitoring. |
abstract CompositeData |
getHealthStateJMX() The HealthState object returned as a CompositeData type. |
abstract String |
getIPv4URL(String protocol) The URL that clients use when connecting to this server using the specified protocol. |
abstract String |
getIPv6URL(String protocol) The URL that clients use when connecting to this server using the specified protocol. |
abstract JDBCServiceRuntimeMBean |
getJDBCServiceRuntime() The JDBCServiceRuntimeMBean for this server. |
abstract JMSRuntimeMBean |
getJMSRuntime() The JMSRuntimeMBean for this server. |
abstract JoltConnectionServiceRuntimeMBean |
getJoltRuntime() The JoltConnectionServiceRuntimeMBean for this server. |
abstract JTARuntimeMBean |
getJTARuntime() The transaction RuntimeMBean for this server. |
abstract JVMRuntimeMBean |
getJVMRuntime() The JVMRuntimeMBean for this server. |
abstract LibraryRuntimeMBean[] |
getLibraryRuntimes() Returns all deployed Libraries |
abstract String |
getListenAddress() Deprecated. 9.0.0.0 Replaced by ServerRuntimeMBean.getURL(java.lang.String) |
abstract int |
getListenPort() Deprecated. 9.0.0.0 Replaced by ServerRuntimeMBean.getURL(java.lang.String) |
abstract LogBroadcasterRuntimeMBean |
getLogBroadcasterRuntime() The object which generates notifications on behalf of the logging subystem. |
abstract LogRuntimeMBean |
getLogRuntime() Deprecated. 12.1.3.0 |
abstract MailSessionRuntimeMBean[] |
getMailSessionRuntimes() Return the runtimeMBeans for JavaMail Mail Sessions |
abstract MANAsyncReplicationRuntimeMBean |
getMANAsyncReplicationRuntime() Return an MBean which represents this server's view of its MANAsyncReplicationRuntime, if any. |
abstract MANReplicationRuntimeMBean |
getMANReplicationRuntime() Return an MBean which represents this server's view of its MANReplicationRuntime, if any. |
abstract MaxThreadsConstraintRuntimeMBean[] |
getMaxThreadsConstraintRuntimes() Returns an array of RuntimeMBeans which exposes this server's globally defined MaxThreadsConstraints. |
abstract MessagingBridgeRuntimeMBean |
getMessagingBridgeRuntime() Deprecated. 12.1.3.0 Replaced by ServerRuntimeMBean.getMessagingBridgeRuntimes() |
abstract MessagingBridgeRuntimeMBean[] |
getMessagingBridgeRuntimes() The MessagingBridgeRuntimeMBeans for this server |
abstract String |
getMiddlewareHome() The Oracle Middleware installation directory. |
abstract MinThreadsConstraintRuntimeMBean[] |
getMinThreadsConstraintRuntimes() Returns an array of RuntimeMBeans which exposes this server's globally defined MinThreadsConstraints. |
abstract String |
getName() The name of this configuration. |
abstract int |
getOpenSocketsCurrentCount() The current number of sockets registered for socket muxing on this server. |
abstract String |
getOracleHome() Deprecated. WLS can no longer find out what ORACLE_HOME is |
abstract HealthState |
getOverallHealthState() Determine the overall health state of this server, taking into account the health of each of its subsystems. |
abstract CompositeData |
getOverallHealthStateJMX() The overall health state of this server returned as a CompositeData type. |
abstract PathServiceRuntimeMBean |
getPathServiceRuntime() Deprecated. replaced by ServerRuntimeMBean.getPathServiceRuntimes() |
abstract PersistentStoreRuntimeMBean[] |
getPersistentStoreRuntimes() Returns the mbeans that provides runtime information for each PersistentStore. |
abstract RequestClassRuntimeMBean[] |
getRequestClassRuntimes() Returns an array of RuntimeMBeans which exposes this server's globally defined Request Classes. |
abstract int |
getRestartsTotalCount() Deprecated. This attribute always returns a value of 0. Please use ServerLifeCycleRuntimeMBean.getNodeManagerRestartCount() if the NodeManager is used to start servers |
abstract SAFRuntimeMBean |
getSAFRuntime() The SAFRuntimeMBean for this server. |
abstract InetSocketAddress |
getServerChannel(String protocol) The address on which this server is listening for connections that use the specified protocol. |
abstract ServerChannelRuntimeMBean[] |
getServerChannelRuntimes() The network channels that are currently configured on the server. |
abstract String |
getServerClasspath() Get the classpath for this server including domain/lib contents that are automatically picked up and appended to the classpath. |
abstract ServerLogRuntimeMBean |
getServerLogRuntime() Return the MBean which provides access to the control interface for WLS server logging. |
abstract ServerSecurityRuntimeMBean |
getServerSecurityRuntime() Return the ServerSecurityRuntimeMBean for this server. |
abstract SingleSignOnServicesRuntimeMBean |
getSingleSignOnServicesRuntime() Get the runtime interface to publish single sign-on services information. |
abstract SNMPAgentRuntimeMBean |
getSNMPAgentRuntime() Return the MBean which provides access to the monitoring statistics for WLS SNMP Agent. |
abstract long |
getSocketsOpenedTotalCount() Deprecated. Use ServerRuntimeMBean.getOpenSocketsCurrentCount() instead. Both methods return the same value. This method is being deprecated in favor of the other method. |
abstract String |
getSSLListenAddress() Deprecated. 9.0.0.0 Replaced by ServerRuntimeMBean.getURL(java.lang.String) |
abstract int |
getSSLListenPort() Deprecated. 9.0.0.0 Replaced by ServerRuntimeMBean.getURL(java.lang.String) |
abstract String |
getState() The current life cycle state of this server. |
abstract int |
getStateVal() Returns current state of the server as in integer. |
abstract ThreadPoolRuntimeMBean |
getThreadPoolRuntime() Get the self-tuning thread pool's runtime information. |
abstract TimerRuntimeMBean |
getTimerRuntime() Get the runtime information about the WebLogic timer implementation. |
abstract String |
getURL(String protocol) The URL that clients use when connecting to this server using the specified protocol. |
abstract WANReplicationRuntimeMBean |
getWANReplicationRuntime() Return an MBean which represents this server's view of its WANReplicationRuntime, if any. |
abstract String |
getWeblogicHome() The directory where the WebLogic Server instance (server) is installed, without the trailing "/server". |
abstract String |
getWeblogicVersion() The version of this WebLogic Server instance (server). |
abstract WebServerRuntimeMBean[] |
getWebServerRuntimes() Returns all the initialized webservers |
abstract WLDFRuntimeMBean |
getWLDFRuntime() Return the MBean which provides access to all Diagnostic runtime MBeans. |
abstract WorkManagerRuntimeMBean[] |
getWorkManagerRuntimes() Returns an array of MBeans which exposes this server's active internal WorkManagers. |
abstract WseeClusterFrontEndRuntimeMBean |
getWseeClusterFrontEndRuntime() This is non-null only when this server is running as a host to a front-end proxy (HttpClusterServlet) instance. |
abstract WseeWsrmRuntimeMBean |
getWseeWsrmRuntime() Get statistics for web services reliable messaging across the entire server if any web service is deployed that employs reliable messaging. |
abstract WTCRuntimeMBean |
getWTCRuntime() The WTCRuntimeMBean for this server. |
abstract boolean |
isAdministrationPortEnabled() Indicates whether the administration port is enabled on the server |
abstract boolean |
isAdminServer() Indicates whether the server is an Administration Server. |
abstract boolean |
isAdminServerListenPortSecure() Indicates whether the port that the server uses for administrative traffic is configured to use a secure protocol. |
abstract boolean |
isListenPortEnabled() Indicates whether the default listen port is enabled on the server. |
abstract boolean |
isRestartRequired() Indicates whether the server must be restarted in order to activate configuration changes. |
abstract boolean |
isSSLListenPortEnabled() Indicates whether the default SSL listen port is enabled on the server |
abstract ApplicationRuntimeMBean |
lookupApplicationRuntime(String name) Returns the ApplicationRuntimeMBean asked for, by name. |
abstract LibraryRuntimeMBean |
lookupLibraryRuntime(String name) Returns the LibraryRuntimeMBean asked for, by name. |
abstract MessagingBridgeRuntimeMBean |
lookupMessagingBridgeRuntime(String name) |
abstract PersistentStoreRuntimeMBean |
lookupPersistentStoreRuntime(String name) Returns the Runtime mbean for the persistent store with the specified short name. |
abstract void |
restartSSLChannels() Restart all SSL channels on which the server is listening. |
abstract void |
resume() Resume suspended server. |
abstract void |
resumeResourceGroup(String resourceGroupName) Resume suspended resource group. |
abstract void |
setCurrentMachine(String machineName) Return the machine on which the server is running. |
abstract void |
shutdown() Gracefully shuts down the server after handling inflight work. |
abstract void |
shutdown(int timeout, boolean ignoreSessions) Gracefully shuts down the server after handling inflight work. |
abstract void |
shutdown(int timeout, boolean ignoreSessions, boolean waitForAllSessions) Gracefully shuts down the server after handling inflight work; optionally ignores pending HTTP sessions while handling inflight work. |
abstract void |
shutdownResourceGroup(String resourceGroupName) Gracefully shuts down the resource group after handling inflight work. |
abstract void |
shutdownResourceGroup(String resourceGroupName, int timeout, boolean ignoreSessions) Gracefully shuts down the resource group after handling inflight work. |
abstract void |
shutdownResourceGroup(String resourceGroupName, int timeout, boolean ignoreSessions, boolean waitForAllSessions) Gracefully shuts down the resource group after handling inflight work; optionally ignores pending HTTP sessions while handling inflight work. |
abstract void |
start() Deprecated. Use ServerRuntimeMBean.suspend() and ServerRuntimeMBean.resume() operations instead of lock/unlock. |
abstract void |
startPartition(String partitionName) starts the partition. |
abstract void |
startPartitionInAdmin(String partitionName) starts the Partition in ADMIN state. |
abstract void |
startResourceGroup(String resourceGroupName) starts the resource group. |
abstract void |
startResourceGroupInAdmin(String resourceGroupName) starts the resource group in ADMIN state. |
abstract void |
suspend() Suspend server. |
abstract void |
suspend(int timeout, boolean ignoreSessions) Transitions the server from RUNNING to ADMIN state gracefully. |
abstract void |
suspendResourceGroup(String resourceGroupName) Suspend resource group. |
abstract void |
suspendResourceGroup(String resourceGroupName, int timeout, boolean ignoreSessions) Suspend resource group. |
Methods inherited from interface weblogic.management.runtime.RuntimeMBean |
---|
addPropertyChangeListener, removePropertyChangeListener |
Methods inherited from interface weblogic.management.WebLogicMBean |
---|
getMBeanInfo, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setName, 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 |
Method Detail |
---|
void suspend() throws ServerLifecycleException
Suspend server. Deny new requests (except by privileged users). Allow pending requests to complete. This operation transitions the server into ADMIN
state. Applications and resources are fully available to administrators in ADMIN
state. But non-admin users are denied access to applications and resources
ServerLifecycleException
ServerRuntimeMBean.suspend(int, boolean)
void suspend(int timeout, boolean ignoreSessions) throws ServerLifecycleException
Transitions the server from RUNNING
to ADMIN
state gracefully.
Applications are in admin mode. Inflight work is completed. Applications and resources are fully available to administrators in ADMIN
state. But non-admin users are denied access to applications and resources
timeout
- Seconds to wait for server to transition gracefully. The server calls ServerRuntimeMBean.forceSuspend()
after timeout.ignoreSessions
- drop inflight HTTP sessions during graceful suspendServerLifecycleException
- server failed to suspend gracefully. A ServerRuntimeMBean.forceSuspend()
or a ServerRuntimeMBean.forceShutdown()
operation can be invoked.void forceSuspend() throws ServerLifecycleException
Transitions the server from RUNNING
to ADMIN
state forcefully cancelling inflight work.
Work that cannot be cancelled is dropped. Applications are brought into the admin mode. This is the supported way of force suspending the server and getting it into ADMIN
state.
ServerLifecycleException
- server failed to force suspend. A ServerRuntimeMBean.forceShutdown()
operation can be invoked.void resume() throws ServerLifecycleException
Resume suspended server. Allow new requests. This operation transitions the server into RUNNING
state.
ServerLifecycleException
- if this operation fails to complete. The server transitions back to the previous state from which this operation was invoked e.g. if the server was in the ADMIN
state before this operation, it will go back to the ADMIN
state if resume fails.void shutdown() throws ServerLifecycleException
Gracefully shuts down the server after handling inflight work.
ServerLifecycleException
ServerRuntimeMBean.shutdown(int, boolean, boolean)
void shutdown(int timeout, boolean ignoreSessions) throws ServerLifecycleException
Gracefully shuts down the server after handling inflight work.
This method is the same as calling: shutdown(timeout, ignoreSessions, false);
timeout
-ignoreSessions
-ServerLifecycleException
ServerRuntimeMBean.shutdown(int, boolean, boolean)
void shutdown(int timeout, boolean ignoreSessions, boolean waitForAllSessions) throws ServerLifecycleException
Gracefully shuts down the server after handling inflight work; optionally ignores pending HTTP sessions while handling inflight work.
The following inflight work is allowed to complete before shutdown:
Further administrative calls are accepted while the server is completing inflight work. For example a forceShutdown command can be issued to quickly shutdown the server if graceful shutdown takes a long time.
timeout
- Number of seconds to wait before aborting inflight work and shutting down the server.ignoreSessions
- true
indicates ignore pending HTTP sessions during inflight work handling.waitForAllSessions
- true
indicates waiting for all HTTP sessions during inflight work handling; false
indicates waiting for non-persisted HTTP sessions only.ServerLifecycleException
- Thrown if the server cannot gracefully shutdown. Use the forceShutdown command to shutdown the server.void forceShutdown() throws ServerLifecycleException
Force shutdown the server. Causes the server to reject new requests and fail pending requests.
ServerLifecycleException
- Thrown when the server cannot force shutdown due to a fatal exception. Even after this exception is thrown indicating failure the server exits after ServerLifeCycleTimeoutVal seconds defined in the ServerMBean.
@Deprecated
void start()
ServerRuntimeMBean.suspend()
and ServerRuntimeMBean.resume()
operations instead of lock/unlock.Unlocks a server and enables it to receive new requests.
Servers can be locked with the java weblogic.Admin LOCK
command. In a locked state, a server instance accepts only administrative logins.
String getState()
The current life cycle state of this server.
For example, a server can be in a RUNNING state in which it can receive and process requests or in an ADMIN state in which it can receive only administrative requests.
int getStateVal()
Returns current state of the server as in integer. ServerStates
has more information about the available server states
long getActivationTime()
The time when the server was started.
@Deprecated
String getListenAddress()
ServerRuntimeMBean.getURL(java.lang.String)
The address on which this server is listening for connections through the default network channel.
For example this might return the string: santiago/172.17.9.220
.
You can configure other network channels for this server, and the other channels can use different listen addresses.
ServerRuntimeMBean.getServerChannel(String)
InetSocketAddress getServerChannel(String protocol)
The address on which this server is listening for connections that use the specified protocol.
Note: The listen address is persisted in the domain's config.xml
file, however when a server instance is started, a command-line option can override the persisted listen address. This getServerChannel
method returns the listen address that is currently being used, not necessarily the address that is specified in config.xml
.
The returned address will always be resolved.
protocol
- the desired protocolString getDefaultURL()
The URL that clients use to connect to this server's default network channel.
The returned value indicates the default protocol, listen address and listen port:
protocol://listen-address:listen-port
Note: The default protocol, listen address and listen port are persisted in the domain's config.xml
file, however when a server instance is started, command-line options can override these persisted values. This getDefaultURL
method returns the URL values that are currently being used, not necessarily the values that are specified in config.xml
.
The returned URL will be consistent with dynamic channel updates.
String getAdministrationURL()
The URL that the server and its clients use for administrative connections.
If no administration channel is enabled, then this method returns the URL for connections through the default channel. If the default channel is de-activated, this method returns the URL for a secure channel. If no secure channel is enabled, the method returns null.
The returned URL will be consistent with dynamic channel updates.
String getURL(String protocol)
The URL that clients use when connecting to this server using the specified protocol.
Note: The listen address and listen port for a given protocol are persisted in the domain's config.xml
file, however when a server instance is started, command-line options can override these persisted values. This getURL
method returns the URL values that are currently being used, not necessarily the values that are specified in config.xml
.
protocol
- the desired protocolString getIPv4URL(String protocol)
The URL that clients use when connecting to this server using the specified protocol.
Note: The listen address and listen port for a given protocol are persisted in the domain's config.xml
file, however when a server instance is started, command-line options can override these persisted values. This getURL
method returns the URL values that are currently being used, not necessarily the values that are specified in config.xml
.
protocol
- the desired protocolString getIPv6URL(String protocol)
The URL that clients use when connecting to this server using the specified protocol.
Note: The listen address and listen port for a given protocol are persisted in the domain's config.xml
file, however when a server instance is started, command-line options can override these persisted values. This getURL
method returns the URL values that are currently being used, not necessarily the values that are specified in config.xml
.
protocol
- the desired protocol
@Deprecated
int getListenPort()
ServerRuntimeMBean.getURL(java.lang.String)
The port on which this server is listening for connections.
@Deprecated
int getSSLListenPort()
ServerRuntimeMBean.getURL(java.lang.String)
The port on which this server is listening for SSL connections.
@Deprecated
int getAdministrationPort()
ServerRuntimeMBean.getAdministrationURL()
The port on which this server is listening for administrative requests.
@Deprecated
String getSSLListenAddress()
ServerRuntimeMBean.getURL(java.lang.String)
The address on which this server is listening for SSL connections. For example this might return the string: santiago/172.17.9.220
int getOpenSocketsCurrentCount()
The current number of sockets registered for socket muxing on this server.
@Deprecated
int getRestartsTotalCount()
ServerLifeCycleRuntimeMBean.getNodeManagerRestartCount()
if the NodeManager is used to start serversThe total number of restarts for this server since the cluster was last started.
ServerChannelRuntimeMBean[] getServerChannelRuntimes()
The network channels that are currently configured on the server.
@Deprecated
long getSocketsOpenedTotalCount()
ServerRuntimeMBean.getOpenSocketsCurrentCount()
instead. Both methods return the same value. This method is being deprecated in favor of the other method.The total number of registrations for socket muxing on this sever.
String getMiddlewareHome()
The Oracle Middleware installation directory.
@Deprecated
String getOracleHome()
The directory where Oracle products are installed. Deprecated since 10.3.3
String getWeblogicHome()
The directory where the WebLogic Server instance (server) is installed, without the trailing "/server".
String getWeblogicVersion()
The version of this WebLogic Server instance (server).
JTARuntimeMBean getJTARuntime()
The transaction RuntimeMBean for this server.
JTARuntimeMBean
JVMRuntimeMBean getJVMRuntime()
The JVMRuntimeMBean for this server.
JVMRuntimeMBean
JMSRuntimeMBean getJMSRuntime()
The JMSRuntimeMBean for this server.
@Deprecated
MessagingBridgeRuntimeMBean getMessagingBridgeRuntime()
ServerRuntimeMBean.getMessagingBridgeRuntimes()
The MessagingBridgeRuntimeMBean for this server
MessagingBridgeRuntimeMBean[] getMessagingBridgeRuntimes()
The MessagingBridgeRuntimeMBeans for this server
MessagingBridgeRuntimeMBean lookupMessagingBridgeRuntime(String name)
name
-JDBCServiceRuntimeMBean getJDBCServiceRuntime()
The JDBCServiceRuntimeMBean for this server.
WTCRuntimeMBean getWTCRuntime()
The WTCRuntimeMBean for this server.
JoltConnectionServiceRuntimeMBean getJoltRuntime()
The JoltConnectionServiceRuntimeMBean for this server.
ServerSecurityRuntimeMBean getServerSecurityRuntime()
Return the ServerSecurityRuntimeMBean for this server.
ClusterRuntimeMBean getClusterRuntime()
Return an MBean which represents this server's view of its cluster, if any.
EntityCacheCurrentStateRuntimeMBean getEntityCacheCurrentStateRuntime()
Return an MBean which represents Current Status of the XML Cache.
EntityCacheCumulativeRuntimeMBean getEntityCacheCumulativeRuntime()
Return an MBean which represents Cumulative Status of the XML Cache.
EntityCacheCumulativeRuntimeMBean getEntityCacheHistoricalRuntime()
Return an MBean which represents Historical Status of the XML Cache.
ThreadPoolRuntimeMBean getThreadPoolRuntime()
Get the self-tuning thread pool's runtime information. This call will return null
if the self-tuning implementation is not enabled.
ClassLoaderRuntimeMBean getClassLoaderRuntime()
Get statistics for system-level class loading.
TimerRuntimeMBean getTimerRuntime()
Get the runtime information about the WebLogic timer implementation.
ExecuteQueueRuntimeMBean getDefaultExecuteQueueRuntime()
Return an MBean which exposes this server's default execute queue.
ExecuteQueueRuntimeMBean[] getExecuteQueueRuntimes()
Returns an array of MBeans which exposes this server's active execute queues.
WorkManagerRuntimeMBean[] getWorkManagerRuntimes()
Returns an array of MBeans which exposes this server's active internal WorkManagers.
MaxThreadsConstraintRuntimeMBean[] getMaxThreadsConstraintRuntimes()
Returns an array of RuntimeMBeans which exposes this server's globally defined MaxThreadsConstraints.
MinThreadsConstraintRuntimeMBean[] getMinThreadsConstraintRuntimes()
Returns an array of RuntimeMBeans which exposes this server's globally defined MinThreadsConstraints.
RequestClassRuntimeMBean[] getRequestClassRuntimes()
Returns an array of RuntimeMBeans which exposes this server's globally defined Request Classes.
String getAdminServerHost()
The address on which the Administration Server is listening for connections. For example, this might return the string: santiago
int getAdminServerListenPort()
The port on which the Administration Server is listening for connections.
boolean isAdminServerListenPortSecure()
Indicates whether the port that the server uses for administrative traffic is configured to use a secure protocol.
boolean isListenPortEnabled()
Indicates whether the default listen port is enabled on the server.
boolean isSSLListenPortEnabled()
Indicates whether the default SSL listen port is enabled on the server
boolean isAdministrationPortEnabled()
Indicates whether the administration port is enabled on the server
HealthState getHealthState()
The health state of the server as reported by the server's self-health monitoring.
For example, the server can report if it is overloaded by too many requests, if it needs more memory resources, or if it will soon fail for other reasons.
getHealthState
in interface HealthFeedback
HealthState
CompositeData getHealthStateJMX() throws OpenDataException
The HealthState object returned as a CompositeData type.
OpenDataException
ServerRuntimeMBean.getHealthState()
, HealthState
HealthState getOverallHealthState()
Determine the overall health state of this server, taking into account the health of each of its subsystems.
HealthState
CompositeData getOverallHealthStateJMX() throws OpenDataException
The overall health state of this server returned as a CompositeData type.
OpenDataException
ServerRuntimeMBean.getOverallHealthState()
, HealthState
boolean isAdminServer()
Indicates whether the server is an Administration Server.
String getCurrentDirectory()
The absolute path of the directory from which the server was started.
This may be used in conjunction with other relative paths in ServerMBean to compute full paths.
ServerMBean
ApplicationRuntimeMBean[] getApplicationRuntimes()
Returns the list of currently running Applications
ApplicationRuntimeMBean lookupApplicationRuntime(String name)
Returns the ApplicationRuntimeMBean asked for, by name.
name
-LibraryRuntimeMBean[] getLibraryRuntimes()
Returns all deployed Libraries
LibraryRuntimeMBean lookupLibraryRuntime(String name)
Returns the LibraryRuntimeMBean asked for, by name.
name
-LogBroadcasterRuntimeMBean getLogBroadcasterRuntime() throws ManagementException
The object which generates notifications on behalf of the logging subystem.
ManagementException
@Deprecated
LogRuntimeMBean getLogRuntime()
Return the MBean which provides access to the control interface for WLS server logging.
ServerLogRuntimeMBean getServerLogRuntime()
Return the MBean which provides access to the control interface for WLS server logging.
WLDFRuntimeMBean getWLDFRuntime()
Return the MBean which provides access to all Diagnostic runtime MBeans.
MANReplicationRuntimeMBean getMANReplicationRuntime()
Return an MBean which represents this server's view of its MANReplicationRuntime, if any.
WANReplicationRuntimeMBean getWANReplicationRuntime()
Return an MBean which represents this server's view of its WANReplicationRuntime, if any.
void setCurrentMachine(String machineName)
Return the machine on which the server is running. This will be different from the configuration if the server gets migrated automatically.
machineName
-String getCurrentMachine()
Return the machine on which the server is running. This will be different from the configuration if the server gets migrated automatically.
void restartSSLChannels()
Restart all SSL channels on which the server is listening. This could be necessary because of some change that the server is not aware of, for instance updates to the keystore.
MailSessionRuntimeMBean[] getMailSessionRuntimes()
Return the runtimeMBeans for JavaMail Mail Sessions
PersistentStoreRuntimeMBean[] getPersistentStoreRuntimes()
Returns the mbeans that provides runtime information for each PersistentStore.
PersistentStoreRuntimeMBean lookupPersistentStoreRuntime(String name)
Returns the Runtime mbean for the persistent store with the specified short name.
name
-ConnectorServiceRuntimeMBean getConnectorServiceRuntime()
The access point for server wide control and monitoring of the Connector Container.
WebServerRuntimeMBean[] getWebServerRuntimes()
Returns all the initialized webservers
boolean isRestartRequired()
Indicates whether the server must be restarted in order to activate configuration changes.
String getServerClasspath()
Get the classpath for this server including domain/lib contents that are automatically picked up and appended to the classpath.
@Deprecated
PathServiceRuntimeMBean getPathServiceRuntime()
ServerRuntimeMBean.getPathServiceRuntimes()
Domain scoped PathServiceRuntimeMBean for this server.
SAFRuntimeMBean getSAFRuntime()
The SAFRuntimeMBean for this server.
SNMPAgentRuntimeMBean getSNMPAgentRuntime()
Return the MBean which provides access to the monitoring statistics for WLS SNMP Agent.
SingleSignOnServicesRuntimeMBean getSingleSignOnServicesRuntime()
Get the runtime interface to publish single sign-on services information.
MANAsyncReplicationRuntimeMBean getMANAsyncReplicationRuntime()
Return an MBean which represents this server's view of its MANAsyncReplicationRuntime, if any.
AsyncReplicationRuntimeMBean getAsyncReplicationRuntime()
Return an MBean which represents this server's view of its AsyncReplicationRuntime, if any.
WseeWsrmRuntimeMBean getWseeWsrmRuntime()
Get statistics for web services reliable messaging across the entire server if any web service is deployed that employs reliable messaging. This MBean is null otherwise.
WseeClusterFrontEndRuntimeMBean getWseeClusterFrontEndRuntime()
This is non-null only when this server is running as a host to a front-end proxy (HttpClusterServlet) instance.
ConcurrentManagedObjectsRuntimeMBean getConcurrentManagedObjectsRuntime()
The ConcurrentManagedObjectsRuntimeMBean for this server.
ConcurrentManagedObjectsRuntimeMBean
void startPartition(String partitionName) throws PartitionLifeCycleException
starts the partition.
partitionName
- The resource group namePartitionLifeCycleException
- partition failed to start.void startPartitionInAdmin(String partitionName) throws PartitionLifeCycleException
starts the Partition in ADMIN state. Applications and resources are fully available to administrators in ADMIN
state. But non-admin users are denied access to applications and resources
partitionName
-PartitionLifeCycleException
- partition failed to start in admin mode.void startResourceGroup(String resourceGroupName) throws ResourceGroupLifecycleException
starts the resource group.
resourceGroupName
- The resource group nameResourceGroupLifecycleException
- partition failed to start.void startResourceGroupInAdmin(String resourceGroupName) throws ResourceGroupLifecycleException
starts the resource group in ADMIN state. Applications and resources are fully available to administrators in ADMIN
state. But non-admin users are denied access to applications and resources
resourceGroupName
-ResourceGroupLifecycleException
- resource group failed to start in admin mode.void suspendResourceGroup(String resourceGroupName, int timeout, boolean ignoreSessions) throws ResourceGroupLifecycleException
Suspend resource group. Deny new requests (except by privileged users). Allow pending requests to complete. This operation transitions the partition into ADMIN
state. Applications and resources are fully available to administrators in ADMIN
state. But non-admin users are denied access to applications and resources
resourceGroupName
-timeout
-ignoreSessions
-ResourceGroupLifecycleException
void suspendResourceGroup(String resourceGroupName) throws ResourceGroupLifecycleException
Suspend resource group. Deny new requests (except by privileged users). Allow pending requests to complete. This operation transitions the partition into ADMIN
state. Applications and resources are fully available to administrators in ADMIN
state. But non-admin users are denied access to applications and resources
resourceGroupName
-ResourceGroupLifecycleException
ServerRuntimeMBean.suspendResourceGroup(String, int, boolean)
void forceSuspendResourceGroup(String resourceGroupName) throws ResourceGroupLifecycleException
Transitions the resource group from RUNNING
to ADMIN
state forcefully cancelling inflight work.
Work that cannot be cancelled is dropped. Applications are brought into the admin mode. This is the supported way of force suspending the resource group and getting it into ADMIN
state.
resourceGroupName
-ResourceGroupLifecycleException
- partition failed to force suspend. A ServerRuntimeMBean.forceShutdown()
operation can be invoked.void resumeResourceGroup(String resourceGroupName) throws ResourceGroupLifecycleException
Resume suspended resource group. Allow new requests. This operation transitions the resource group into RUNNING
state.
resourceGroupName
-ResourceGroupLifecycleException
- if this operation fails to complete. The resource group transitions back to the previous state from which this operation was invoked e.g. if the resource group was in the ADMIN
state before this operation, it will go back to the ADMIN
state if resume fails.void forceShutdownResourceGroup(String resourceGroupName) throws ResourceGroupLifecycleException
Force shutdown the resource group. Causes the resource group to reject new requests and fail pending requests.
resourceGroupName
-ResourceGroupLifecycleException
- Thrown when the resource group cannot force shutdown due to a fatal exception. Even after this exception is thrown indicating failure the partition exits after PartitionLifeCycleTimeoutVal seconds defined in the PartitionMBean.void shutdownResourceGroup(String resourceGroupName, int timeout, boolean ignoreSessions, boolean waitForAllSessions) throws ResourceGroupLifecycleException
Gracefully shuts down the resource group after handling inflight work; optionally ignores pending HTTP sessions while handling inflight work.
The following inflight work is allowed to complete before shutdown:
Pending transaction's and TLOG checkpoint
Pending HTTP sessions
Pending JMS work
Pending work in the execute queues
RMI requests with transaction context
Further administrative calls are accepted while the server is completing inflight work. For example a forceShutdown command can be issued to quickly shutdown the partition if graceful shutdown takes a long time.
resourceGroupName
-timeout
- Number of seconds to wait before aborting inflight work and shutting down the partition.ignoreSessions
- true
indicates ignore pending HTTP sessions during inflight work handling.waitForAllSessions
- true
indicates waiting for all HTTP sessions during inflight work handling; false
indicates waiting for non-persisted HTTP sessions only.PartitionLifeCycleException
- Thrown if the partition cannot gracefully shutdown. Use the forceShutdown command to shutdown the server.ResourceGroupLifecycleException
void shutdownResourceGroup(String resourceGroupName, int timeout, boolean ignoreSessions) throws ResourceGroupLifecycleException
Gracefully shuts down the resource group after handling inflight work.
This method is same to call: shutdown(timeout, ignoreSessions, false);
resourceGroupName
-timeout
-ignoreSessions
-ResourceGroupLifecycleException
ServerRuntimeMBean.shutdownResourceGroup(String, int, boolean, boolean)
void shutdownResourceGroup(String resourceGroupName) throws ResourceGroupLifecycleException
Gracefully shuts down the resource group after handling inflight work.
resourceGroupName
-ResourceGroupLifecycleException
ServerRuntimeMBean.shutdownResourceGroup(String, int, boolean, boolean)
String getName()
The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.
getName
in interface WebLogicMBean
|
Copyright 1996, 2015, 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.2.1) Part Number E55141-01 P4 Change 1723563 on 2015/10/09 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |