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.client;
027
028
029
030import java.util.Collection;
031import java.util.SortedSet;
032import org.opends.server.admin.ManagedObjectDefinition;
033import org.opends.server.admin.PropertyException;
034import org.opends.server.admin.std.meta.BackendCfgDefn.WritabilityMode;
035import org.opends.server.admin.std.server.SchemaBackendCfg;
036import org.opends.server.types.DN;
037
038
039
040/**
041 * A client-side interface for reading and modifying Schema Backend
042 * settings.
043 * <p>
044 * The Schema Backend provides access to the directory server schema
045 * information, including the attribute types, object classes,
046 * attribute syntaxes, matching rules, matching rule uses, DIT content
047 * rules, and DIT structure rules that it contains.
048 */
049public interface SchemaBackendCfgClient extends BackendCfgClient {
050
051  /**
052   * Get the configuration definition associated with this Schema Backend.
053   *
054   * @return Returns the configuration definition associated with this Schema Backend.
055   */
056  ManagedObjectDefinition<? extends SchemaBackendCfgClient, ? extends SchemaBackendCfg> definition();
057
058
059
060  /**
061   * Gets the "java-class" property.
062   * <p>
063   * Specifies the fully-qualified name of the Java class that
064   * provides the backend implementation.
065   *
066   * @return Returns the value of the "java-class" property.
067   */
068  String getJavaClass();
069
070
071
072  /**
073   * Sets the "java-class" property.
074   * <p>
075   * Specifies the fully-qualified name of the Java class that
076   * provides the backend implementation.
077   *
078   * @param value The value of the "java-class" property.
079   * @throws PropertyException
080   *           If the new value is invalid.
081   */
082  void setJavaClass(String value) throws PropertyException;
083
084
085
086  /**
087   * Gets the "schema-entry-dn" property.
088   * <p>
089   * Defines the base DNs of the subtrees in which the schema
090   * information is published in addition to the value included in the
091   * base-dn property.
092   * <p>
093   * The value provided in the base-dn property is the only one that
094   * appears in the subschemaSubentry operational attribute of the
095   * server's root DSE (which is necessary because that is a
096   * single-valued attribute) and as a virtual attribute in other
097   * entries. The schema-entry-dn attribute may be used to make the
098   * schema information available in other locations to accommodate
099   * certain client applications that have been hard-coded to expect
100   * the schema to reside in a specific location.
101   *
102   * @return Returns the values of the "schema-entry-dn" property.
103   */
104  SortedSet<DN> getSchemaEntryDN();
105
106
107
108  /**
109   * Sets the "schema-entry-dn" property.
110   * <p>
111   * Defines the base DNs of the subtrees in which the schema
112   * information is published in addition to the value included in the
113   * base-dn property.
114   * <p>
115   * The value provided in the base-dn property is the only one that
116   * appears in the subschemaSubentry operational attribute of the
117   * server's root DSE (which is necessary because that is a
118   * single-valued attribute) and as a virtual attribute in other
119   * entries. The schema-entry-dn attribute may be used to make the
120   * schema information available in other locations to accommodate
121   * certain client applications that have been hard-coded to expect
122   * the schema to reside in a specific location.
123   *
124   * @param values The values of the "schema-entry-dn" property.
125   * @throws PropertyException
126   *           If one or more of the new values are invalid.
127   */
128  void setSchemaEntryDN(Collection<DN> values) throws PropertyException;
129
130
131
132  /**
133   * Gets the "show-all-attributes" property.
134   * <p>
135   * Indicates whether to treat all attributes in the schema entry as
136   * if they were user attributes regardless of their configuration.
137   * <p>
138   * This may provide compatibility with some applications that expect
139   * schema attributes like attributeTypes and objectClasses to be
140   * included by default even if they are not requested. Note that the
141   * ldapSyntaxes attribute is always treated as operational in order
142   * to avoid problems with attempts to modify the schema over
143   * protocol.
144   *
145   * @return Returns the value of the "show-all-attributes" property.
146   */
147  Boolean isShowAllAttributes();
148
149
150
151  /**
152   * Sets the "show-all-attributes" property.
153   * <p>
154   * Indicates whether to treat all attributes in the schema entry as
155   * if they were user attributes regardless of their configuration.
156   * <p>
157   * This may provide compatibility with some applications that expect
158   * schema attributes like attributeTypes and objectClasses to be
159   * included by default even if they are not requested. Note that the
160   * ldapSyntaxes attribute is always treated as operational in order
161   * to avoid problems with attempts to modify the schema over
162   * protocol.
163   *
164   * @param value The value of the "show-all-attributes" property.
165   * @throws PropertyException
166   *           If the new value is invalid.
167   */
168  void setShowAllAttributes(boolean value) throws PropertyException;
169
170
171
172  /**
173   * Gets the "writability-mode" property.
174   * <p>
175   * Specifies the behavior that the backend should use when
176   * processing write operations.
177   *
178   * @return Returns the value of the "writability-mode" property.
179   */
180  WritabilityMode getWritabilityMode();
181
182
183
184  /**
185   * Sets the "writability-mode" property.
186   * <p>
187   * Specifies the behavior that the backend should use when
188   * processing write operations.
189   *
190   * @param value The value of the "writability-mode" property.
191   * @throws PropertyException
192   *           If the new value is invalid.
193   */
194  void setWritabilityMode(WritabilityMode value) throws PropertyException;
195
196}