org.opends.server.api
Interface ServerShutdownListener

All Known Implementing Classes:
AsyncronousTextWriter, IdleTimeLimitThread, JmxConnectionHandler, LDAPConnectionHandler, LDAPRequestHandler, MultifileTextWriter, ReferentialIntegrityPlugin

@PublicAPI(stability=VOLATILE,
           mayInstantiate=false,
           mayExtend=true,
           mayInvoke=false)
public interface ServerShutdownListener

This interface defines a method that may be used to notify various Directory Server components that the server is shutting down.


Method Summary
 java.lang.String getShutdownListenerName()
          Retrieves the human-readable name for this shutdown listener.
 void processServerShutdown(Message reason)
          Indicates that the Directory Server has received a request to stop running and that this shutdown listener should take any action necessary to prepare for it.
 

Method Detail

getShutdownListenerName

java.lang.String getShutdownListenerName()
Retrieves the human-readable name for this shutdown listener.

Returns:
The human-readable name for this shutdown listener.

processServerShutdown

void processServerShutdown(Message reason)
Indicates that the Directory Server has received a request to stop running and that this shutdown listener should take any action necessary to prepare for it.

Parameters:
reason - The human-readable reason for the shutdown.