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 2008 Sun Microsystems, Inc. 025 * Portions Copyright 2015 ForgeRock AS 026 */ 027package 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) 041public 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 void performBackendInitializationProcessing(Backend<?> backend); 053 054 /** 055 * Performs any processing that may be required whenever a backend 056 * is finalized. This method will be invoked after the backend has 057 * been taken out of service but before it has been finalized. 058 * 059 * @param backend The backend that has been taken out of service 060 * and is about to be finalized. 061 */ 062 void performBackendFinalizationProcessing(Backend<?> backend); 063} 064