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