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