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.meta;
027
028
029
030import org.opends.server.admin.AdministratorAction;
031import org.opends.server.admin.BooleanPropertyDefinition;
032import org.opends.server.admin.ClassPropertyDefinition;
033import org.opends.server.admin.client.AuthorizationException;
034import org.opends.server.admin.client.CommunicationException;
035import org.opends.server.admin.client.ConcurrentModificationException;
036import org.opends.server.admin.client.ManagedObject;
037import org.opends.server.admin.client.MissingMandatoryPropertiesException;
038import org.opends.server.admin.client.OperationRejectedException;
039import org.opends.server.admin.ManagedObjectAlreadyExistsException;
040import org.opends.server.admin.ManagedObjectDefinition;
041import org.opends.server.admin.PropertyException;
042import org.opends.server.admin.PropertyOption;
043import org.opends.server.admin.PropertyProvider;
044import org.opends.server.admin.server.ConfigurationChangeListener;
045import org.opends.server.admin.server.ServerManagedObject;
046import org.opends.server.admin.std.client.AttributeSyntaxCfgClient;
047import org.opends.server.admin.std.server.AttributeSyntaxCfg;
048import org.opends.server.admin.Tag;
049import org.opends.server.admin.TopCfgDefn;
050import org.opends.server.admin.UndefinedDefaultBehaviorProvider;
051import org.opends.server.types.DN;
052
053
054
055/**
056 * An interface for querying the Attribute Syntax managed object
057 * definition meta information.
058 * <p>
059 * Attribute Syntaxes define the type of data that may be stored in an
060 * attribute with that syntax. A syntax is generally associated with a
061 * set of matching rules that indicate how to perform matching
062 * operations against values of that syntax.
063 */
064public final class AttributeSyntaxCfgDefn extends ManagedObjectDefinition<AttributeSyntaxCfgClient, AttributeSyntaxCfg> {
065
066  // The singleton configuration definition instance.
067  private static final AttributeSyntaxCfgDefn INSTANCE = new AttributeSyntaxCfgDefn();
068
069
070
071  // The "enabled" property definition.
072  private static final BooleanPropertyDefinition PD_ENABLED;
073
074
075
076  // The "java-class" property definition.
077  private static final ClassPropertyDefinition PD_JAVA_CLASS;
078
079
080
081  // Build the "enabled" property definition.
082  static {
083      BooleanPropertyDefinition.Builder builder = BooleanPropertyDefinition.createBuilder(INSTANCE, "enabled");
084      builder.setOption(PropertyOption.MANDATORY);
085      builder.setAdministratorAction(new AdministratorAction(AdministratorAction.Type.NONE, INSTANCE, "enabled"));
086      builder.setDefaultBehaviorProvider(new UndefinedDefaultBehaviorProvider<Boolean>());
087      PD_ENABLED = builder.getInstance();
088      INSTANCE.registerPropertyDefinition(PD_ENABLED);
089  }
090
091
092
093  // Build the "java-class" property definition.
094  static {
095      ClassPropertyDefinition.Builder builder = ClassPropertyDefinition.createBuilder(INSTANCE, "java-class");
096      builder.setOption(PropertyOption.READ_ONLY);
097      builder.setOption(PropertyOption.MANDATORY);
098      builder.setAdministratorAction(new AdministratorAction(AdministratorAction.Type.COMPONENT_RESTART, INSTANCE, "java-class"));
099      builder.setDefaultBehaviorProvider(new UndefinedDefaultBehaviorProvider<String>());
100      builder.addInstanceOf("org.opends.server.api.AttributeSyntax");
101      PD_JAVA_CLASS = builder.getInstance();
102      INSTANCE.registerPropertyDefinition(PD_JAVA_CLASS);
103  }
104
105
106
107  // Register the tags associated with this managed object definition.
108  static {
109    INSTANCE.registerTag(Tag.valueOf("core-server"));
110  }
111
112
113
114  /**
115   * Get the Attribute Syntax configuration definition singleton.
116   *
117   * @return Returns the Attribute Syntax configuration definition
118   *         singleton.
119   */
120  public static AttributeSyntaxCfgDefn getInstance() {
121    return INSTANCE;
122  }
123
124
125
126  /**
127   * Private constructor.
128   */
129  private AttributeSyntaxCfgDefn() {
130    super("attribute-syntax", TopCfgDefn.getInstance());
131  }
132
133
134
135  /**
136   * {@inheritDoc}
137   */
138  public AttributeSyntaxCfgClient createClientConfiguration(
139      ManagedObject<? extends AttributeSyntaxCfgClient> impl) {
140    return new AttributeSyntaxCfgClientImpl(impl);
141  }
142
143
144
145  /**
146   * {@inheritDoc}
147   */
148  public AttributeSyntaxCfg createServerConfiguration(
149      ServerManagedObject<? extends AttributeSyntaxCfg> impl) {
150    return new AttributeSyntaxCfgServerImpl(impl);
151  }
152
153
154
155  /**
156   * {@inheritDoc}
157   */
158  public Class<AttributeSyntaxCfg> getServerConfigurationClass() {
159    return AttributeSyntaxCfg.class;
160  }
161
162
163
164  /**
165   * Get the "enabled" property definition.
166   * <p>
167   * Indicates whether the Attribute Syntax is enabled.
168   *
169   * @return Returns the "enabled" property definition.
170   */
171  public BooleanPropertyDefinition getEnabledPropertyDefinition() {
172    return PD_ENABLED;
173  }
174
175
176
177  /**
178   * Get the "java-class" property definition.
179   * <p>
180   * Specifies the fully-qualified name of the Java class that
181   * provides the Attribute Syntax implementation.
182   *
183   * @return Returns the "java-class" property definition.
184   */
185  public ClassPropertyDefinition getJavaClassPropertyDefinition() {
186    return PD_JAVA_CLASS;
187  }
188
189
190
191  /**
192   * Managed object client implementation.
193   */
194  private static class AttributeSyntaxCfgClientImpl implements
195    AttributeSyntaxCfgClient {
196
197    // Private implementation.
198    private ManagedObject<? extends AttributeSyntaxCfgClient> impl;
199
200
201
202    // Private constructor.
203    private AttributeSyntaxCfgClientImpl(
204        ManagedObject<? extends AttributeSyntaxCfgClient> impl) {
205      this.impl = impl;
206    }
207
208
209
210    /**
211     * {@inheritDoc}
212     */
213    public Boolean isEnabled() {
214      return impl.getPropertyValue(INSTANCE.getEnabledPropertyDefinition());
215    }
216
217
218
219    /**
220     * {@inheritDoc}
221     */
222    public void setEnabled(boolean value) {
223      impl.setPropertyValue(INSTANCE.getEnabledPropertyDefinition(), value);
224    }
225
226
227
228    /**
229     * {@inheritDoc}
230     */
231    public String getJavaClass() {
232      return impl.getPropertyValue(INSTANCE.getJavaClassPropertyDefinition());
233    }
234
235
236
237    /**
238     * {@inheritDoc}
239     */
240    public void setJavaClass(String value) throws PropertyException {
241      impl.setPropertyValue(INSTANCE.getJavaClassPropertyDefinition(), value);
242    }
243
244
245
246    /**
247     * {@inheritDoc}
248     */
249    public ManagedObjectDefinition<? extends AttributeSyntaxCfgClient, ? extends AttributeSyntaxCfg> definition() {
250      return INSTANCE;
251    }
252
253
254
255    /**
256     * {@inheritDoc}
257     */
258    public PropertyProvider properties() {
259      return impl;
260    }
261
262
263
264    /**
265     * {@inheritDoc}
266     */
267    public void commit() throws ManagedObjectAlreadyExistsException,
268        MissingMandatoryPropertiesException, ConcurrentModificationException,
269        OperationRejectedException, AuthorizationException,
270        CommunicationException {
271      impl.commit();
272    }
273
274  }
275
276
277
278  /**
279   * Managed object server implementation.
280   */
281  private static class AttributeSyntaxCfgServerImpl implements
282    AttributeSyntaxCfg {
283
284    // Private implementation.
285    private ServerManagedObject<? extends AttributeSyntaxCfg> impl;
286
287    // The value of the "enabled" property.
288    private final boolean pEnabled;
289
290    // The value of the "java-class" property.
291    private final String pJavaClass;
292
293
294
295    // Private constructor.
296    private AttributeSyntaxCfgServerImpl(ServerManagedObject<? extends AttributeSyntaxCfg> impl) {
297      this.impl = impl;
298      this.pEnabled = impl.getPropertyValue(INSTANCE.getEnabledPropertyDefinition());
299      this.pJavaClass = impl.getPropertyValue(INSTANCE.getJavaClassPropertyDefinition());
300    }
301
302
303
304    /**
305     * {@inheritDoc}
306     */
307    public void addChangeListener(
308        ConfigurationChangeListener<AttributeSyntaxCfg> listener) {
309      impl.registerChangeListener(listener);
310    }
311
312
313
314    /**
315     * {@inheritDoc}
316     */
317    public void removeChangeListener(
318        ConfigurationChangeListener<AttributeSyntaxCfg> listener) {
319      impl.deregisterChangeListener(listener);
320    }
321
322
323
324    /**
325     * {@inheritDoc}
326     */
327    public boolean isEnabled() {
328      return pEnabled;
329    }
330
331
332
333    /**
334     * {@inheritDoc}
335     */
336    public String getJavaClass() {
337      return pJavaClass;
338    }
339
340
341
342    /**
343     * {@inheritDoc}
344     */
345    public Class<? extends AttributeSyntaxCfg> configurationClass() {
346      return AttributeSyntaxCfg.class;
347    }
348
349
350
351    /**
352     * {@inheritDoc}
353     */
354    public DN dn() {
355      return impl.getDN();
356    }
357
358  }
359}