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 legal-notices/CDDLv1_0.txt 010 * or http://forgerock.org/license/CDDLv1.0.html. 011 * See the License for the specific language governing permissions 012 * and limitations under the License. 013 * 014 * When distributing Covered Code, include this CDDL HEADER in each 015 * file and include the License file at legal-notices/CDDLv1_0.txt. 016 * If applicable, add the following below this CDDL HEADER, with the 017 * fields enclosed by brackets "[]" replaced with your own identifying 018 * information: 019 * Portions Copyright [yyyy] [name of copyright owner] 020 * 021 * CDDL HEADER END 022 * 023 * 024 * Copyright 2006-2008 Sun Microsystems, Inc. 025 * Portions Copyright 2014-2015 ForgeRock AS 026 */ 027package org.opends.server.api; 028import org.forgerock.i18n.LocalizableMessage; 029 030 031 032 033/** 034 * This interface defines a method that may be used to notify various 035 * Directory Server components that the server is shutting down. 036 */ 037@org.opends.server.types.PublicAPI( 038 stability=org.opends.server.types.StabilityLevel.VOLATILE, 039 mayInstantiate=false, 040 mayExtend=true, 041 mayInvoke=false) 042public interface ServerShutdownListener 043{ 044 /** 045 * Retrieves the human-readable name for this shutdown listener. 046 * 047 * @return The human-readable name for this shutdown listener. 048 */ 049 String getShutdownListenerName(); 050 051 052 053 /** 054 * Indicates that the Directory Server has received a request to 055 * stop running and that this shutdown listener should take any 056 * action necessary to prepare for it. 057 * 058 * @param reason The human-readable reason for the shutdown. 059 */ 060 void processServerShutdown(LocalizableMessage reason); 061} 062