001/* 002 * The contents of this file are subject to the terms of the Common Development and 003 * Distribution License (the License). You may not use this file except in compliance with the 004 * License. 005 * 006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the 007 * specific language governing permission and limitations under the License. 008 * 009 * When distributing Covered Software, include this CDDL Header Notice in each file and include 010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL 011 * Header, with the fields enclosed by brackets [] replaced by your own identifying 012 * information: "Portions Copyright [year] [name of copyright owner]". 013 * 014 * Copyright 2008 Sun Microsystems, Inc. 015 */ 016package org.forgerock.opendj.server.config.server; 017 018 019 020import java.util.SortedSet; 021import org.forgerock.opendj.config.Configuration; 022import org.forgerock.opendj.config.server.ConfigurationChangeListener; 023import org.forgerock.opendj.ldap.DN; 024 025 026 027/** 028 * A server-side interface for querying Root DSE Backend settings. 029 * <p> 030 * The Root DSE Backend contains the directory server root DSE. 031 */ 032public interface RootDSEBackendCfg extends Configuration { 033 034 /** 035 * Gets the configuration class associated with this Root DSE Backend. 036 * 037 * @return Returns the configuration class associated with this Root DSE Backend. 038 */ 039 Class<? extends RootDSEBackendCfg> configurationClass(); 040 041 042 043 /** 044 * Register to be notified when this Root DSE Backend is changed. 045 * 046 * @param listener 047 * The Root DSE Backend configuration change listener. 048 */ 049 void addChangeListener(ConfigurationChangeListener<RootDSEBackendCfg> listener); 050 051 052 053 /** 054 * Deregister an existing Root DSE Backend configuration change listener. 055 * 056 * @param listener 057 * The Root DSE Backend configuration change listener. 058 */ 059 void removeChangeListener(ConfigurationChangeListener<RootDSEBackendCfg> listener); 060 061 062 063 /** 064 * Gets the "show-all-attributes" property. 065 * <p> 066 * Indicates whether all attributes in the root DSE are to be 067 * treated like user attributes (and therefore returned to clients by 068 * default) regardless of the directory server schema configuration. 069 * 070 * @return Returns the value of the "show-all-attributes" property. 071 */ 072 boolean isShowAllAttributes(); 073 074 075 076 /** 077 * Gets the "show-subordinate-naming-contexts" property. 078 * <p> 079 * Indicates whether subordinate naming contexts should be visible 080 * in the namingContexts attribute of the RootDSE. By default only 081 * top level naming contexts are visible 082 * 083 * @return Returns the value of the "show-subordinate-naming-contexts" property. 084 */ 085 boolean isShowSubordinateNamingContexts(); 086 087 088 089 /** 090 * Gets the "subordinate-base-dn" property. 091 * <p> 092 * Specifies the set of base DNs used for singleLevel, wholeSubtree, 093 * and subordinateSubtree searches based at the root DSE. 094 * 095 * @return Returns an unmodifiable set containing the values of the "subordinate-base-dn" property. 096 */ 097 SortedSet<DN> getSubordinateBaseDN(); 098 099}