|
Oracle Fusion Middleware Java API Reference for Oracle WebLogic Server 12c (12.2.1) Part Number E55141-01 P4 Change 1723563 on 2015/10/09 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ServerLifeCycleRuntimeMBean
Provides methods that transition servers from one state to another. This class is instantiated only on the Administration Server, but you can use it to transition the states of Managed Servers as well as Administration Servers.
You cannot use it to start an Administration Server, and if you want to use it to start Managed Servers, you must first set up a Node Manager on each Managed Server's host machine.
If you want to use the methods that transition a server into the ADMIN
state, you must first set up an administration channel for that server.
Field Summary |
---|
Fields inherited from interface weblogic.server.ServerStates |
---|
ACTIVATE_LATER, ADMIN, FAILED, FAILED_NOT_RESTARTABLE, FAILED_RESTARTING, FORCE_SHUTTING_DOWN, FORCE_SUSPENDING, RESUMING, RUNNING, SHUTDOWN, SHUTDOWN_IN_PROCESS, SHUTDOWN_PENDING, SHUTTING_DOWN, STANDBY, STARTING, SUSPENDING, UNKNOWN |
Method Summary | |
---|---|
abstract ServerLifeCycleTaskRuntimeMBean |
forceShutdown() Immediately transitions a server to the SHUTDOWN state. |
abstract ServerLifeCycleTaskRuntimeMBean |
forceSuspend() Transitions the server from RUNNING to ADMIN state forcefully cancelling inflight work. |
abstract String |
getIPv4URL(String protocol) The IPv4 URL that clients use when connecting to this server using the specified protocol. |
abstract String |
getIPv6URL(String protocol) The IPv6 URL that clients use when connecting to this server using the specified protocol. |
abstract String |
getMiddlewareHome() The Oracle Middleware installation directory. |
abstract int |
getNodeManagerRestartCount() Number of times the server has been restarted using the NodeManager since creation. |
abstract String |
getState() The current state of the server. |
abstract ServerLifeCycleTaskRuntimeMBean[] |
getTasks() Get preexisting Server Lifecycle Tasks |
abstract String |
getWeblogicHome() The directory where the WebLogic Server instance (server) is installed, without the trailing "/server". |
abstract ServerLifeCycleTaskRuntimeMBean |
lookupTask(String taskName) Get preexisting Server Lifecycle Task |
abstract ServerLifeCycleTaskRuntimeMBean |
resume() Transitions the server from ADMIN to RUNNING state. |
abstract ServerLifeCycleTaskRuntimeMBean |
shutdown() Gracefully transitions a server to the SHUTDOWN state. |
abstract ServerLifeCycleTaskRuntimeMBean |
shutdown(int timeout, boolean ignoreSessions) Gracefully transitions a server to the SHUTDOWN state. |
abstract ServerLifeCycleTaskRuntimeMBean |
shutdown(int timeout, boolean ignoreSessions, boolean waitForAllSessions) Gracefully shutdown the server after handling inflight work. |
abstract ServerLifeCycleTaskRuntimeMBean |
start() Uses the Node Manager to start a Managed Server. |
abstract ServerLifeCycleTaskRuntimeMBean |
start(boolean disableMsiMode) Uses the Node Manager to start a Managed Server on the given machine |
abstract ServerLifeCycleTaskRuntimeMBean |
suspend() Gracefully suspends server to ADMIN state. |
abstract ServerLifeCycleTaskRuntimeMBean |
suspend(int timeout, boolean ignoreSessions) Transitions the server from RUNNING to ADMIN state gracefully. |
Methods inherited from interface weblogic.management.runtime.RuntimeMBean |
---|
addPropertyChangeListener, removePropertyChangeListener |
Methods inherited from interface weblogic.management.WebLogicMBean |
---|
getMBeanInfo, getName, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setName, setParent |
Methods inherited from interface javax.management.DynamicMBean |
---|
getAttribute, getAttributes, invoke, setAttribute, setAttributes |
Methods inherited from interface javax.management.MBeanRegistration |
---|
postDeregister, postRegister, preDeregister, preRegister |
Methods inherited from interface javax.management.NotificationBroadcaster |
---|
addNotificationListener, getNotificationInfo, removeNotificationListener |
Method Detail |
---|
ServerLifeCycleTaskRuntimeMBean start() throws ServerLifecycleException
Uses the Node Manager to start a Managed Server.
ServerLifecycleException
- If start operation failsServerLifeCycleTaskRuntimeMBean start(boolean disableMsiMode) throws ServerLifecycleException
Uses the Node Manager to start a Managed Server on the given machine
disableMsiMode:
- if true, the server will not start in Managed Server Independence modeServerLifecycleException
- If start operation failsServerLifeCycleTaskRuntimeMBean resume() throws ServerLifecycleException
Transitions the server from ADMIN
to RUNNING
state.
ServerLifecycleException
- If the resume operation failsServerLifeCycleTaskRuntimeMBean suspend() throws ServerLifecycleException
Gracefully suspends server to ADMIN
state. New requests are rejected and inflight work is allowed to complete.
ServerLifecycleException
- If the operation failsServerLifeCycleRuntimeMBean.suspend(int, boolean)
ServerLifeCycleTaskRuntimeMBean 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.
timeout
- Seconds to wait for server to transition gracefully. The server calls ServerLifeCycleRuntimeMBean.forceSuspend()
after timeout.ignoreSessions
- drop inflight HTTP sessions during graceful suspendServerLifecycleException
- server failed to suspend gracefully. A ServerLifeCycleRuntimeMBean.forceSuspend()
or a ServerLifeCycleRuntimeMBean.forceShutdown()
operation can be invoked.ServerLifeCycleTaskRuntimeMBean 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 forcefully.
ServerLifecycleException
- server failed to force suspend. A ServerLifeCycleRuntimeMBean.forceShutdown()
operation can be invoked.ServerLifeCycleTaskRuntimeMBean shutdown() throws ServerLifecycleException
Gracefully transitions a server to the SHUTDOWN
state. The server completes all current work before it shuts down.
ServerLifecycleException
- If the server fails to gracefully shutdown. A ServerLifeCycleRuntimeMBean.forceShutdown()
operation can be invoked.ServerLifeCycleTaskRuntimeMBean shutdown(int timeout, boolean ignoreSessions) throws ServerLifecycleException
Gracefully transitions a server to the SHUTDOWN
state. The server completes all current work before it shuts down.
This method is the same as calling:
shutdown(timeout, ignoreSessions, false);
timeout
- Number of seconds to wait before aborting inflight work and force shutting down the server.ignoreSessions
- Set to true
to ignore pending HTTP sessions during inflight work handling.ServerLifecycleException
- If the server fails to gracefully shutdown. A ServerLifeCycleRuntimeMBean.forceShutdown()
operation can be invoked.ServerLifeCycleTaskRuntimeMBean shutdown(int timeout, boolean ignoreSessions, boolean waitForAllSessions) throws ServerLifecycleException
Gracefully shutdown the server after handling inflight work. The following inflight work is handled :
Pending transaction's and TLOG checkpoint
Pending HTTP sessions
Pending JMS work
Pending work in the Work Managers
RMI requests with tx context or administrator calls
timeout
- Number of seconds to wait before aborting inflight work and force shutting down the server.ignoreSessions
- Set to true
to ignore pending HTTP sessions during inflight work handling.waitForAllSessions
- Set to true
to wait for all HTTP sessions duirng inflight work handling; false
to wait for non-persisted HTTP sessions only.ServerLifecycleException
- If the server fails to gracefully shutdown. A ServerLifeCycleRuntimeMBean.forceShutdown()
operation can be invoked.ServerLifeCycleTaskRuntimeMBean forceShutdown() throws ServerLifecycleException
Immediately transitions a server to the SHUTDOWN
state. The server immediately terminates all current work, moves through the SHUTTING_DOWN
state, and ends in the SHUTDOWN
state.
You can forcefully shut down a server from any state except UNKNOWN
.
ServerLifecycleException
- If force shutdown fails. The server process will exit after ServerMBean.ServerLifeCycleTimeoutVal() seconds.ServerLifeCycleTaskRuntimeMBean[] getTasks()
Get preexisting Server Lifecycle Tasks
ServerLifeCycleTaskRuntimeMBean lookupTask(String taskName)
Get preexisting Server Lifecycle Task
taskName
-String getState()
The current state of the server.
int getNodeManagerRestartCount()
String getWeblogicHome()
The directory where the WebLogic Server instance (server) is installed, without the trailing "/server".
String getMiddlewareHome()
The Oracle Middleware installation directory.
String getIPv4URL(String protocol)
The IPv4 URL that clients use when connecting to this server using the specified protocol.
protocol
- the desired protocolString getIPv6URL(String protocol)
The IPv6 URL that clients use when connecting to this server using the specified protocol.
protocol
- the desired protocol
|
Copyright 1996, 2015, Oracle and/or its affiliates. All rights reserved. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners. Oracle Fusion Middleware Java API Reference for Oracle WebLogic Server 12c (12.2.1) Part Number E55141-01 P4 Change 1723563 on 2015/10/09 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |