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.client;
017
018
019
020import java.util.Collection;
021import java.util.SortedSet;
022import org.forgerock.opendj.config.ConfigurationClient;
023import org.forgerock.opendj.config.ManagedObjectDefinition;
024import org.forgerock.opendj.config.PropertyException;
025import org.forgerock.opendj.ldap.DN;
026import org.forgerock.opendj.server.config.server.RootDNUserCfg;
027
028
029
030/**
031 * A client-side interface for reading and modifying Root DN User
032 * settings.
033 * <p>
034 * A Root DN User are administrative users who can granted special
035 * privileges that are not available to non-root users (for example,
036 * the ability to bind to the server in lockdown mode).
037 */
038public interface RootDNUserCfgClient extends ConfigurationClient {
039
040  /**
041   * Get the configuration definition associated with this Root DN User.
042   *
043   * @return Returns the configuration definition associated with this Root DN User.
044   */
045  ManagedObjectDefinition<? extends RootDNUserCfgClient, ? extends RootDNUserCfg> definition();
046
047
048
049  /**
050   * Gets the "alternate-bind-dn" property.
051   * <p>
052   * Specifies one or more alternate DNs that can be used to bind to
053   * the server as this root user.
054   *
055   * @return Returns the values of the "alternate-bind-dn" property.
056   */
057  SortedSet<DN> getAlternateBindDN();
058
059
060
061  /**
062   * Sets the "alternate-bind-dn" property.
063   * <p>
064   * Specifies one or more alternate DNs that can be used to bind to
065   * the server as this root user.
066   *
067   * @param values The values of the "alternate-bind-dn" property.
068   * @throws PropertyException
069   *           If one or more of the new values are invalid.
070   */
071  void setAlternateBindDN(Collection<DN> values) throws PropertyException;
072
073}