weblogic.management.runtime
Interface ServerRuntimeMBean

All Superinterfaces:

ServerStates

public interface ServerRuntimeMBean
extends ServerStates

Provides methods for retrieving runtime information about a server instance and for transitioning a server from one state to another.

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.

suspend

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

Throws:

ServerLifecycleException

See Also:

ServerRuntimeMBean.suspend(int, boolean)

suspend

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

Parameters:

timeout - Seconds to wait for server to transition gracefully. The server calls ServerRuntimeMBean.forceSuspend() after timeout.

ignoreSessions - drop inflight HTTP sessions during graceful suspend

Throws:

ServerLifecycleException - server failed to suspend gracefully. A ServerRuntimeMBean.forceSuspend() or a ServerRuntimeMBean.forceShutdown() operation can be invoked.

forceSuspend

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.

Throws:

ServerLifecycleException - server failed to force suspend. A ServerRuntimeMBean.forceShutdown() operation can be invoked.

resume

void resume()
            throws ServerLifecycleException

Resume suspended server. Allow new requests. This operation transitions the server into RUNNING state.

Throws:

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.

Access limited to the following security roles:

Operator

shutdown

void shutdown()
              throws ServerLifecycleException

Gracefully shuts down the server after handling inflight work.

Throws:

ServerLifecycleException

See Also:

ServerRuntimeMBean.shutdown(int, boolean)

Access limited to the following security roles:

Operator

shutdown

void shutdown(int timeout,
              boolean ignoreSessions)
              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:

• 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 server if graceful shutdown takes a long time.

Parameters:

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.

Throws:

ServerLifecycleException - Thrown if the server cannot gracefully shutdown. Use the forceShutdown command to shutdown the server.

Access limited to the following security roles:

Operator

forceShutdown

void forceShutdown()
                   throws ServerLifecycleException

Force shutdown the server. Causes the server to reject new requests and fail pending requests.

Throws:

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.

Access limited to the following security roles:

Operator

start

void start()

Deprecated. Use 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.

Access limited to the following security roles:

Operator

getState

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.

Returns:

The state value

getStateVal

int getStateVal()

Returns current state of the server as in integer. ServerStates has more information about the available server states

Returns:

The stateVal value

getActivationTime

long getActivationTime()

The time when the server was started.

Returns:

The activationTime value

getListenAddress

String getListenAddress()

Deprecated. 9.0.0.0 Replaced by 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.

Returns:

The listenAddress value

See Also:

ServerRuntimeMBean.getServerChannel(String)

getServerChannel

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.

Parameters:

protocol - the desired protocol

Returns:

The channel as an InetSocketAddress

getDefaultURL

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

Returns:

The URL as a string

getAdministrationURL

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.

Returns:

The URL as a string

getURL

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.

Parameters:

protocol - the desired protocol

Returns:

The URL as a string

All security roles can access this item.

getIPv4URL

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

Parameters:

protocol - the desired protocol

Returns:

The URL as a string

Since:

10.3.1.0

All security roles can access this item.

getIPv6URL

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

Parameters:

protocol - the desired protocol

Returns:

The URL as a string

Since:

10.3.1.0

All security roles can access this item.

getListenPort

int getListenPort()

Deprecated. 9.0.0.0 Replaced by ServerRuntimeMBean.getURL(java.lang.String)

The port on which this server is listening for connections.

Returns:

The listenPort value

getSSLListenPort

int getSSLListenPort()

Deprecated. 9.0.0.0 Replaced by ServerRuntimeMBean.getURL(java.lang.String)

The port on which this server is listening for SSL connections.

Returns:

The sSLListenPort value

getAdministrationPort

int getAdministrationPort()

Deprecated. 9.0.0.0 Replaced by ServerRuntimeMBean.getAdministrationURL()

The port on which this server is listening for administrative requests.

Returns:

The administrationPort value

getSSLListenAddress

String getSSLListenAddress()

Deprecated. 9.0.0.0 Replaced by 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

Returns:

The sSLListenAddress value

getOpenSocketsCurrentCount

int getOpenSocketsCurrentCount()

The current number of sockets registered for socket muxing on this server.

Returns:

The openSocketsCurrentCount value

getRestartsTotalCount

int getRestartsTotalCount()

