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.GetConnectionIdExtendedOperationHandlerCfgClient;
049import org.forgerock.opendj.server.config.server.ExtendedOperationHandlerCfg;
050import org.forgerock.opendj.server.config.server.GetConnectionIdExtendedOperationHandlerCfg;
051
052
053
054/**
055 * An interface for querying the Get Connection Id Extended Operation
056 * Handler managed object definition meta information.
057 * <p>
058 * The Get Connection Id Extended Operation Handler provides a
059 * mechanism for clients to obtain the internal connection ID that the
060 * server uses to reference their client connection.
061 */
062public final class GetConnectionIdExtendedOperationHandlerCfgDefn extends ManagedObjectDefinition<GetConnectionIdExtendedOperationHandlerCfgClient, GetConnectionIdExtendedOperationHandlerCfg> {
063
064  /** The singleton configuration definition instance. */
065  private static final GetConnectionIdExtendedOperationHandlerCfgDefn INSTANCE = new GetConnectionIdExtendedOperationHandlerCfgDefn();
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.GetConnectionIDExtendedOperation");
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 Get Connection Id Extended Operation Handler
098   * configuration definition singleton.
099   *
100   * @return Returns the Get Connection Id Extended Operation Handler
101   *         configuration definition singleton.
102   */
103  public static GetConnectionIdExtendedOperationHandlerCfgDefn getInstance() {
104    return INSTANCE;
105  }
106
107
108
109  /**
110   * Private constructor.
111   */
112  private GetConnectionIdExtendedOperationHandlerCfgDefn() {
113    super("get-connection-id-extended-operation-handler", ExtendedOperationHandlerCfgDefn.getInstance());
114  }
115
116
117
118  /** {@inheritDoc} */
119  public GetConnectionIdExtendedOperationHandlerCfgClient createClientConfiguration(
120      ManagedObject<? extends GetConnectionIdExtendedOperationHandlerCfgClient> impl) {
121    return new GetConnectionIdExtendedOperationHandlerCfgClientImpl(impl);
122  }
123
124
125
126  /** {@inheritDoc} */
127  public GetConnectionIdExtendedOperationHandlerCfg createServerConfiguration(
128      ServerManagedObject<? extends GetConnectionIdExtendedOperationHandlerCfg> impl) {
129    return new GetConnectionIdExtendedOperationHandlerCfgServerImpl(impl);
130  }
131
132
133
134  /** {@inheritDoc} */
135  public Class<GetConnectionIdExtendedOperationHandlerCfg> getServerConfigurationClass() {
136    return GetConnectionIdExtendedOperationHandlerCfg.class;
137  }
138
139
140
141  /**
142   * Get the "enabled" property definition.
143   * <p>
144   * Indicates whether the Get Connection Id Extended Operation
145   * Handler is enabled (that is, whether the types of extended
146   * operations are allowed in the server).
147   *
148   * @return Returns the "enabled" property definition.
149   */
150  public BooleanPropertyDefinition getEnabledPropertyDefinition() {
151    return ExtendedOperationHandlerCfgDefn.getInstance().getEnabledPropertyDefinition();
152  }
153
154
155
156  /**
157   * Get the "java-class" property definition.
158   * <p>
159   * Specifies the fully-qualified name of the Java class that
160   * provides the Get Connection Id Extended Operation Handler
161   * implementation.
162   *
163   * @return Returns the "java-class" property definition.
164   */
165  public ClassPropertyDefinition getJavaClassPropertyDefinition() {
166    return PD_JAVA_CLASS;
167  }
168
169
170
171  /**
172   * Managed object client implementation.
173   */
174  private static class GetConnectionIdExtendedOperationHandlerCfgClientImpl implements
175    GetConnectionIdExtendedOperationHandlerCfgClient {
176
177    /** Private implementation. */
178    private ManagedObject<? extends GetConnectionIdExtendedOperationHandlerCfgClient> impl;
179
180
181
182    /** Private constructor. */
183    private GetConnectionIdExtendedOperationHandlerCfgClientImpl(
184        ManagedObject<? extends GetConnectionIdExtendedOperationHandlerCfgClient> impl) {
185      this.impl = impl;
186    }
187
188
189
190    /** {@inheritDoc} */
191    public Boolean isEnabled() {
192      return impl.getPropertyValue(INSTANCE.getEnabledPropertyDefinition());
193    }
194
195
196
197    /** {@inheritDoc} */
198    public void setEnabled(boolean value) {
199      impl.setPropertyValue(INSTANCE.getEnabledPropertyDefinition(), value);
200    }
201
202
203
204    /** {@inheritDoc} */
205    public String getJavaClass() {
206      return impl.getPropertyValue(INSTANCE.getJavaClassPropertyDefinition());
207    }
208
209
210
211    /** {@inheritDoc} */
212    public void setJavaClass(String value) {
213      impl.setPropertyValue(INSTANCE.getJavaClassPropertyDefinition(), value);
214    }
215
216
217
218    /** {@inheritDoc} */
219    public ManagedObjectDefinition<? extends GetConnectionIdExtendedOperationHandlerCfgClient, ? extends GetConnectionIdExtendedOperationHandlerCfg> definition() {
220      return INSTANCE;
221    }
222
223
224
225    /** {@inheritDoc} */
226    public PropertyProvider properties() {
227      return impl;
228    }
229
230
231
232    /** {@inheritDoc} */
233    public void commit() throws ManagedObjectAlreadyExistsException,
234        MissingMandatoryPropertiesException, ConcurrentModificationException,
235        OperationRejectedException, LdapException {
236      impl.commit();
237    }
238
239
240
241    /** {@inheritDoc} */
242    public String toString() {
243      return impl.toString();
244    }
245  }
246
247
248
249  /**
250   * Managed object server implementation.
251   */
252  private static class GetConnectionIdExtendedOperationHandlerCfgServerImpl implements
253    GetConnectionIdExtendedOperationHandlerCfg {
254
255    /** Private implementation. */
256    private ServerManagedObject<? extends GetConnectionIdExtendedOperationHandlerCfg> impl;
257
258    /** The value of the "enabled" property. */
259    private final boolean pEnabled;
260
261    /** The value of the "java-class" property. */
262    private final String pJavaClass;
263
264
265
266    /** Private constructor. */
267    private GetConnectionIdExtendedOperationHandlerCfgServerImpl(ServerManagedObject<? extends GetConnectionIdExtendedOperationHandlerCfg> impl) {
268      this.impl = impl;
269      this.pEnabled = impl.getPropertyValue(INSTANCE.getEnabledPropertyDefinition());
270      this.pJavaClass = impl.getPropertyValue(INSTANCE.getJavaClassPropertyDefinition());
271    }
272
273
274
275    /** {@inheritDoc} */
276    public void addGetConnectionIdChangeListener(
277        ConfigurationChangeListener<GetConnectionIdExtendedOperationHandlerCfg> listener) {
278      impl.registerChangeListener(listener);
279    }
280
281
282
283    /** {@inheritDoc} */
284    public void removeGetConnectionIdChangeListener(
285        ConfigurationChangeListener<GetConnectionIdExtendedOperationHandlerCfg> listener) {
286      impl.deregisterChangeListener(listener);
287    }
288    /** {@inheritDoc} */
289    public void addChangeListener(
290        ConfigurationChangeListener<ExtendedOperationHandlerCfg> listener) {
291      impl.registerChangeListener(listener);
292    }
293
294
295
296    /** {@inheritDoc} */
297    public void removeChangeListener(
298        ConfigurationChangeListener<ExtendedOperationHandlerCfg> listener) {
299      impl.deregisterChangeListener(listener);
300    }
301
302
303
304    /** {@inheritDoc} */
305    public boolean isEnabled() {
306      return pEnabled;
307    }
308
309
310
311    /** {@inheritDoc} */
312    public String getJavaClass() {
313      return pJavaClass;
314    }
315
316
317
318    /** {@inheritDoc} */
319    public Class<? extends GetConnectionIdExtendedOperationHandlerCfg> configurationClass() {
320      return GetConnectionIdExtendedOperationHandlerCfg.class;
321    }
322
323
324
325    /** {@inheritDoc} */
326    public DN dn() {
327      return impl.getDN();
328    }
329
330
331
332    /** {@inheritDoc} */
333    public String toString() {
334      return impl.toString();
335    }
336  }
337}