001/*
002 * The contents of this file are subject to the terms of the Common Development and
003 * Distribution License (the License). You may not use this file except in compliance with the
004 * License.
005 *
006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
007 * specific language governing permission and limitations under the License.
008 *
009 * When distributing Covered Software, include this CDDL Header Notice in each file and include
010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
011 * Header, with the fields enclosed by brackets [] replaced by your own identifying
012 * information: "Portions Copyright [year] [name of copyright owner]".
013 *
014 * Copyright 2008 Sun Microsystems, Inc.
015 */
016package org.forgerock.opendj.server.config.server;
017
018
019
020import java.util.SortedSet;
021import org.forgerock.opendj.config.Configuration;
022import org.forgerock.opendj.config.server.ConfigurationChangeListener;
023import org.forgerock.opendj.ldap.DN;
024
025
026
027/**
028 * A server-side interface for querying Root DN User settings.
029 * <p>
030 * A Root DN User are administrative users who can granted special
031 * privileges that are not available to non-root users (for example,
032 * the ability to bind to the server in lockdown mode).
033 */
034public interface RootDNUserCfg extends Configuration {
035
036  /**
037   * Gets the configuration class associated with this Root DN User.
038   *
039   * @return Returns the configuration class associated with this Root DN User.
040   */
041  Class<? extends RootDNUserCfg> configurationClass();
042
043
044
045  /**
046   * Register to be notified when this Root DN User is changed.
047   *
048   * @param listener
049   *          The Root DN User configuration change listener.
050   */
051  void addChangeListener(ConfigurationChangeListener<RootDNUserCfg> listener);
052
053
054
055  /**
056   * Deregister an existing Root DN User configuration change listener.
057   *
058   * @param listener
059   *          The Root DN User configuration change listener.
060   */
061  void removeChangeListener(ConfigurationChangeListener<RootDNUserCfg> listener);
062
063
064
065  /**
066   * Gets the "alternate-bind-dn" property.
067   * <p>
068   * Specifies one or more alternate DNs that can be used to bind to
069   * the server as this root user.
070   *
071   * @return Returns an unmodifiable set containing the values of the "alternate-bind-dn" property.
072   */
073  SortedSet<DN> getAlternateBindDN();
074
075}