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 */
026package org.opends.server.admin.std.server;
027
028
029
030import java.util.SortedSet;
031import org.opends.server.admin.Configuration;
032import org.opends.server.admin.server.ConfigurationChangeListener;
033import org.opends.server.types.DN;
034
035
036
037/**
038 * A server-side interface for querying Root DN User settings.
039 * <p>
040 * A Root DN User are administrative users who can granted special
041 * privileges that are not available to non-root users (for example,
042 * the ability to bind to the server in lockdown mode).
043 */
044public interface RootDNUserCfg extends Configuration {
045
046  /**
047   * Gets the configuration class associated with this Root DN User.
048   *
049   * @return Returns the configuration class associated with this Root DN User.
050   */
051  Class<? extends RootDNUserCfg> configurationClass();
052
053
054
055  /**
056   * Register to be notified when this Root DN User is changed.
057   *
058   * @param listener
059   *          The Root DN User configuration change listener.
060   */
061  void addChangeListener(ConfigurationChangeListener<RootDNUserCfg> listener);
062
063
064
065  /**
066   * Deregister an existing Root DN User configuration change listener.
067   *
068   * @param listener
069   *          The Root DN User configuration change listener.
070   */
071  void removeChangeListener(ConfigurationChangeListener<RootDNUserCfg> listener);
072
073
074
075  /**
076   * Gets the "alternate-bind-dn" property.
077   * <p>
078   * Specifies one or more alternate DNs that can be used to bind to
079   * the server as this root user.
080   *
081   * @return Returns an unmodifiable set containing the values of the "alternate-bind-dn" property.
082   */
083  SortedSet<DN> getAlternateBindDN();
084
085}