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-2014 UnboundID Corp.
026     */
027    package com.unboundid.directory.sdk.common.api;
028    
029    
030    
031    import com.unboundid.directory.sdk.broker.internal.IdentityBrokerExtension;
032    import com.unboundid.directory.sdk.ds.internal.DirectoryServerExtension;
033    import com.unboundid.directory.sdk.metrics.internal.MetricsEngineExtension;
034    import com.unboundid.directory.sdk.proxy.internal.DirectoryProxyServerExtension;
035    import com.unboundid.directory.sdk.sync.internal.SynchronizationServerExtension;
036    import com.unboundid.util.Extensible;
037    import com.unboundid.util.ThreadSafety;
038    import com.unboundid.util.ThreadSafetyLevel;
039    
040    
041    
042    /**
043     * This interface defines a set of methods that should be implemented by classes
044     * which should be notified when the server has begun the process of shutting
045     * down.  Shutdown listeners should be registered with the server using the
046     * {@code ServerContext.registerShutdownListener} method, and the corresponding
047     * {@code deregisterShutdownListener} should be used to deregister the listener
048     * if it is no longer needed.
049     * <BR><BR>
050     * Most types of extensions will not need to implement this interface, since
051     * they may use their own finalization method to be notified when the extension
052     * is to be taken out of service (either because the server is shutting down or
053     * because the extension is being disabled or removed).  However, it may be
054     * useful for background threads that may not be tied to any single instance of
055     * an extension.
056     */
057    @Extensible()
058    @DirectoryServerExtension()
059    @DirectoryProxyServerExtension(appliesToLocalContent=true,
060         appliesToRemoteContent=false)
061    @SynchronizationServerExtension(appliesToLocalContent=true,
062         appliesToSynchronizedContent=false)
063    @MetricsEngineExtension()
064    @IdentityBrokerExtension()
065    @ThreadSafety(level=ThreadSafetyLevel.INTERFACE_NOT_THREADSAFE)
066    public interface ServerShutdownListener
067    {
068      /**
069       * Performs any processing that may be necessary when the server begins the
070       * shutdown process.
071       *
072       * @param  reason  Information about the reason for the shutdown.
073       */
074      void processServerShutdown(final String reason);
075    }