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 * docs/licenses/cddl.txt
011 * or http://www.opensource.org/licenses/cddl1.php.
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 * docs/licenses/cddl.txt.  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 2011-2021 Ping Identity Corporation
026 */
027package com.unboundid.directory.sdk.ds.api;
028
029import com.unboundid.directory.sdk.ds.internal.DirectoryServerExtension;
030import com.unboundid.directory.sdk.ds.types.BackendContext;
031import com.unboundid.util.Extensible;
032import com.unboundid.util.ThreadSafety;
033import com.unboundid.util.ThreadSafetyLevel;
034
035/**
036 * This interface defines a set of methods that may be used by extensions
037 * to perform any processing that they might find necessary
038 * whenever a backend is initialized and/or finalized.
039 */
040@Extensible()
041@DirectoryServerExtension()
042@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_THREADSAFE)
043public abstract class BackendInitializationListener
044{
045
046  /**
047   * Performs any processing that may be required whenever a backend
048   * has been registered for use in the Directory Server. This method will
049   * be invoked after the backend has been initialized and put into service.
050   *
051   * @param backendContext The backend that has been initialized and put into
052   *                       service.
053   */
054  public abstract void backendInitialized(BackendContext backendContext);
055
056
057
058  /**
059   * Performs any processing that may be required whenever a backend
060   * is de-registered from the Directory Server. This method will
061   * be invoked before the backend has been taken out of service.
062   *
063   * @param backendContext The backend that is about to be taken out of service.
064   */
065  public abstract void backendFinalized(BackendContext backendContext);
066
067}