com.sun.appserv.server
Interface ServerLifecycle

All Known Implementing Classes:

LifecycleModuleService, ServerLifecycleImpl

public interface ServerLifecycle

ServerLifecycle interface: common lifecycle interface for application server and its subsystems. This interface is implemented by the ApplicationServer and its subsystems such as the web container or EJB container, in order to provide a consistent mechanism for server initialization-startup-shutdown-termination lifecycle.

Method Summary

void	onInitialization(com.sun.enterprise.server.ServerContext sc) Server is initializing subsystems and setting up the runtime environment.
void	onReady(com.sun.enterprise.server.ServerContext sc) Server has complted loading the applications and is ready to serve requests.
void	onShutdown() Server is shutting down applications
void	onStartup(com.sun.enterprise.server.ServerContext sc) Server is starting up applications
void	onTermination() Server is terminating the subsystems and the runtime environment.

Method Detail

onInitialization

public void onInitialization(com.sun.enterprise.server.ServerContext sc)
                      throws ServerLifecycleException

Server is initializing subsystems and setting up the runtime environment. Prepare for the beginning of active use of the public methods of this subsystem. This method is called before any of the public methods of this subsystem are utilized.

Parameters:

sc - ServerContext the server runtime context.

Throws:

java.lang.IllegalStateException - if this subsystem has already been started

ServerLifecycleException - if this subsystem detects a fatal error that prevents this subsystem from being used

onStartup

public void onStartup(com.sun.enterprise.server.ServerContext sc)
               throws ServerLifecycleException

Server is starting up applications

Parameters:

sc - ServerContext the server runtime context.

Throws:

ServerLifecycleException - if this subsystem detects a fatal error that prevents this subsystem from being used

onReady

public void onReady(com.sun.enterprise.server.ServerContext sc)
             throws ServerLifecycleException

Server has complted loading the applications and is ready to serve requests.

Parameters:

sc - ServerContext the server runtime context.

Throws:

ServerLifecycleException - if this subsystem detects a fatal error that prevents this subsystem from being used

onShutdown

public void onShutdown()
                throws ServerLifecycleException

Server is shutting down applications

Throws:

ServerLifecycleException - if this subsystem detects a fatal error that prevents this subsystem from being used

onTermination

public void onTermination()
                   throws ServerLifecycleException

Server is terminating the subsystems and the runtime environment. Gracefully terminate the active use of the public methods of this subsystem. This method should be the last one called on a given instance of this subsystem.

Throws:

ServerLifecycleException - if this subsystem detects a fatal error that prevents this subsystem from being used