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 * trunk/opends/resource/legal-notices/OpenDS.LICENSE 011 * or https://OpenDS.dev.java.net/OpenDS.LICENSE. 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 * trunk/opends/resource/legal-notices/OpenDS.LICENSE. 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 2006-2008 Sun Microsystems, Inc. 026 */ 027 package org.opends.server.api; 028 import org.opends.messages.Message; 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) 042 public 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 public 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 public void processServerShutdown(Message reason); 061 } 062