com.unboundid.directory.sdk.common.api

Interface ServerShutdownListener

@Extensible
 @DirectoryServerExtension
 @DirectoryProxyServerExtension(appliesToLocalContent=true,
                               appliesToRemoteContent=false)
 @SynchronizationServerExtension(appliesToLocalContent=true,
                                appliesToSynchronizedContent=false)
 @MetricsEngineExtension
 @BrokerExtension
 @ThreadSafety(level=INTERFACE_NOT_THREADSAFE)
public interface ServerShutdownListener

This interface defines a set of methods that should be implemented by classes which should be notified when the server has begun the process of shutting down. Shutdown listeners should be registered with the server using the ServerContext.registerShutdownListener method, and the corresponding deregisterShutdownListener should be used to deregister the listener if it is no longer needed.

Most types of extensions will not need to implement this interface, since they may use their own finalization method to be notified when the extension is to be taken out of service (either because the server is shutting down or because the extension is being disabled or removed). However, it may be useful for background threads that may not be tied to any single instance of an extension.

Method Summary

Modifier and Type	Method and Description
void	processServerShutdown(java.lang.String reason) Performs any processing that may be necessary when the server begins the shutdown process.

Method Detail

processServerShutdown

void processServerShutdown(java.lang.String reason)

Performs any processing that may be necessary when the server begins the shutdown process.

Parameters:

reason - Information about the reason for the shutdown.