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