Deprecated. This attribute always returns a value of 0. Please use ServerLifeCycleRuntimeMBean.getNodeManagerRestartCount() if the NodeManager is used to start servers

The total number of restarts for this server since the cluster was last started.

Returns:

The restartsTotalCount value

getServerChannelRuntimes

ServerChannelRuntimeMBean[] getServerChannelRuntimes()

The network channels that are currently configured on the server.

Returns:

The channels value

getSocketsOpenedTotalCount

long getSocketsOpenedTotalCount()

Deprecated. Use 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.

Returns:

The socketsOpenedTotalCount value

getMiddlewareHome

String getMiddlewareHome()

The Oracle Middleware installation directory.

Returns:

The Oracle Middleware installation directory

Since:

10.3.3.0

getOracleHome

String getOracleHome()

Deprecated. WLS can no longer find out what ORACLE_HOME is

The directory where Oracle products are installed.

Deprecated since 10.3.3

Returns:

The Oracle products installation directory

Since:

10.3.1.0

getWeblogicHome

String getWeblogicHome()

The directory where the WebLogic Server instance (server) is installed, without the trailing "/server".

Returns:

The weblogic server directory

Since:

10.3.1.0

getWeblogicVersion

String getWeblogicVersion()

The version of this WebLogic Server instance (server).

Returns:

The weblogicVersion value

getJTARuntime

JTARuntimeMBean getJTARuntime()

The transaction RuntimeMBean for this server.

Returns:

The jTARuntime value

See Also:

JTARuntimeMBean

setJTARuntime

void setJTARuntime(JTARuntimeMBean b)

Sets the value of the JTARuntime attribute.

See Also:

ServerRuntimeMBean.getJTARuntime()

getJVMRuntime

JVMRuntimeMBean getJVMRuntime()

The JVMRuntimeMBean for this server.

Returns:

The jVMRuntime value

See Also:

JVMRuntimeMBean

getJMSRuntime

JMSRuntimeMBean getJMSRuntime()

The JMSRuntimeMBean for this server.

Returns:

The jMSRuntime value

getMessagingBridgeRuntime

MessagingBridgeRuntimeMBean getMessagingBridgeRuntime()

The MessagingBridgeRuntimeMBean for this server

Returns:

the messagingBridgeRuntime value

setMessagingBridgeRuntime

void setMessagingBridgeRuntime(MessagingBridgeRuntimeMBean b)

Set the MessagingBridgeRuntimeMBean for this server

Parameters:

b -

getJDBCServiceRuntime

JDBCServiceRuntimeMBean getJDBCServiceRuntime()

The JDBCServiceRuntimeMBean for this server.

Returns:

The jDBCServiceRuntime value

getWTCRuntime

WTCRuntimeMBean getWTCRuntime()

The WTCRuntimeMBean for this server.

Returns:

The WTCRuntime value

getJoltRuntime

JoltConnectionServiceRuntimeMBean getJoltRuntime()

The JoltConnectionServiceRuntimeMBean for this server.

Returns:

The JoltConnectionServiceRuntime value

getServerSecurityRuntime

ServerSecurityRuntimeMBean getServerSecurityRuntime()

Return the ServerSecurityRuntimeMBean for this server.

Returns:

The serverSecurityRuntime value

getClusterRuntime

ClusterRuntimeMBean getClusterRuntime()

Return an MBean which represents this server's view of its cluster, if any.

Returns:

The clusterRuntime value

getEntityCacheCurrentStateRuntime

EntityCacheCurrentStateRuntimeMBean getEntityCacheCurrentStateRuntime()

Return an MBean which represents Current Status of the XML Cache.

Returns:

The entityCacheCurrentStateRuntime value

getEntityCacheCumulativeRuntime

EntityCacheCumulativeRuntimeMBean getEntityCacheCumulativeRuntime()

Return an MBean which represents Cumulative Status of the XML Cache.

Returns:

The entityCacheCumulativeRuntime value

getEntityCacheHistoricalRuntime

EntityCacheCumulativeRuntimeMBean getEntityCacheHistoricalRuntime()

Return an MBean which represents Historical Status of the XML Cache.

Returns:

The entityCacheHistoricalRuntime value

getThreadPoolRuntime

ThreadPoolRuntimeMBean getThreadPoolRuntime()

Get the self-tuning thread pool's runtime information. This call will return null if the self-tuning implementation is not enabled.

Since:

