|
BEA Systems, Inc. | |||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
MBeanHome
interface.)Provides methods for retrieving runtime information about a server instance and for transitioning a server from one state to another.
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. For
more information, see "Developing Manageable Applications with JMX"
on http://edocs.bea.com.
Field Summary |
Fields inherited from interface weblogic.management.runtime.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 | |
boolean |
addRequestClassRuntime(weblogic.management.runtime.RequestClassRuntimeMBean temp)
|
void |
forceShutdown()
Force shutdown the server. |
void |
forceSuspend()
Transitions the server from RUNNING to ADMIN
state forcefully cancelling inflight work. |
long |
getActivationTime()
The time when the server was started. |
int |
getAdministrationPort()
Deprecated. 9.0.0.0 Replaced by getAdministrationURL() |
String |
getAdministrationURL()
The URL that the server and its clients use for administrative connections. |
String |
getAdminServerHost()
The address on which the Administration Server is listening for connections. |
int |
getAdminServerListenPort()
The port on which the Administration Server is listening for connections. |
ApplicationRuntimeMBean[] |
getApplicationRuntimes()
Returns the list of currently running Applications |
ClusterRuntimeMBean |
getClusterRuntime()
Return an MBean which represents this server's view of its cluster, if any. |
ConnectorServiceRuntimeMBean |
getConnectorServiceRuntime()
The access point for server wide control and monitoring of the Connector Container. |
String |
getCurrentDirectory()
The absolute path of the directory from which the server was started. |
String |
getCurrentMachine()
Return the machine on which the server is running. |
ExecuteQueueRuntimeMBean |
getDefaultExecuteQueueRuntime()
Return an MBean which exposes this server's default execute queue. |
String |
getDefaultURL()
The URL that clients use to connect to this server's default network channel. |
EntityCacheCumulativeRuntimeMBean |
getEntityCacheCumulativeRuntime()
Return an MBean which represents Cumulative Status of the XML Cache. |
EntityCacheCurrentStateRuntimeMBean |
getEntityCacheCurrentStateRuntime()
Return an MBean which represents Current Status of the XML Cache. |
EntityCacheCumulativeRuntimeMBean |
getEntityCacheHistoricalRuntime()
Return an MBean which represents Historical Status of the XML Cache. |
ExecuteQueueRuntimeMBean[] |
getExecuteQueueRuntimes()
Returns an array of MBeans which exposes this server's active execute queues. |
weblogic.health.HealthState |
getHealthState()
The health state of the server as reported by the server's self-health monitoring. |
weblogic.management.runtime.JDBCServiceRuntimeMBean |
getJDBCServiceRuntime()
The JDBCServiceRuntimeMBean for this server. |
JMSRuntimeMBean |
getJMSRuntime()
The JMSRuntimeMBean for this server. |
JoltConnectionServiceRuntimeMBean |
getJoltRuntime()
The JoltConnectionServiceRuntimeMBean for this server. |
JTARuntimeMBean |
getJTARuntime()
The transaction RuntimeMBean for this server. |
JVMRuntimeMBean |
getJVMRuntime()
The JVMRuntimeMBean for this server. |
weblogic.management.runtime.LibraryRuntimeMBean[] |
getLibraryRuntimes()
Returns all deployed Libraries |
String |
getListenAddress()
Deprecated. 9.0.0.0 Replaced by getURL(java.lang.String) |
int |
getListenPort()
Deprecated. 9.0.0.0 Replaced by getURL(java.lang.String) |
LogBroadcasterRuntimeMBean |
getLogBroadcasterRuntime()
The object which generates notifications on behalf of the logging subystem. |
weblogic.management.runtime.LogRuntimeMBean |
getLogRuntime()
Return the MBean which provides access to the control interface for WLS server logging. |
MailSessionRuntimeMBean[] |
getMailSessionRuntimes()
Return the runtimeMBeans for JavaMail Mail Sessions |
weblogic.management.runtime.MANReplicationRuntimeMBean |
getMANReplicationRuntime()
Return an MBean which represents this server's view of its MANReplicationRuntime, if any. |
weblogic.management.runtime.MaxThreadsConstraintRuntimeMBean[] |
getMaxThreadsConstraintRuntimes()
Returns an array of RuntimeMBeans which exposes this server's globally defined MaxThreadsConstraints. |
weblogic.management.runtime.MinThreadsConstraintRuntimeMBean[] |
getMinThreadsConstraintRuntimes()
Returns an array of RuntimeMBeans which exposes this server's globally defined MinThreadsConstraints. |
int |
getOpenSocketsCurrentCount()
The current number of sockets registered for socket muxing on this server. |
weblogic.management.runtime.PathServiceRuntimeMBean |
getPathServiceRuntime()
The PathServiceRuntimeMBean for this server. |
weblogic.management.runtime.PersistentStoreRuntimeMBean[] |
getPersistentStoreRuntimes()
Returns the mbeans that provides runtime information for each PersistentStore. |
weblogic.management.runtime.RequestClassRuntimeMBean[] |
getRequestClassRuntimes()
Returns an array of RuntimeMBeans which exposes this server's globally defined Request Classes. |
int |
getRestartsTotalCount()
The total number of restarts for this server since the cluster was last started. |
weblogic.management.runtime.SAFRuntimeMBean |
getSAFRuntime()
The SAFRuntimeMBean for this server. |
InetSocketAddress |
getServerChannel(String protocol)
The address on which this server is listening for connections that use the specified protocol. |
weblogic.management.runtime.ServerChannelRuntimeMBean[] |
getServerChannelRuntimes()
The network channels that are currently configured on the server. |
String |
getServerClasspath()
Get the classpath for this server including domain/lib contents that are automatically picked up and appended to the classpath. |
ServerSecurityRuntimeMBean |
getServerSecurityRuntime()
Return the ServerSecurityRuntimeMBean for this server. |
long |
getSocketsOpenedTotalCount()
The total number of registrations for socket muxing on this sever. |
String |
getSSLListenAddress()
Deprecated. 9.0.0.0 Replaced by getURL(java.lang.String) |
int |
getSSLListenPort()
Deprecated. 9.0.0.0 Replaced by getURL(java.lang.String) |
String |
getState()
The current life cycle state of this server. |
int |
getStateVal()
Returns current state of the server as in integer.. |
weblogic.management.runtime.ThreadPoolRuntimeMBean |
getThreadPoolRuntime()
Get the self-tuning thread pool's runtime information. |
weblogic.management.runtime.TimerRuntimeMBean |
getTimerRuntime()
Get the runtime information about the WebLogic timer implementation. |
String |
getURL(String protocol)
The URL that clients use when connecting to this server using the specified protocol. |
weblogic.management.runtime.WANReplicationRuntimeMBean |
getWANReplicationRuntime()
Return an MBean which represents this server's view of its WANReplicationRuntime, if any. |
String |
getWeblogicVersion()
The version of this WebLogic Server instance (server). |
WebServerRuntimeMBean[] |
getWebServerRuntimes()
Returns all the initialized webservers |
weblogic.management.runtime.WLDFRuntimeMBean |
getWLDFRuntime()
Return the MBean which provides access to all Diagnostic runtime MBeans. |
WLECConnectionServiceRuntimeMBean |
getWLECConnectionServiceRuntime()
The WLECConnectionServiceRuntime for this server. |
weblogic.management.runtime.WorkManagerRuntimeMBean[] |
getWorkManagerRuntimes()
Returns an array of MBeans which exposes this server's active internal WorkManagers. |
WTCRuntimeMBean |
getWTCRuntime()
The WTCRuntimeMBean for this server. |
boolean |
isAdministrationPortEnabled()
Indicates whether the administration port is enabled on the server |
boolean |
isAdminServer()
Indicates whether the server is an Administration Server. |
boolean |
isAdminServerListenPortSecure()
Indicates whether the port that the server uses for administrative traffic is configured to use a secure protocol. |
boolean |
isListenPortEnabled()
Indicates whether the default listen port is enabled on the server. |
boolean |
isRestartRequired()
Indicates whether the server must be restarted in order to activate configuration changes. |
boolean |
isSSLListenPortEnabled()
Indicates whether the default SSL listen port is enabled on the server |
ApplicationRuntimeMBean |
lookupApplicationRuntime(String name)
Returns the ApplicationRuntimeMBean asked for, by name. |
weblogic.management.runtime.LibraryRuntimeMBean |
lookupLibraryRuntime(String name)
Returns the LibraryRuntimeMBean asked for, by name. |
weblogic.management.runtime.PersistentStoreRuntimeMBean |
lookupPersistentStoreRuntime(String name)
Returns the Runtime mbean for the persistent store with the specified short name. |
void |
restartSSLChannels()
Restart all SSL channels on which the server is listening. |
void |
resume()
Resume suspended server. |
void |
setCurrentMachine(String machineName)
Return the machine on which the server is running. |
void |
setJTARuntime(JTARuntimeMBean b)
Sets the value of the JTARuntime attribute. |
void |
shutdown()
Gracefully shuts down the server after handling inflight work. |
void |
shutdown(int timeout,
boolean ignoreSessions)
Gracefully shuts down the server after handling inflight work; optionally ignores pending HTTP sessions while handling inflight work. |
void |
start()
Deprecated. Use suspend() and resume() operations
instead of lock/unlock. |
void |
suspend()
Suspend server. |
void |
suspend(int timeout,
boolean ignoreSessions)
Transitions the server from RUNNING to
ADMIN state gracefully. |
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 |
public boolean addRequestClassRuntime(weblogic.management.runtime.RequestClassRuntimeMBean temp)
public void forceShutdown() throws weblogic.server.ServerLifecycleException
Force shutdown the server. Causes the server to reject new requests and fail pending requests.
weblogic.server.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.public void forceSuspend() throws weblogic.server.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.
weblogic.server.ServerLifecycleException
- server failed to force suspend.
A forceShutdown()
operation can be invoked.public long getActivationTime()
The time when the server was started.
public int getAdministrationPort()
getAdministrationURL()
The port on which this server is listening for administrative requests.
public 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.
public String getAdminServerHost()
The address on which the Administration Server is listening for connections. For example, this might return the string: santiago
public int getAdminServerListenPort()
The port on which the Administration Server is listening for connections.
public ApplicationRuntimeMBean[] getApplicationRuntimes()
Returns the list of currently running Applications
public ClusterRuntimeMBean getClusterRuntime()
Return an MBean which represents this server's view of its cluster, if any.
public ConnectorServiceRuntimeMBean getConnectorServiceRuntime()
public String getCurrentDirectory()
The absolute path of the directory from which the server was started.
This may be used in conjunction with other relative paths in ServerMBean to compute full paths.
ServerMBean
public String getCurrentMachine()
public ExecuteQueueRuntimeMBean getDefaultExecuteQueueRuntime()
Return an MBean which exposes this server's default execute queue.
public 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
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.
public EntityCacheCumulativeRuntimeMBean getEntityCacheCumulativeRuntime()
Return an MBean which represents Cumulative Status of the XML Cache.
public EntityCacheCurrentStateRuntimeMBean getEntityCacheCurrentStateRuntime()
Return an MBean which represents Current Status of the XML Cache.
public EntityCacheCumulativeRuntimeMBean getEntityCacheHistoricalRuntime()
Return an MBean which represents Historical Status of the XML Cache.
public ExecuteQueueRuntimeMBean[] getExecuteQueueRuntimes()
Returns an array of MBeans which exposes this server's active execute queues.
public weblogic.health.HealthState getHealthState()
The health state of the server as reported by the server's self-health monitoring.
For example, the server can report if it is overloaded by too many requests, if it needs more memory resources, or if it will soon fail for other reasons.
getHealthState
in interface weblogic.health.HealthFeedback
public weblogic.management.runtime.JDBCServiceRuntimeMBean getJDBCServiceRuntime()
The JDBCServiceRuntimeMBean for this server.
public JMSRuntimeMBean getJMSRuntime()
The JMSRuntimeMBean for this server.
public JoltConnectionServiceRuntimeMBean getJoltRuntime()
The JoltConnectionServiceRuntimeMBean for this server.
public JTARuntimeMBean getJTARuntime()
The transaction RuntimeMBean for this server.
JTARuntimeMBean
public JVMRuntimeMBean getJVMRuntime()
The JVMRuntimeMBean for this server.
JVMRuntimeMBean
public weblogic.management.runtime.LibraryRuntimeMBean[] getLibraryRuntimes()
Returns all deployed Libraries
public String getListenAddress()
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.
#getServerChannel(protocol)
public int getListenPort()
getURL(java.lang.String)
The port on which this server is listening for connections.
public LogBroadcasterRuntimeMBean getLogBroadcasterRuntime() throws weblogic.management.ManagementException
weblogic.management.ManagementException
public weblogic.management.runtime.LogRuntimeMBean getLogRuntime()
Return the MBean which provides access to the control interface for WLS server logging.
public MailSessionRuntimeMBean[] getMailSessionRuntimes()
Return the runtimeMBeans for JavaMail Mail Sessions
public weblogic.management.runtime.MANReplicationRuntimeMBean getMANReplicationRuntime()
Return an MBean which represents this server's view of its MANReplicationRuntime, if any.
public weblogic.management.runtime.MaxThreadsConstraintRuntimeMBean[] getMaxThreadsConstraintRuntimes()
Returns an array of RuntimeMBeans which exposes this server's globally defined MaxThreadsConstraints.
public weblogic.management.runtime.MinThreadsConstraintRuntimeMBean[] getMinThreadsConstraintRuntimes()
Returns an array of RuntimeMBeans which exposes this server's globally defined MinThreadsConstraints.
public int getOpenSocketsCurrentCount()
The current number of sockets registered for socket muxing on this server.
public weblogic.management.runtime.PathServiceRuntimeMBean getPathServiceRuntime()
The PathServiceRuntimeMBean for this server.
public weblogic.management.runtime.PersistentStoreRuntimeMBean[] getPersistentStoreRuntimes()
Returns the mbeans that provides runtime information for each PersistentStore.
public weblogic.management.runtime.RequestClassRuntimeMBean[] getRequestClassRuntimes()
Returns an array of RuntimeMBeans which exposes this server's globally defined Request Classes.
public int getRestartsTotalCount()
The total number of restarts for this server since the cluster was last started.
public weblogic.management.runtime.SAFRuntimeMBean getSAFRuntime()
The SAFRuntimeMBean for this server.
public InetSocketAddress getServerChannel(String protocol)
The address on which this server is listening for connections that use the specified protocol.
The listen address is persisted in the domain's
config.xml
file, however when a server instance is
started, a command-line option can override the persisted listen
address. This getServerChannel
method returns the
listen address that is currently being used, not necessarily the
address that is specified in config.xml
.
The returned address will always be resolved.
protocol
- the desired protocol
public weblogic.management.runtime.ServerChannelRuntimeMBean[] getServerChannelRuntimes()
The network channels that are currently configured on the server.
public String getServerClasspath()
public ServerSecurityRuntimeMBean getServerSecurityRuntime()
Return the ServerSecurityRuntimeMBean for this server.
public long getSocketsOpenedTotalCount()
The total number of registrations for socket muxing on this sever.
public String getSSLListenAddress()
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
public int getSSLListenPort()
getURL(java.lang.String)
The port on which this server is listening for SSL connections.
public 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.
public int getStateVal()
Returns current state of the server as in integer..
public weblogic.management.runtime.ThreadPoolRuntimeMBean getThreadPoolRuntime()
Get the self-tuning thread pool's runtime information. This call
will return null
if the self-tuning implementation is
not enabled.
public weblogic.management.runtime.TimerRuntimeMBean getTimerRuntime()
Get the runtime information about the WebLogic timer implementation.
public String getURL(String protocol)
The URL that clients use when connecting to this server using the specified protocol.
The listen address and listen port for a given protocol are
persisted in the domain's config.xml
file, however
when a server instance is started, command-line options can
override these persisted values. This getURL
method
returns the URL values that are currently being used, not
necessarily the values that are specified in
config.xml
.
protocol
- the desired protocol
public weblogic.management.runtime.WANReplicationRuntimeMBean getWANReplicationRuntime()
Return an MBean which represents this server's view of its WANReplicationRuntime, if any.
public String getWeblogicVersion()
The version of this WebLogic Server instance (server).
public WebServerRuntimeMBean[] getWebServerRuntimes()
Returns all the initialized webservers
public weblogic.management.runtime.WLDFRuntimeMBean getWLDFRuntime()
Return the MBean which provides access to all Diagnostic runtime MBeans.
public WLECConnectionServiceRuntimeMBean getWLECConnectionServiceRuntime()
The WLECConnectionServiceRuntime for this server.
public weblogic.management.runtime.WorkManagerRuntimeMBean[] getWorkManagerRuntimes()
Returns an array of MBeans which exposes this server's active internal WorkManagers.
public WTCRuntimeMBean getWTCRuntime()
The WTCRuntimeMBean for this server.
public boolean isAdministrationPortEnabled()
Indicates whether the administration port is enabled on the server
public boolean isAdminServer()
Indicates whether the server is an Administration Server.
public boolean isAdminServerListenPortSecure()
Indicates whether the port that the server uses for administrative traffic is configured to use a secure protocol.
public boolean isListenPortEnabled()
Indicates whether the default listen port is enabled on the server.
public boolean isRestartRequired()
Indicates whether the server must be restarted in order to activate configuration changes.
public boolean isSSLListenPortEnabled()
Indicates whether the default SSL listen port is enabled on the server
public ApplicationRuntimeMBean lookupApplicationRuntime(String name)
Returns the ApplicationRuntimeMBean asked for, by name.
public weblogic.management.runtime.LibraryRuntimeMBean lookupLibraryRuntime(String name)
Returns the LibraryRuntimeMBean asked for, by name.
public weblogic.management.runtime.PersistentStoreRuntimeMBean lookupPersistentStoreRuntime(String name)
name
-
public void restartSSLChannels()
public void resume() throws weblogic.server.ServerLifecycleException
Resume suspended server. Allow new requests. This operation transitions
the server into RUNNING
state.
weblogic.server.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.public void setCurrentMachine(String machineName)
machineName
- public void setJTARuntime(JTARuntimeMBean b)
Sets the value of the JTARuntime attribute.
getJTARuntime()
public void shutdown() throws weblogic.server.ServerLifecycleException
Gracefully shuts down the server after handling inflight work.
weblogic.server.ServerLifecycleException
shutdown(int, boolean)
public void shutdown(int timeout, boolean ignoreSessions) throws weblogic.server.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.
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.
weblogic.server.ServerLifecycleException
- Thrown if the server cannot
gracefully shutdown. Use the forceShutdown command to shutdown the server.public void start()
suspend()
and resume()
operations
instead of lock/unlock.
Servers can be locked with the java weblogic.Admin LOCK
command. In a locked state, a server instance accepts only administrative
logins.
public void suspend() throws weblogic.server.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
weblogic.server.ServerLifecycleException
suspend(int, boolean)
,
weblogic.management.runtime.ServerStates.public void suspend(int timeout, boolean ignoreSessions) throws weblogic.server.ServerLifecycleException
Transitions the server from RUNNING
to
ADMIN
state gracefully.
Applications are in admin mode. Inflight work is completed.
Applications and resources are fully available to administrators in
ADMIN
state. But non-admin users are denied access to
applications and resources
timeout
- Seconds to wait for server to transition gracefully.
The server calls forceSuspend()
after timeout.ignoreSessions
- drop inflight HTTP sessions during graceful suspend
weblogic.server.ServerLifecycleException
- server failed to suspend gracefully.
A forceSuspend()
or a forceShutdown()
operation can be
invoked.
|
Documentation is available at http://e-docs.bea.com/wls/docs91 Copyright 2005 BEA Systems Inc. |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |