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