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 DSE Backend settings. 040 * <p> 041 * The Root DSE Backend contains the Directory Server root DSE. 042 */ 043 public interface RootDSEBackendCfg extends Configuration { 044 045 /** 046 * Gets the configuration class associated with this Root DSE Backend. 047 * 048 * @return Returns the configuration class associated with this Root DSE Backend. 049 */ 050 Class<? extends RootDSEBackendCfg> configurationClass(); 051 052 053 054 /** 055 * Register to be notified when this Root DSE Backend is changed. 056 * 057 * @param listener 058 * The Root DSE Backend configuration change listener. 059 */ 060 void addChangeListener(ConfigurationChangeListener<RootDSEBackendCfg> listener); 061 062 063 064 /** 065 * Deregister an existing Root DSE Backend configuration change listener. 066 * 067 * @param listener 068 * The Root DSE Backend configuration change listener. 069 */ 070 void removeChangeListener(ConfigurationChangeListener<RootDSEBackendCfg> listener); 071 072 073 074 /** 075 * Gets the "show-all-attributes" property. 076 * <p> 077 * Indicates whether all attributes in the root DSE are to be 078 * treated like user attributes (and therefore returned to clients by 079 * default) regardless of the Directory Server schema configuration. 080 * 081 * @return Returns the value of the "show-all-attributes" property. 082 */ 083 boolean isShowAllAttributes(); 084 085 086 087 /** 088 * Gets the "subordinate-base-dn" property. 089 * <p> 090 * Specifies the set of base DNs used for singleLevel, wholeSubtree, 091 * and subordinateSubtree searches based at the root DSE. 092 * 093 * @return Returns an unmodifiable set containing the values of the "subordinate-base-dn" property. 094 */ 095 SortedSet<DN> getSubordinateBaseDN(); 096 097 }