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:
    Access Points Inherited from RuntimeMBean Because this MBean extends or implements RuntimeMBean, you can also access this MBean by retrieving RuntimeMBeans. The following attributes contain RuntimeMBeans and its subtypes:


    Related MBeans

    This section describes attributes that provide access to other MBeans.


    ApplicationRuntimes

    Returns the list of currently running Applications

               
    Factory Methods No explicit creator method. The child shares the lifecycle of its parent.
    Lookup OperationlookupApplicationRuntime(String name)

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

    Privileges Read only
    TypeApplicationRuntimeMBean[]
    Relationship type: Containment.

    AsyncReplicationRuntime

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

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

    BatchJobRepositoryRuntime

    Gets the BatchJobRepositoryRuntimeMBean for this server.

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

    ClassLoaderRuntime

    Get statistics for system-level class loading.

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

    ClusterRuntime

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

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

    ConcurrentManagedObjectsRuntime

    The ConcurrentManagedObjectsRuntimeMBean for this server.

    For more information, see:

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

    ConnectorServiceRuntime

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

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

    DefaultExecuteQueueRuntime

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

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

    EntityCacheCumulativeRuntime

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

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

    EntityCacheCurrentStateRuntime

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

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

    EntityCacheHistoricalRuntime

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

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

    ExecuteQueueRuntimes

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

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

    JDBCServiceRuntime

    The JDBCServiceRuntimeMBean for this server.

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

    JMSRuntime

    The JMSRuntimeMBean for this server.

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

    JoltRuntime

    The JoltConnectionServiceRuntimeMBean for this server.

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

    JTARuntime

    The transaction RuntimeMBean for this server.

    For more information, see:

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

    JVMRuntime

    The JVMRuntimeMBean for this server.

    For more information, see:

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

    LibraryRuntimes

    Returns all deployed Libraries

               
    Factory Methods No explicit creator method. The child shares the lifecycle of its parent.
    Lookup OperationlookupLibraryRuntime(String name)

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

    Privileges Read only
    TypeLibraryRuntimeMBean[]
    Relationship type: Containment.

    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.

    Deprecated. 12.1.3.0

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

    MailSessionRuntimes

    Return the runtimeMBeans for JavaMail Mail Sessions

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

    MANAsyncReplicationRuntime

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

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

    MANReplicationRuntime

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

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

    MaxThreadsConstraintRuntimes

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

               
    Factory Methods No explicit creator method. The child shares the lifecycle of its parent.
    Lookup OperationlookupMaxThreadsConstraintRuntime(String name)

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

    Privileges Read only
    TypeMaxThreadsConstraintRuntimeMBean[]
    Relationship type: Containment.

    MessagingBridgeRuntime

    The MessagingBridgeRuntimeMBean for this server

    Deprecated. 12.1.3.0 Replaced by MessagingBridgeRuntimes

               
    Factory Methods No explicit creator method. The child shares the lifecycle of its parent.
    Lookup OperationlookupMessagingBridgeRuntime(String name)

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

    Privileges Read only
    TypeMessagingBridgeRuntimeMBean
    Relationship type: Containment.

    MessagingBridgeRuntimes

    The MessagingBridgeRuntimeMBeans for this server

               
    Factory Methods No explicit creator method. The child shares the lifecycle of its parent.
    Lookup OperationlookupMessagingBridgeRuntime(String name)

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

    Privileges Read only
    TypeMessagingBridgeRuntimeMBean[]
    Relationship type: Containment.

    MinThreadsConstraintRuntimes

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

               
    Factory Methods No explicit creator method. The child shares the lifecycle of its parent.
    Lookup OperationlookupMinThreadsConstraintRuntime(String name)

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

    Privileges Read only
    TypeMinThreadsConstraintRuntimeMBean[]
    Relationship type: Containment.

    PartitionRuntimes

    Returns the list of partition runtime beans

               
    Factory Methods No explicit creator method. The child shares the lifecycle of its parent.
    Lookup OperationlookupPartitionRuntime(String name)

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

    Privileges Read only
    TypePartitionRuntimeMBean[]
    Relationship type: Containment.

    PathServiceRuntime

    Domain scoped PathServiceRuntimeMBean for this server.

    Deprecated. 12.2.1.0.0 replaced by PathServiceRuntimes

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

    PathServiceRuntimes

    Array of all PathServiceRuntimeMBean instances for Domain partition.

           
    Factory Methods No explicit creator method. The child shares the lifecycle of its parent.
    Privileges Read only

    Setter method for this attribute is deprecated. 12.2.1.0.0 replaced by {@link #addPathServiceRuntime}

    TypePathServiceRuntimeMBean[]
    Relationship type: Containment.

    PersistentStoreRuntimes

    Returns the mbeans that provides runtime information for each PersistentStore.

               
    Factory Methods No explicit creator method. The child shares the lifecycle of its parent.
    Lookup OperationlookupPersistentStoreRuntime(String name)

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

    Privileges Read only
    TypePersistentStoreRuntimeMBean[]
    Relationship type: Containment.

    RequestClassRuntimes

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

               
    Factory Methods No explicit creator method. The child shares the lifecycle of its parent.
    Lookup OperationlookupRequestClassRuntime(String name)

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

    Privileges Read only
    TypeRequestClassRuntimeMBean[]
    Relationship type: Containment.

    SAFRuntime

    The SAFRuntimeMBean for this server.

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

    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.

    ServerLogRuntime

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

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

    ServerSecurityRuntime

    Return the ServerSecurityRuntimeMBean for this server.

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

    SingleSignOnServicesRuntime

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

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

    SNMPAgentRuntime

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

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

    ThreadPoolRuntime

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

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

    TimerRuntime

    Get the runtime information about the WebLogic timer implementation.

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

    WANReplicationRuntime

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

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

    WebServerRuntimes

    Returns all the initialized webservers

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

    WLDFRuntime

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

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

    WorkManagerRuntimes

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

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

    WseeClusterFrontEndRuntime

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

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

    WseeWsrmRuntime

    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.

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

    WTCRuntime

    The WTCRuntimeMBean for this server.

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


    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.

    This attribute is not dynamic and requires a server restart to take effect.

           
    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.

           
    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.

    For more information, see:

           
    Privileges Read only
    Typeweblogic.health.HealthState

    HealthStateJMX

    The HealthState object returned as a CompositeData type.

    For more information, see:

           
    Privileges Read only
    Typejavax.management.openmbean.CompositeData

    InSitConfigState

    Returns true if sitconfig is applied.

           
    Available Since Release 12.2.1.3.0
    Privileges Read only
    Typeboolean

    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.

    This attribute is not dynamic and requires a server restart to take effect.

    Deprecated.

           
    Privileges Read only
    Typejavax.management.MBeanInfo

    MiddlewareHome

    The Oracle Middleware installation directory.

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

    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.

    This attribute is not dynamic and requires a server restart to take effect.

    Deprecated.

           
    Privileges Read only
    Typeweblogic.management.WebLogicObjectName

    OpenSocketsCurrentCount

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

           
    Privileges Read only
    Typeint

    OracleHome

    The directory where Oracle products are installed. Deprecated since 10.3.3

    Deprecated. WLS can no longer find out what ORACLE_HOME is

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

    OverallHealthState

    Determine the overall health state of this server, taking into account the health of each of its subsystems.

    For more information, see:

           
    Privileges Read only
    Typeweblogic.health.HealthState

    OverallHealthStateJMX

    The overall health state of this server returned as a CompositeData type.

    For more information, see:

           
    Privileges Read only
    Typejavax.management.openmbean.CompositeData

    Parent

    Return the immediate parent for this MBean

    This attribute is not dynamic and requires a server restart to take effect.

           
    Privileges Read/Write
    Type

    PatchList

    Returns information about installed patches on the server as an array of Strings. Each element of the array describes a patch, which is of the form:

    BugNumber;PatchID;DateApplied;Description

               
    Available Since Release 12.2.1.3.0
    Privileges Read only
    Security rolesRead access is granted only to the following roles:
    • Monitor
    Typeclass java.lang.String[]

    Registered

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

    This attribute is not dynamic and requires a server restart to take effect.

    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.

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

           
    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.

    Deprecated. Use OpenSocketsCurrentCount instead. Both methods return the same value. This method is being deprecated in favor of the other method.

           
    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.

           
    Privileges Read only
    Typejava.lang.String

    StateVal

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

           
    Privileges Read only
    Typeint

    Type

    Returns the type of the MBean.

    This attribute is not dynamic and requires a server restart to take effect.

           
    Privileges Read only
    Typejava.lang.String

    WeblogicHome

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

           
    Available Since Release 10.3.1.0
    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:


    bootPartition

    Boots the partition

           
    Operation Name"bootPartition"
    ParametersObject [] {  partitionName }

    where:

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

      name of the partition to boot

    SignatureString [] { "java.lang.String" }
    Returns void
    Exceptions
    • weblogic.management.PartitionLifeCycleException
      PartitionLifeCycleException partition failed to boot.
    Security roles Only the following roles can invoke this operation:
    • Operator

    forceRestartPartition

    Performs a forced restart of the specified partition, waiting the specified time after the halt completes before executing the operation to return the partition to its state in this server at the time the forceRestartPartition method was invoked.

           
    Operation Name"forceRestartPartition"
    ParametersObject [] {  partitionNamerestartDelayMillis }

    where:

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

      the partition to be restarted

    • restartDelayMillis is an object of type java.lang.Long that specifies:

      time in milliseconds to wait after halt before restarting

    SignatureString [] { "java.lang.String", "java.lang.Long" }
    Returns void
    Exceptions
    • weblogic.management.PartitionLifeCycleException
      PartitionLifeCycleException
    Security roles Only the following roles can invoke this operation:
    • Operator

    forceRestartPartition

    Performs a forced restart of the specified partition.

           
    Operation Name"forceRestartPartition"
    ParametersObject [] {  partitionName }

    where:

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

      partitionName

    SignatureString [] { "java.lang.String" }
    Returns void
    Exceptions
    • weblogic.management.PartitionLifeCycleException
    Security roles Only the following roles can invoke this operation:
    • Operator

    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

    forceShutdownResourceGroup

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

           
    Operation Name"forceShutdownResourceGroup"
    ParametersObject [] {  resourceGroupName }

    where:

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

      resourceGroupName

    SignatureString [] { "java.lang.String" }
    Returns void
    Exceptions
    • weblogic.management.ResourceGroupLifecycleException
    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.

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

    forceSuspendResourceGroup

    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.

       
    Operation Name"forceSuspendResourceGroup"
    ParametersObject [] {  resourceGroupName }

    where:

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

      resourceGroupName

    SignatureString [] { "java.lang.String" }
    Returns void
    Exceptions
    • weblogic.management.ResourceGroupLifecycleException
      weblogic.management.ResourceGroupLifecycleException partition failed to force suspend. A {@link #forceShutdown()} operation can be invoked.

    getIPv4URL

    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"getIPv4URL"
    ParametersObject [] {  protocol }

    where:

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

      the desired protocol

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

    getIPv6URL

    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"getIPv6URL"
    ParametersObject [] {  protocol }

    where:

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

      the desired protocol

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

    getRgState

           
    Operation Name"getRgState"
    ParametersObject [] {  resourceGroupName }

    where:

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

      resourceGroupName

    SignatureString [] { "java.lang.String" }
    ReturnsString
    Exceptions
    • weblogic.management.ResourceGroupLifecycleException
      ResourceGroupLifecycleException
    Security roles Only the following roles can invoke this operation:
    • Deployer
    • Operator
    • Monitor

    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

    resumeResourceGroup

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

           
    Operation Name"resumeResourceGroup"
    ParametersObject [] {  resourceGroupName }

    where:

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

      resourceGroupName

    SignatureString [] { "java.lang.String" }
    Returns void
    Exceptions
    • weblogic.management.ResourceGroupLifecycleException
    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 [] {  timeoutignoreSessionswaitForAllSessions }

    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.

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

      true

      indicates waiting for all HTTP sessions during inflight work handling; false indicates waiting for non-persisted HTTP sessions only.

    SignatureString [] { "java.lang.Integer", "java.lang.Boolean", "java.lang.Boolean" }
    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.

    This method is the same as calling: shutdown(timeout, ignoreSessions, false);

    For more information, see:

           
    Operation Name"shutdown"
    ParametersObject [] {  timeoutignoreSessions }

    where:

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

      timeout

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

      ignoreSessions

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

    shutdownResourceGroup

    Gracefully shuts down the resource group after handling inflight work.

    For more information, see:

           
    Operation Name"shutdownResourceGroup"
    ParametersObject [] {  resourceGroupName }

    where:

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

      resourceGroupName

    SignatureString [] { "java.lang.String" }
    Returns void
    Exceptions
    • weblogic.management.ResourceGroupLifecycleException
    Security roles Only the following roles can invoke this operation:
    • Operator

    shutdownResourceGroup

    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:

    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.

           
    Operation Name"shutdownResourceGroup"
    ParametersObject [] {  resourceGroupNametimeoutignoreSessionswaitForAllSessions }

    where:

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

      resourceGroupName

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

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

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

      true

      indicates ignore pending HTTP sessions during inflight work handling.

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

      true

      indicates waiting for all HTTP sessions during inflight work handling; false indicates waiting for non-persisted HTTP sessions only.

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

    shutdownResourceGroup

    Gracefully shuts down the resource group after handling inflight work.

    This method is same to call: shutdown(timeout, ignoreSessions, false);

    For more information, see:

           
    Operation Name"shutdownResourceGroup"
    ParametersObject [] {  resourceGroupNametimeoutignoreSessions }

    where:

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

      resourceGroupName

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

      timeout

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

      ignoreSessions

    SignatureString [] { "java.lang.String", "java.lang.Integer", "java.lang.Boolean" }
    Returns void
    Exceptions
    • weblogic.management.ResourceGroupLifecycleException
    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

    startPartition

    starts the partition.

       
    Operation Name"startPartition"
    ParametersObject [] {  partitionName }

    where:

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

      The resource group name

    SignatureString [] { "java.lang.String" }
    Returns void
    Exceptions
    • weblogic.management.PartitionLifeCycleException
      PartitionLifeCycleException partition failed to start.

    startPartitionInAdmin

    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

       
    Operation Name"startPartitionInAdmin"
    ParametersObject [] {  partitionName }

    where:

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

      partitionName

    SignatureString [] { "java.lang.String" }
    Returns void
    Exceptions
    • weblogic.management.PartitionLifeCycleException
      PartitionLifeCycleException partition failed to start in admin mode.

    startResourceGroup

    starts the resource group.

       
    Operation Name"startResourceGroup"
    ParametersObject [] {  resourceGroupName }

    where:

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

      The resource group name

    SignatureString [] { "java.lang.String" }
    Returns void
    Exceptions
    • weblogic.management.ResourceGroupLifecycleException
      ResourceGroupLifecycleException partition failed to start.

    startResourceGroupInAdmin

    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

       
    Operation Name"startResourceGroupInAdmin"
    ParametersObject [] {  resourceGroupName }

    where:

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

      resourceGroupName

    SignatureString [] { "java.lang.String" }
    Returns void
    Exceptions
    • weblogic.management.ResourceGroupLifecycleException
      ResourceGroupLifecycleException resource group failed to start in admin mode.

    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

    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

       
    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.

    suspendResourceGroup

    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

       
    Operation Name"suspendResourceGroup"
    ParametersObject [] {  resourceGroupNametimeoutignoreSessions }

    where:

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

      resourceGroupName

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

      timeout

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

      ignoreSessions

    SignatureString [] { "java.lang.String", "java.lang.Integer", "java.lang.Boolean" }
    Returns void
    Exceptions
    • weblogic.management.ResourceGroupLifecycleException

    suspendResourceGroup

    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

    For more information, see:

       
    Operation Name"suspendResourceGroup"
    ParametersObject [] {  resourceGroupName }

    where:

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

      resourceGroupName

    SignatureString [] { "java.lang.String" }
    Returns void
    Exceptions
    • weblogic.management.ResourceGroupLifecycleException