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 2010-2019 Ping Identity Corporation
026 */
027package com.unboundid.directory.sdk.common.config;
028
029
030
031import com.unboundid.directory.sdk.common.types.ServerContext;
032import com.unboundid.util.NotExtensible;
033import com.unboundid.util.ThreadSafety;
034import com.unboundid.util.ThreadSafetyLevel;
035
036
037
038/**
039 * This interface defines a set of methods that may be used to obtain
040 * information about the general configuration for all types of extensions.
041 */
042@NotExtensible()
043@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_NOT_THREADSAFE)
044public interface GenericConfig
045{
046  /**
047   * Retrieves a handle to the server context for the server in which this
048   * extension is running.
049   *
050   * @return  A handle to the server context for the server in which this
051   *          extension is running.
052   */
053  ServerContext getServerContext();
054
055
056
057  /**
058   * Retrieves the DN of the entry containing the configuration for this
059   * extension.
060   *
061   * @return  The DN of the entry containing the configuration for this
062   *          extension.
063   */
064  String getConfigObjectDN();
065
066
067
068  /**
069   * Retrieves the name of the configuration object for this extension.  It will
070   * generally be the RDN value for the configuration DN.
071   *
072   * @return  The name of the configuration object for this extension.
073   */
074  String getConfigObjectName();
075}