001/* 002 * The contents of this file are subject to the terms of the Common Development and 003 * Distribution License (the License). You may not use this file except in compliance with the 004 * License. 005 * 006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the 007 * specific language governing permission and limitations under the License. 008 * 009 * When distributing Covered Software, include this CDDL Header Notice in each file and include 010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL 011 * Header, with the fields enclosed by brackets [] replaced by your own identifying 012 * information: "Portions Copyright [year] [name of copyright owner]". 013 * 014 * Copyright 2006-2008 Sun Microsystems, Inc. 015 * Portions Copyright 2014-2015 ForgeRock AS. 016 */ 017package org.opends.server.api; 018import org.forgerock.i18n.LocalizableMessage; 019 020 021 022 023/** 024 * This interface defines a method that may be used to notify various 025 * Directory Server components that the server is shutting down. 026 */ 027@org.opends.server.types.PublicAPI( 028 stability=org.opends.server.types.StabilityLevel.VOLATILE, 029 mayInstantiate=false, 030 mayExtend=true, 031 mayInvoke=false) 032public interface ServerShutdownListener 033{ 034 /** 035 * Retrieves the human-readable name for this shutdown listener. 036 * 037 * @return The human-readable name for this shutdown listener. 038 */ 039 String getShutdownListenerName(); 040 041 042 043 /** 044 * Indicates that the Directory Server has received a request to 045 * stop running and that this shutdown listener should take any 046 * action necessary to prepare for it. 047 * 048 * @param reason The human-readable reason for the shutdown. 049 */ 050 void processServerShutdown(LocalizableMessage reason); 051} 052