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