001    /*
002     * CDDL HEADER START
003     *
004     * The contents of this file are subject to the terms of the
005     * Common Development and Distribution License, Version 1.0 only
006     * (the "License").  You may not use this file except in compliance
007     * with the License.
008     *
009     * You can obtain a copy of the license at
010     * docs/licenses/cddl.txt
011     * or http://www.opensource.org/licenses/cddl1.php.
012     * See the License for the specific language governing permissions
013     * and limitations under the License.
014     *
015     * When distributing Covered Code, include this CDDL HEADER in each
016     * file and include the License file at
017     * docs/licenses/cddl.txt.  If applicable,
018     * add the following below this CDDL HEADER, with the fields enclosed
019     * by brackets "[]" replaced with your own identifying information:
020     *      Portions Copyright [yyyy] [name of copyright owner]
021     *
022     * CDDL HEADER END
023     *
024     *
025     *      Copyright 2010-2013 UnboundID Corp.
026     */
027    package com.unboundid.directory.sdk.common.api;
028    
029    
030    
031    import com.unboundid.directory.sdk.ds.internal.DirectoryServerExtension;
032    import com.unboundid.directory.sdk.metrics.internal.MetricsEngineExtension;
033    import com.unboundid.directory.sdk.proxy.internal.DirectoryProxyServerExtension;
034    import com.unboundid.directory.sdk.sync.internal.SynchronizationServerExtension;
035    import com.unboundid.util.Extensible;
036    import com.unboundid.util.ThreadSafety;
037    import com.unboundid.util.ThreadSafetyLevel;
038    
039    
040    
041    /**
042     * This interface defines a set of methods that should be implemented by classes
043     * which should be notified when the server has begun the process of shutting
044     * down.  Shutdown listeners should be registered with the server using the
045     * {@code ServerContext.registerShutdownListener} method, and the corresponding
046     * {@code deregisterShutdownListener} should be used to deregister the listener
047     * if it is no longer needed.
048     * <BR><BR>
049     * Most types of extensions will not need to implement this interface, since
050     * they may use their own finalization method to be notified when the extension
051     * is to be taken out of service (either because the server is shutting down or
052     * because the extension is being disabled or removed).  However, it may be
053     * useful for background threads that may not be tied to any single instance of
054     * an extension.
055     */
056    @Extensible()
057    @DirectoryServerExtension()
058    @DirectoryProxyServerExtension(appliesToLocalContent=true,
059         appliesToRemoteContent=false)
060    @SynchronizationServerExtension(appliesToLocalContent=true,
061         appliesToSynchronizedContent=false)
062    @MetricsEngineExtension()
063    @ThreadSafety(level=ThreadSafetyLevel.INTERFACE_NOT_THREADSAFE)
064    public interface ServerShutdownListener
065    {
066      /**
067       * Performs any processing that may be necessary when the server begins the
068       * shutdown process.
069       *
070       * @param  reason  Information about the reason for the shutdown.
071       */
072      void processServerShutdown(final String reason);
073    }