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.client; 017 018 019 020import java.util.Collection; 021import java.util.SortedSet; 022import org.forgerock.opendj.config.ConfigurationClient; 023import org.forgerock.opendj.config.ManagedObjectDefinition; 024import org.forgerock.opendj.config.PropertyException; 025import org.forgerock.opendj.ldap.DN; 026import org.forgerock.opendj.server.config.server.RootDSEBackendCfg; 027 028 029 030/** 031 * A client-side interface for reading and modifying Root DSE Backend 032 * settings. 033 * <p> 034 * The Root DSE Backend contains the directory server root DSE. 035 */ 036public interface RootDSEBackendCfgClient extends ConfigurationClient { 037 038 /** 039 * Get the configuration definition associated with this Root DSE Backend. 040 * 041 * @return Returns the configuration definition associated with this Root DSE Backend. 042 */ 043 ManagedObjectDefinition<? extends RootDSEBackendCfgClient, ? extends RootDSEBackendCfg> definition(); 044 045 046 047 /** 048 * Gets the "show-all-attributes" property. 049 * <p> 050 * Indicates whether all attributes in the root DSE are to be 051 * treated like user attributes (and therefore returned to clients by 052 * default) regardless of the directory server schema configuration. 053 * 054 * @return Returns the value of the "show-all-attributes" property. 055 */ 056 Boolean isShowAllAttributes(); 057 058 059 060 /** 061 * Sets the "show-all-attributes" property. 062 * <p> 063 * Indicates whether all attributes in the root DSE are to be 064 * treated like user attributes (and therefore returned to clients by 065 * default) regardless of the directory server schema configuration. 066 * 067 * @param value The value of the "show-all-attributes" property. 068 * @throws PropertyException 069 * If the new value is invalid. 070 */ 071 void setShowAllAttributes(boolean value) throws PropertyException; 072 073 074 075 /** 076 * Gets the "show-subordinate-naming-contexts" property. 077 * <p> 078 * Indicates whether subordinate naming contexts should be visible 079 * in the namingContexts attribute of the RootDSE. By default only 080 * top level naming contexts are visible 081 * 082 * @return Returns the value of the "show-subordinate-naming-contexts" property. 083 */ 084 boolean isShowSubordinateNamingContexts(); 085 086 087 088 /** 089 * Sets the "show-subordinate-naming-contexts" property. 090 * <p> 091 * Indicates whether subordinate naming contexts should be visible 092 * in the namingContexts attribute of the RootDSE. By default only 093 * top level naming contexts are visible 094 * 095 * @param value The value of the "show-subordinate-naming-contexts" property. 096 * @throws PropertyException 097 * If the new value is invalid. 098 */ 099 void setShowSubordinateNamingContexts(boolean value) throws PropertyException; 100 101 102 103 /** 104 * Gets the "subordinate-base-dn" property. 105 * <p> 106 * Specifies the set of base DNs used for singleLevel, wholeSubtree, 107 * and subordinateSubtree searches based at the root DSE. 108 * 109 * @return Returns the values of the "subordinate-base-dn" property. 110 */ 111 SortedSet<DN> getSubordinateBaseDN(); 112 113 114 115 /** 116 * Sets the "subordinate-base-dn" property. 117 * <p> 118 * Specifies the set of base DNs used for singleLevel, wholeSubtree, 119 * and subordinateSubtree searches based at the root DSE. 120 * 121 * @param values The values of the "subordinate-base-dn" property. 122 * @throws PropertyException 123 * If one or more of the new values are invalid. 124 */ 125 void setSubordinateBaseDN(Collection<DN> values) throws PropertyException; 126 127}