FileDocCategorySizeDatePackage
RemoteAdminChannel.javaAPI DocGlassfish v2 API5054Fri May 04 22:33:46 BST 2007com.sun.enterprise.admin.server.core.channel

RemoteAdminChannel

public interface RemoteAdminChannel implements Remote
Remote interface for admin channel

Fields Summary
Constructors Summary
Methods Summary
public intgetConflictedPort(byte[] key)
Obtain the port number that caused the port conflict. This should be invoked only if Status is kInstaceFailedCode

param
key shared secret
return
port number.

public intgetServerStatusCode(byte[] key)
Get server status code. This method will return one of the following constants from class com.sun.enterprise.admin.common.Status -- kInstanceStartingCode, kInstanceRunningCode or kInstanceStoppingCode representing starting, running and stopping condition for the instance.

param
key shared secret
returns
server status code denoting whether server is starting, running or stopping.

public booleanisRestartNeeded(byte[] key)
Is restart needed to use persistent server configuration. After a notification, the server may be in inconsistenet state with respect to persistent configuration because all changes to configuration can not be handled dynamically - A restart is needed in such cases to synchronize server with persistent configuration.

param
key shared secret
return
true if restart is required, false otherwise.

public booleanpingServer(byte[] key)
Ping server.

public com.sun.enterprise.admin.event.AdminEventResultsendNotification(byte[] key, com.sun.enterprise.admin.event.AdminEvent event)
Send a event notification.

param
event the event
param
key shared secret

public voidsetRestartNeeded(byte[] key, boolean needRestart)
Set restart needed status on server instance.

param
key shared secret
param
needRestart true if the instance should be restarted to use changes in persistent configuration.

public voidtriggerServerExit(byte[] key)
Trigger server exit now. This is applicable only for AS Socket Service based startup now.

param
key shared secret