9.0.0.0

getTimerRuntime

TimerRuntimeMBean getTimerRuntime()

Get the runtime information about the WebLogic timer implementation.

getDefaultExecuteQueueRuntime

ExecuteQueueRuntimeMBean getDefaultExecuteQueueRuntime()

Return an MBean which exposes this server's default execute queue.

Returns:

The executeQueueRuntime value

getExecuteQueueRuntimes

ExecuteQueueRuntimeMBean[] getExecuteQueueRuntimes()

Returns an array of MBeans which exposes this server's active execute queues.

Returns:

The executeQueueRuntimes value

getWorkManagerRuntimes

WorkManagerRuntimeMBean[] getWorkManagerRuntimes()

Returns an array of MBeans which exposes this server's active internal WorkManagers.

Returns:

The workManagerRuntimes value

Since:

9.0.0.0

addRequestClassRuntime

boolean addRequestClassRuntime(RequestClassRuntimeMBean temp)

getMaxThreadsConstraintRuntimes

MaxThreadsConstraintRuntimeMBean[] getMaxThreadsConstraintRuntimes()

Returns an array of RuntimeMBeans which exposes this server's globally defined MaxThreadsConstraints.

Since:

9.0.0.0

getMinThreadsConstraintRuntimes

MinThreadsConstraintRuntimeMBean[] getMinThreadsConstraintRuntimes()

Returns an array of RuntimeMBeans which exposes this server's globally defined MinThreadsConstraints.

Since:

9.0.0.0

getRequestClassRuntimes

RequestClassRuntimeMBean[] getRequestClassRuntimes()

Returns an array of RuntimeMBeans which exposes this server's globally defined Request Classes.

Since:

9.0.0.0

getAdminServerHost

String getAdminServerHost()

The address on which the Administration Server is listening for connections. For example, this might return the string: santiago

Returns:

The adminServerHost value

getAdminServerListenPort

int getAdminServerListenPort()

The port on which the Administration Server is listening for connections.

Returns:

The adminServerListenPort value

isAdminServerListenPortSecure

boolean isAdminServerListenPortSecure()

Indicates whether the port that the server uses for administrative traffic is configured to use a secure protocol.

Returns:

The adminServerListenPortSecure value

isListenPortEnabled

boolean isListenPortEnabled()

Indicates whether the default listen port is enabled on the server.

Returns:

The listenPortEnabled value

isSSLListenPortEnabled

boolean isSSLListenPortEnabled()

Indicates whether the default SSL listen port is enabled on the server

Returns:

The SLListenPortEnabled value

isAdministrationPortEnabled

boolean isAdministrationPortEnabled()

Indicates whether the administration port is enabled on the server

Returns:

The administrationPortEnabled value

getHealthState

HealthState getHealthState()

The health state of the server as reported by the server's self-health monitoring. See weblogic.health.HealthState for state values.

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.

Returns:

The healthState value

getOverallHealthState

HealthState getOverallHealthState()

Determine the overall health state of this server, taking into account the health of each of its subsystems. See weblogic.health.HealthState for state values.

Returns:

The healthState value with subsystems taken into account

isAdminServer

boolean isAdminServer()

Indicates whether the server is an Administration Server.

Returns:

The adminServer value

getCurrentDirectory

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.

Returns:

The currentDirectory value

See Also:

ServerMBean

getApplicationRuntimes

ApplicationRuntimeMBean[] getApplicationRuntimes()

Returns the list of currently running Applications

Returns:

the currently running applications.

lookupApplicationRuntime

ApplicationRuntimeMBean lookupApplicationRuntime(String name)

Returns the ApplicationRuntimeMBean asked for, by name.

Returns:

The requested ApplicationRuntimeMBean, null if it does not exist.

Access limited to the following security roles:

Deployer

getLibraryRuntimes

LibraryRuntimeMBean[] getLibraryRuntimes()

Returns all deployed Libraries

Returns:

Array of LibraryRuntimeMBeans.

lookupLibraryRuntime

LibraryRuntimeMBean lookupLibraryRuntime(String name)

Returns the LibraryRuntimeMBean asked for, by name.

Returns:

The requested LibraryRuntimeMBean, null if it does not exist.

getLogBroadcasterRuntime

LogBroadcasterRuntimeMBean getLogBroadcasterRuntime()
                                                    throws ManagementException

