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 2008 Sun Microsystems, Inc. 026 */ 027 package org.opends.server.api; 028 029 030 031 /** 032 * This interface defines a set of methods that may be used by server 033 * components to perform any processing that they might find necessary 034 * whenever a backend is initialized and/or finalized. 035 */ 036 @org.opends.server.types.PublicAPI( 037 stability=org.opends.server.types.StabilityLevel.VOLATILE, 038 mayInstantiate=false, 039 mayExtend=true, 040 mayInvoke=false) 041 public interface BackendInitializationListener 042 { 043 /** 044 * Performs any processing that may be required whenever a backend 045 * is initialized for use in the Directory Server. This method will 046 * be invoked after the backend has been initialized but before it 047 * has been put into service. 048 * 049 * @param backend The backend that has been initialized and is 050 * about to be put into service. 051 */ 052 public void performBackendInitializationProcessing(Backend backend); 053 054 055 056 /** 057 * Performs any processing that may be required whenever a backend 058 * is finalized. This method will be invoked after the backend has 059 * been taken out of service but before it has been finalized. 060 * 061 * @param backend The backend that has been taken out of service 062 * and is about to be finalized. 063 */ 064 public void performBackendFinalizationProcessing(Backend backend); 065 } 066