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