weblogic.common

Class AdminServicesImpl

java.lang.Object

weblogic.common.AdminServicesImpl

All Implemented Interfaces:

AdminServicesDef

final class AdminServicesImpl
extends java.lang.Object
implements AdminServicesDef

Internal use only. Use the AdminServicesDef interface instead.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) T3Client	t3

Constructor Summary

Constructors

Constructor and Description
AdminServicesImpl(T3Client t3cl)

Method Summary

Modifier and Type	Method and Description
java.lang.String	cancelShut() Cancels a pending shutdown of a WebLogic Server.
(package private) static java.lang.Object	create(T3Client t3)
void	disableWatchDog() Disables a T3Client as an administrative WatchDog.
void	enableWatchDog(int intervalSecs) Enables a T3Client as an administrative WatchDog.
java.lang.String	lockServer(java.lang.String message) Locks the WebLogic Server from logins.
java.lang.String	ping() Pings a WebLogic Server from the specified T3Client.
java.lang.String	ping(byte[] echo) Pings a WebLogic Server from the specified T3Client with the specified array of bytes as a ping message.
java.lang.String	shut() Shuts down a WebLogic Server from a T3Client.
java.lang.String	shut(int waitSecs) Shuts down a WebLogic Server from a T3Client.
java.lang.String	shut(java.lang.String message, int waitSecs) Shuts down a WebLogic Server from a T3Client.
void	threadDump()
java.lang.String	unlockServer() Unlocks the WebLogic Server from logins.
java.lang.String	version() Gets the version of a WebLogic Server from a T3Client.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

t3

T3Client t3

Constructor Detail

AdminServicesImpl

AdminServicesImpl(T3Client t3cl)

Method Detail

create

static java.lang.Object create(T3Client t3)

ping

public java.lang.String ping(byte[] echo)
                      throws java.lang.Exception

Pings a WebLogic Server from the specified T3Client with the specified array of bytes as a ping message.

Specified by:

ping in interface AdminServicesDef

Parameters:

echo - Byte array to ping the server with

Returns:

An Administrator message that returns the success status of the ping

Throws:

java.lang.Exception - if there is an error

ping

public java.lang.String ping()
                      throws java.lang.Exception

Pings a WebLogic Server from the specified T3Client.

Returns:

An Administrator message that returns the success status of the ping

Throws:

java.lang.Exception - if there is an error

shut

public java.lang.String shut(int waitSecs)
                      throws java.lang.Exception

Shuts down a WebLogic Server from a T3Client.

This is a privileged method, and can only be invoked on a T3Client that has connected with a T3User "system" and the system password. Note that a fixed interval for shutdown of internal processes is built into WebLogic (about 20 seconds).

Specified by:

shut in interface AdminServicesDef

Parameters:

waitSecs - Delay interval before shutdown

Returns:

Message status of the shutdown request

Throws:

java.lang.Exception - if there is an error

shut

public java.lang.String shut()
                      throws java.lang.Exception

Shuts down a WebLogic Server from a T3Client.

This is a privileged method, and can only be invoked on a T3Client that has connected with a T3User "system" and the system password.

Specified by:

shut in interface AdminServicesDef

Returns:

Message indicating status of the shutdown request

Throws:

java.lang.Exception - if there is an error

shut

public java.lang.String shut(java.lang.String message,
                             int waitSecs)
                      throws java.lang.Exception

Shuts down a WebLogic Server from a T3Client.

This is a privileged method, and can only be invoked on a T3Client that has connected with a T3User "system" and the system password. Note that a fixed interval for shutdown of internal processes is built into WebLogic (about 20 seconds).

Specified by:

shut in interface AdminServicesDef

Parameters:

message - Shutdown message

waitSecs - Delay interval before shutdown

Returns:

Message status of the shutdown request

Throws:

java.lang.Exception - if there is an error

cancelShut

public java.lang.String cancelShut()
                            throws java.lang.Exception

Cancels a pending shutdown of a WebLogic Server.

This is a privileged method that can only be invoked on a T3Client that has connected with a T3User "system" and the system password.

Specified by:

cancelShut in interface AdminServicesDef

Returns:

Message status of the cancel request

Throws:

java.lang.Exception - if there is an error

lockServer

public java.lang.String lockServer(java.lang.String message)
                            throws java.lang.Exception

Locks the WebLogic Server from logins.

Specified by:

lockServer in interface AdminServicesDef

Parameters:

message - Message rejecting logins

Returns:

Message status

Throws:

java.lang.Exception - if there is an error

unlockServer

public java.lang.String unlockServer()
                              throws java.lang.Exception

Unlocks the WebLogic Server from logins.

Specified by:

unlockServer in interface AdminServicesDef

Returns:

Message status

Throws:

java.lang.Exception - if there is an error

version

public java.lang.String version()
                         throws java.lang.Exception

Gets the version of a WebLogic Server from a T3Client.

Specified by:

version in interface AdminServicesDef

Returns:

Version information

Throws:

java.lang.Exception - if there is an error

enableWatchDog

public void enableWatchDog(int intervalSecs)
                    throws java.lang.Exception

Enables a T3Client as an administrative WatchDog.

When a client is an WatchDog, the client is then responsible for invoking the ping() method every intervalSecs seconds. The ping() will check that the WebLogic Server is still alive and reset the WebLogic Server's internal WatchDog timer. If the WebLogic Server fails to receive a ping within this interval, it will restart itself.

It is bad form to only call ping() every intervalSecs because if there is a transient network problem, then you will have squandered your only chance to restart the server. In practice, send a ping three or four times per intervalSecs. So, if intervalSecs is 60, you probably want to invoke ping() every 15-20 seconds.

Note that the T3Administrator can (and probably should) invoke T3Client.setSoftDisconnectTimeoutMins(int minutes) to some number greater than intervalSecs*60, and then periodically T3Client.disconnect(), and then instantiate a new T3Client with the same workspaceID. This will permit the WatchDog to not only test the existing socket to the WebLogic Server, but also the ability of T3Clients to connect to the WebLogic Server.

This is a privileged method, and can only be invoked on a T3Client that has specified a T3User of "system" and supplies the system password.

Specified by:

enableWatchDog in interface AdminServicesDef

Parameters:

intervalSecs - Interval for pings

Throws:

java.lang.Exception - if there is an error

disableWatchDog

public void disableWatchDog()
                     throws java.lang.Exception

Disables a T3Client as an administrative WatchDog. You MUST do this before you exit your program or permanently disconnect(), otherwise the WebLogic Server will restart itself!

This is a privileged method, and can only be invoked on a T3Client that has specified a T3User of "system".

Specified by:

disableWatchDog in interface AdminServicesDef

Throws:

java.lang.Exception - if there is an error

threadDump

public void threadDump()
                throws java.lang.Exception

Specified by:

threadDump in interface AdminServicesDef

Throws:

java.lang.Exception