ServerRuntimeMBean


Overview  |   Related MBeans  |   Attributes  |   Operations

Overview

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

   
Fully Qualified Interface NameIf you use the getMBeanInfo operation in MBeanTypeServiceMBean, supply the following value as this MBean's fully qualified interface name:
weblogic.management.runtime.ServerRuntimeMBean
Factory Methods No factory methods. Instances of this MBean are created automatically.
Access Points You can access this MBean from the following MBean attributes:


    Related MBeans

    This section describes attributes that provide access to other MBeans. For more information about the MBean hierarchy, refer to WebLogic Server MBean Data Model.


    ApplicationRuntimes

    Returns the list of currently running Applications

               
    Lookup OperationlookupApplicationRuntime(String name)

    Returns a javax.management.ObjectName for the instance of ApplicationRuntimeMBean named name.

    Privileges Read only
    TypeApplicationRuntimeMBean[]
    Relationship type: Reference.

    ClusterRuntime

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

           
    Privileges Read only
    TypeClusterRuntimeMBean
    Relationship type: Reference.

    ConnectorServiceRuntime

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

           
    Privileges Read only
    TypeConnectorServiceRuntimeMBean
    Relationship type: Reference.

    DefaultExecuteQueueRuntime

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

           
    Privileges Read only
    TypeExecuteQueueRuntimeMBean
    Relationship type: Reference.

    EntityCacheCumulativeRuntime

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

           
    Privileges Read only
    TypeEntityCacheCumulativeRuntimeMBean
    Relationship type: Reference.

    EntityCacheCurrentStateRuntime

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

           
    Privileges Read only
    TypeEntityCacheCurrentStateRuntimeMBean
    Relationship type: Reference.

    EntityCacheHistoricalRuntime

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

           
    Privileges Read only
    TypeEntityCacheCumulativeRuntimeMBean
    Relationship type: Reference.

    ExecuteQueueRuntimes

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

           
    Privileges Read only
    TypeExecuteQueueRuntimeMBean[]
    Relationship type: Reference.

    JDBCServiceRuntime

    The JDBCServiceRuntimeMBean for this server.

           
    Privileges Read only
    TypeJDBCServiceRuntimeMBean
    Relationship type: Reference.

    JMSRuntime

    The JMSRuntimeMBean for this server.

           
    Privileges Read only
    TypeJMSRuntimeMBean
    Relationship type: Reference.

    JoltRuntime

    The JoltConnectionServiceRuntimeMBean for this server.

           
    Privileges Read only
    TypeJoltConnectionServiceRuntimeMBean
    Relationship type: Reference.

    JTARuntime

    The transaction RuntimeMBean for this server.

    For more information, see:

           
    Privileges Read/Write
    TypeJTARuntimeMBean
    Relationship type: Reference.
    Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

    JVMRuntime

    The JVMRuntimeMBean for this server.

    For more information, see:

           
    Privileges Read/Write
    TypeJVMRuntimeMBean
    Relationship type: Reference.
    Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

    LibraryRuntimes

    Returns all deployed Libraries

               
    Lookup OperationlookupLibraryRuntime(String name)

    Returns a javax.management.ObjectName for the instance of LibraryRuntimeMBean named name.

    Privileges Read only
    TypeLibraryRuntimeMBean[]
    Relationship type: Reference.

    LogBroadcasterRuntime

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

           
    Factory Methods No explicit creator method. The child shares the lifecycle of its parent.
    Privileges Read only
    TypeLogBroadcasterRuntimeMBean
    Relationship type: Containment.

    LogRuntime

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

           
    Privileges Read only
    TypeLogRuntimeMBean
    Relationship type: Reference.

    MailSessionRuntimes

    Return the runtimeMBeans for JavaMail Mail Sessions

           
    Privileges Read only
    TypeMailSessionRuntimeMBean[]
    Relationship type: Reference.

    MANReplicationRuntime

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

           
    Privileges Read only
    TypeMANReplicationRuntimeMBean
    Relationship type: Reference.

    MaxThreadsConstraintRuntimes

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

               
    Lookup OperationlookupMaxThreadsConstraintRuntime(String name)

    Returns a javax.management.ObjectName for the instance of MaxThreadsConstraintRuntimeMBean named name.

    Privileges Read only
    TypeMaxThreadsConstraintRuntimeMBean[]
    Relationship type: Reference.

    MinThreadsConstraintRuntimes

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

               
    Lookup OperationlookupMinThreadsConstraintRuntime(String name)

    Returns a javax.management.ObjectName for the instance of MinThreadsConstraintRuntimeMBean named name.

    Privileges Read only
    TypeMinThreadsConstraintRuntimeMBean[]
    Relationship type: Reference.

    PathServiceRuntime

    The PathServiceRuntimeMBean for this server.

           
    Privileges Read only
    TypePathServiceRuntimeMBean
    Relationship type: Reference.

    PersistentStoreRuntimes

    Returns the mbeans that provides runtime information for each PersistentStore.

               
    Lookup OperationlookupPersistentStoreRuntime(String name)

    Returns a javax.management.ObjectName for the instance of PersistentStoreRuntimeMBean named name.

    Privileges Read only
    TypePersistentStoreRuntimeMBean[]
    Relationship type: Reference.

    RequestClassRuntimes

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

               
    Lookup OperationlookupRequestClassRuntime(String name)

    Returns a javax.management.ObjectName for the instance of RequestClassRuntimeMBean named name.

    Privileges Read only
    TypeRequestClassRuntimeMBean[]
    Relationship type: Reference.

    SAFRuntime

    The SAFRuntimeMBean for this server.

           
    Privileges Read only
    TypeSAFRuntimeMBean
    Relationship type: Reference.

    ServerChannelRuntimes

    The network channels that are currently configured on the server.

           
    Factory Methods No explicit creator method. The child shares the lifecycle of its parent.
    Privileges Read only
    TypeServerChannelRuntimeMBean[]
    Relationship type: Containment.

    ServerSecurityRuntime

    Return the ServerSecurityRuntimeMBean for this server.

           
    Privileges Read only
    TypeServerSecurityRuntimeMBean
    Relationship type: Reference.

    ThreadPoolRuntime

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

           
    Privileges Read only
    TypeThreadPoolRuntimeMBean
    Relationship type: Reference.

    TimerRuntime

    Get the runtime information about the WebLogic timer implementation.

           
    Privileges Read only
    TypeTimerRuntimeMBean
    Relationship type: Reference.

    WANReplicationRuntime

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

           
    Privileges Read only
    TypeWANReplicationRuntimeMBean
    Relationship type: Reference.

    WebServerRuntimes

    Returns all the initialized webservers

           
    Privileges Read only
    TypeWebServerRuntimeMBean[]
    Relationship type: Reference.

    WLDFRuntime

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

           
    Privileges Read only
    TypeWLDFRuntimeMBean
    Relationship type: Reference.

    WLECConnectionServiceRuntime

    The WLECConnectionServiceRuntime for this server.

           
    Privileges Read only
    TypeWLECConnectionServiceRuntimeMBean
    Relationship type: Reference.

    WorkManagerRuntimes

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

           
    Privileges Read only
    TypeWorkManagerRuntimeMBean[]
    Relationship type: Reference.

    WTCRuntime

    The WTCRuntimeMBean for this server.

           
    Privileges Read only
    TypeWTCRuntimeMBean
    Relationship type: Reference.


    Attributes

    This section describes the following attributes:


    ActivationTime

    The time when the server was started.

           
    Privileges Read only
    Typelong

    AdministrationPort

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

    Deprecated. 9.0.0.0 Replaced by AdministrationURL

           
    Privileges Read only
    Typeint

    AdministrationPortEnabled

    Indicates whether the administration port is enabled on the server

           
    Privileges Read only
    Typeboolean

    AdministrationURL

    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.

           
    Privileges Read only
    Typejava.lang.String

    AdminServer

    Indicates whether the server is an Administration Server.

           
    Privileges Read only
    Typeboolean

    AdminServerHost

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

           
    Privileges Read only
    Typejava.lang.String

    AdminServerListenPort

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

           
    Privileges Read only
    Typeint

    AdminServerListenPortSecure

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

           
    Privileges Read only
    Typeboolean

    CachingDisabled

    Private property that disables caching in proxies.

           
    Privileges Read only
    Typeboolean

    CurrentDirectory

    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.

    For more information, see:

           
    Privileges Read only
    Typejava.lang.String

    CurrentMachine

    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.

           
    Privileges Read/Write
    Typejava.lang.String

    DefaultURL

    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.

           
    Privileges Read only
    Typejava.lang.String

    HealthState

    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.

           
    Privileges Read only
    Typeweblogic.health.HealthState

    ListenAddress

    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.

    Deprecated. 9.0.0.0 Replaced by URL

    For more information, see:

           
    Privileges Read only
    Typejava.lang.String

    ListenPort

    The port on which this server is listening for connections.

    Deprecated. 9.0.0.0 Replaced by URL

           
    Privileges Read only
    Typeint

    ListenPortEnabled

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

           
    Privileges Read only
    Typeboolean

    MBeanInfo

    Returns the MBean info for this MBean.

    Deprecated.

           
    Privileges Read only
    Typejavax.management.MBeanInfo

    Name

    The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

           
    Privileges Read only
    Typejava.lang.String

    ObjectName

    Returns the ObjectName under which this MBean is registered in the MBean server.

    Deprecated.

           
    Privileges Read only
    Typeweblogic.management.WebLogicObjectName

    OpenSocketsCurrentCount

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

           
    Privileges Read only
    Typeint

    Parent

    Return the immediate parent for this MBean

           
    Privileges Read/Write
    Type

    Registered

    Returns false if the the MBean represented by this object has been unregistered.

    Deprecated.

           
    Privileges Read only
    Typeboolean

    RestartRequired

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

           
    Available Since Release 9.0.0.0
    Privileges Read only
    Typeboolean

    RestartsTotalCount

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

           
    Privileges Read only
    Typeint

    ServerClasspath

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

           
    Available Since Release 9.0.0.0
    Privileges Read only
    Typejava.lang.String

    SocketsOpenedTotalCount

    The total number of registrations for socket muxing on this sever.

           
    Privileges Read only
    Typelong

    SSLListenAddress

    The address on which this server is listening for SSL connections. For example this might return the string: santiago/172.17.9.220

    Deprecated. 9.0.0.0 Replaced by URL

           
    Privileges Read only
    Typejava.lang.String

    SSLListenPort

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

    Deprecated. 9.0.0.0 Replaced by URL

           
    Privileges Read only
    Typeint

    SSLListenPortEnabled

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

           
    Privileges Read only
    Typeboolean

    State

    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.

    For more information, see:

           
    Privileges Read only
    Typejava.lang.String

    StateVal

    Returns current state of the server as in integer..

           
    Privileges Read only
    Typeint

    Type

    Returns the type of the MBean.

           
    Privileges Read only
    Typejava.lang.String

    WeblogicVersion

    The version of this WebLogic Server instance (server).

           
    Privileges Read only
    Typejava.lang.String


    Operations

    This section describes the following operations:


    addRequestClassRuntime

       
    Operation Name"addRequestClassRuntime"
    ParametersObject [] {   }

    where:

      SignatureString [] { "weblogic.management.runtime.RequestClassRuntimeMBean" }
      Returns boolean

      forceShutdown

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

             
      Operation Name"forceShutdown"
      Parametersnull
      Signaturenull
      Returns void
      Exceptions
      • weblogic.server.ServerLifecycleException
      Security roles Only the following roles can invoke this operation:
      • Operator

      forceSuspend

      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.

      For more information, see:

         
      Operation Name"forceSuspend"
      Parametersnull
      Signaturenull
      Returns void
      Exceptions
      • weblogic.server.ServerLifecycleException
        ServerLifecycleException server failed to force suspend. A {@link #forceShutdown()} operation can be invoked.

      getServerChannel

      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.

         
      Operation Name"getServerChannel"
      ParametersObject [] {  protocol }

      where:

      • protocol is an object of type java.lang.String that specifies:

        the desired protocol

      SignatureString [] { "java.lang.String" }
      ReturnsInetSocketAddress

      getURL

      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.

         
      Operation Name"getURL"
      ParametersObject [] {  protocol }

      where:

      • protocol is an object of type java.lang.String that specifies:

        the desired protocol

      SignatureString [] { "java.lang.String" }
      ReturnsString

      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.

         
      Operation Name"restartSSLChannels"
      Parametersnull
      Signaturenull
      Returns void

      resume

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

             
      Operation Name"resume"
      Parametersnull
      Signaturenull
      Returns void
      Exceptions
      • weblogic.server.ServerLifecycleException
      Security roles Only the following roles can invoke this operation:
      • Operator

      shutdown

      Gracefully shuts down the server after handling inflight work.

      For more information, see:

             
      Operation Name"shutdown"
      Parametersnull
      Signaturenull
      Returns void
      Exceptions
      • weblogic.server.ServerLifecycleException
      Security roles Only the following roles can invoke this operation:
      • Operator

      shutdown

      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.

             
      Operation Name"shutdown"
      ParametersObject [] {  timeoutignoreSessions }

      where:

      • timeout is an object of type java.lang.Integer that specifies:

        Number of seconds to wait before aborting inflight work and shutting down the server.

      • ignoreSessions is an object of type java.lang.Boolean that specifies:

        true

        indicates ignore pending HTTP sessions during inflight work handling.

      SignatureString [] { "java.lang.Integer", "java.lang.Boolean" }
      Returns void
      Exceptions
      • weblogic.server.ServerLifecycleException
      Security roles Only the following roles can invoke this operation:
      • Operator

      start

      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.

      Deprecated. Use suspend and resume operations instead of lock/unlock.

             
      Operation Name"start"
      Parametersnull
      Signaturenull
      Returns void
      Security roles Only the following roles can invoke this operation:
      • Operator

      suspend

      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

      For more information, see:

         
      Operation Name"suspend"
      ParametersObject [] {  timeoutignoreSessions }

      where:

      • timeout is an object of type java.lang.Integer that specifies:

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

      • ignoreSessions is an object of type java.lang.Boolean that specifies:

        drop inflight HTTP sessions during graceful suspend

      SignatureString [] { "java.lang.Integer", "java.lang.Boolean" }
      Returns void
      Exceptions
      • weblogic.server.ServerLifecycleException
        ServerLifecycleException server failed to suspend gracefully. A {@link #forceSuspend()} or a {@link #forceShutdown()} operation can be invoked.

      suspend

      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

      For more information, see:

         
      Operation Name"suspend"
      Parametersnull
      Signaturenull
      Returns void
      Exceptions
      • weblogic.server.ServerLifecycleException