se.entra.phantom.server

Interface ServerProcessListener

All Known Implementing Classes:

TestConnector

public interface ServerProcessListener

This interface is used by the Connector to register itself as a listener for the server process events such as Start/Stop.

Method Summary

Modifier and Type	Method and Description
long	getRemainingStartTime(ClientSessionManager csm, int restartType) Gets the time in milliseconds before a start of the server is possible.
long	getRemainingStopTime(ClientSessionManager csm, int restartType) Gets the time in milliseconds before a stop of the server is possible.
void	onStart(ClientSessionManager csm, int restartType) Called just after all the Connectors are loaded and when the server is about to start.
void	onStarted(ClientSessionManager csm, int restartType) Called when the server has completed all the startup jobs and is in ready state.
void	onStop(ClientSessionManager csm, int restartType) Called when the server is about to initiate the stop process.
void	onStopped(ClientSessionManager csm, int restartType) Called when the server has reached the full stop state and will unload all connectors.

Method Detail

onStart

void onStart(ClientSessionManager csm,
             int restartType)

Called just after all the Connectors are loaded and when the server is about to start.

Parameters:

csm - The ClientSessionManager instance.

restartType - Value indicating the restart type of the server process,

getRemainingStartTime

long getRemainingStartTime(ClientSessionManager csm,
                           int restartType)

Gets the time in milliseconds before a start of the server is possible. This method may be called several times during the server start process in order to check that all connectors started properly. The return value should be zero if the connector is started successfully.

Parameters:

csm - The ClientSessionManager instance.

restartType - Value indicating the restart type of the server process,

Returns:

milliseconds The amount of milliseconds that the start server thread must wait in order for all connectors to complete their "start process".

onStarted

void onStarted(ClientSessionManager csm,
               int restartType)

Called when the server has completed all the startup jobs and is in ready state.

Parameters:

csm - The ClientSessionManager instance.

restartType - Value indicating the restart type of the server process,

onStop

void onStop(ClientSessionManager csm,
            int restartType)

Called when the server is about to initiate the stop process. The restart parameter indicates if the server will be restarted and if so how.

Parameters:

csm - The ClientSessionManager instance.

restartType - Value indicating the restart type of the server process.

getRemainingStopTime

long getRemainingStopTime(ClientSessionManager csm,
                          int restartType)

Gets the time in milliseconds before a stop of the server is possible. The maximum time the server will wait is defined in "server.ini". This method may be called several times during the server stop process in order to check that all connectors stops properly. If the maximum wait time is exceeded, the server will stop in all cases. The return value should be zero if the connector is stopped successfully.

Parameters:

csm - The ClientSessionManager instance.

restartType - Value indicating the restart type of the server process,

Returns:

milliseconds The amount of milliseconds that the stop server thread must wait in order for all connectors to complete their "stop process".

onStopped

void onStopped(ClientSessionManager csm,
               int restartType)

Called when the server has reached the full stop state and will unload all connectors.

Parameters:

csm - The ClientSessionManager instance.

restartType - Value indicating the restart type of the server process.