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