The object which generates notifications on behalf of the logging subystem.

Throws:

ManagementException

getLogRuntime

LogRuntimeMBean getLogRuntime()

Return the MBean which provides access to the control interface for WLS server logging.

Since:

9.0.0.0

getWLDFRuntime

WLDFRuntimeMBean getWLDFRuntime()

Return the MBean which provides access to all Diagnostic runtime MBeans.

Since:

9.0.0.0

getMANReplicationRuntime

MANReplicationRuntimeMBean getMANReplicationRuntime()

Return an MBean which represents this server's view of its MANReplicationRuntime, if any.

Returns:

The MANReplicationRuntime value

getWANReplicationRuntime

WANReplicationRuntimeMBean getWANReplicationRuntime()

Return an MBean which represents this server's view of its WANReplicationRuntime, if any.

Returns:

The WANReplicationRuntime value

setCurrentMachine

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.

Parameters:

machineName -

getCurrentMachine

String getCurrentMachine()

Return the machine on which the server is running. This will be different from the configuration if the server gets migrated automatically. * @return Machine on which server is running.

restartSSLChannels

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.

getMailSessionRuntimes

MailSessionRuntimeMBean[] getMailSessionRuntimes()

Return the runtimeMBeans for JavaMail Mail Sessions

Since:

9.0.0.0

getPersistentStoreRuntimes

PersistentStoreRuntimeMBean[] getPersistentStoreRuntimes()

Returns the mbeans that provides runtime information for each PersistentStore.

Since:

9.0.0.0

lookupPersistentStoreRuntime

PersistentStoreRuntimeMBean lookupPersistentStoreRuntime(String name)

Returns the Runtime mbean for the persistent store with the specified short name.

Parameters:

name -

Returns:

getConnectorServiceRuntime

ConnectorServiceRuntimeMBean getConnectorServiceRuntime()

The access point for server wide control and monitoring of the Connector Container.

Returns:

the Connector Service MBean for this server instance.

getWebServerRuntimes

WebServerRuntimeMBean[] getWebServerRuntimes()

Returns all the initialized webservers

isRestartRequired

boolean isRestartRequired()

Indicates whether the server must be restarted in order to activate configuration changes.

Returns:

true if the server needs to be restarted, false otherwise.

Since:

9.0.0.0

getServerClasspath

String getServerClasspath()

Get the classpath for this server including domain/lib contents that are automatically picked up and appended to the classpath.

Since:

9.0.0.0

getPathServiceRuntime

PathServiceRuntimeMBean getPathServiceRuntime()

The PathServiceRuntimeMBean for this server.

Returns:

The jMSRuntime value

getSAFRuntime

SAFRuntimeMBean getSAFRuntime()

The SAFRuntimeMBean for this server.

Returns:

The sAFRuntime value

getWLECConnectionServiceRuntime

WLECConnectionServiceRuntimeMBean getWLECConnectionServiceRuntime()

The WLECConnectionServiceRuntime for this server.

Returns:

The WLECConnectionServiceRuntime

getSNMPAgentRuntime

SNMPAgentRuntimeMBean getSNMPAgentRuntime()

Return the MBean which provides access to the monitoring statistics for WLS SNMP Agent.

Since:

10.0.0.0

getSingleSignOnServicesRuntime

SingleSignOnServicesRuntimeMBean getSingleSignOnServicesRuntime()

Get the runtime interface to publish single sign-on services information.

getMANAsyncReplicationRuntime

MANAsyncReplicationRuntimeMBean getMANAsyncReplicationRuntime()

Return an MBean which represents this server's view of its MANAsyncReplicationRuntime, if any.

Returns:

The MANAsyncReplicationRuntime value

Since:

10.3.0.0

getAsyncReplicationRuntime

AsyncReplicationRuntimeMBean getAsyncReplicationRuntime()

Return an MBean which represents this server's view of its AsyncReplicationRuntime, if any.

Returns:

The AsyncReplicationRuntime value

Since:

10.3.0.0

getWseeWsrmRuntime

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.

Since:

10.3.1.2

getWseeClusterFrontEndRuntime

WseeClusterFrontEndRuntimeMBean getWseeClusterFrontEndRuntime()

This is non-null only when this server is running as a host to a front-end proxy (HttpClusterServlet) instance.

Since:

10.3.1.2