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.StartTLSExtendedOperationHandlerCfgClient;
049import org.forgerock.opendj.server.config.server.ExtendedOperationHandlerCfg;
050import org.forgerock.opendj.server.config.server.StartTLSExtendedOperationHandlerCfg;
051
052
053
054/**
055 * An interface for querying the Start TLS Extended Operation Handler
056 * managed object definition meta information.
057 * <p>
058 * The Start TLS Extended Operation Handler provides the ability
059 * clients to use the StartTLS extended operation to initiate a secure
060 * communication channel over an otherwise clear-text LDAP connection.
061 */
062public final class StartTLSExtendedOperationHandlerCfgDefn extends ManagedObjectDefinition<StartTLSExtendedOperationHandlerCfgClient, StartTLSExtendedOperationHandlerCfg> {
063
064  /** The singleton configuration definition instance. */
065  private static final StartTLSExtendedOperationHandlerCfgDefn INSTANCE = new StartTLSExtendedOperationHandlerCfgDefn();
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.StartTLSExtendedOperation");
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 Start TLS Extended Operation Handler configuration
098   * definition singleton.
099   *
100   * @return Returns the Start TLS Extended Operation Handler
101   *         configuration definition singleton.
102   */
103  public static StartTLSExtendedOperationHandlerCfgDefn getInstance() {
104    return INSTANCE;
105  }
106
107
108
109  /**
110   * Private constructor.
111   */
112  private StartTLSExtendedOperationHandlerCfgDefn() {
113    super("start-tls-extended-operation-handler", ExtendedOperationHandlerCfgDefn.getInstance());
114  }
115
116
117
118  /** {@inheritDoc} */
119  public StartTLSExtendedOperationHandlerCfgClient createClientConfiguration(
120      ManagedObject<? extends StartTLSExtendedOperationHandlerCfgClient> impl) {
121    return new StartTLSExtendedOperationHandlerCfgClientImpl(impl);
122  }
123
124
125
126  /** {@inheritDoc} */
127  public StartTLSExtendedOperationHandlerCfg createServerConfiguration(
128      ServerManagedObject<? extends StartTLSExtendedOperationHandlerCfg> impl) {
129    return new StartTLSExtendedOperationHandlerCfgServerImpl(impl);
130  }
131
132
133
134  /** {@inheritDoc} */
135  public Class<StartTLSExtendedOperationHandlerCfg> getServerConfigurationClass() {
136    return StartTLSExtendedOperationHandlerCfg.class;
137  }
138
139
140
141  /**
142   * Get the "enabled" property definition.
143   * <p>
144   * Indicates whether the Start TLS Extended Operation Handler is
145   * enabled (that is, whether the types of extended operations are
146   * 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 Start TLS Extended Operation Handler implementation.
161   *
162   * @return Returns the "java-class" property definition.
163   */
164  public ClassPropertyDefinition getJavaClassPropertyDefinition() {
165    return PD_JAVA_CLASS;
166  }
167
168
169
170  /**
171   * Managed object client implementation.
172   */
173  private static class StartTLSExtendedOperationHandlerCfgClientImpl implements
174    StartTLSExtendedOperationHandlerCfgClient {
175
176    /** Private implementation. */
177    private ManagedObject<? extends StartTLSExtendedOperationHandlerCfgClient> impl;
178
179
180
181    /** Private constructor. */
182    private StartTLSExtendedOperationHandlerCfgClientImpl(
183        ManagedObject<? extends StartTLSExtendedOperationHandlerCfgClient> impl) {
184      this.impl = impl;
185    }
186
187
188
189    /** {@inheritDoc} */
190    public Boolean isEnabled() {
191      return impl.getPropertyValue(INSTANCE.getEnabledPropertyDefinition());
192    }
193
194
195
196    /** {@inheritDoc} */
197    public void setEnabled(boolean value) {
198      impl.setPropertyValue(INSTANCE.getEnabledPropertyDefinition(), value);
199    }
200
201
202
203    /** {@inheritDoc} */
204    public String getJavaClass() {
205      return impl.getPropertyValue(INSTANCE.getJavaClassPropertyDefinition());
206    }
207
208
209
210    /** {@inheritDoc} */
211    public void setJavaClass(String value) {
212      impl.setPropertyValue(INSTANCE.getJavaClassPropertyDefinition(), value);
213    }
214
215
216
217    /** {@inheritDoc} */
218    public ManagedObjectDefinition<? extends StartTLSExtendedOperationHandlerCfgClient, ? extends StartTLSExtendedOperationHandlerCfg> definition() {
219      return INSTANCE;
220    }
221
222
223
224    /** {@inheritDoc} */
225    public PropertyProvider properties() {
226      return impl;
227    }
228
229
230
231    /** {@inheritDoc} */
232    public void commit() throws ManagedObjectAlreadyExistsException,
233        MissingMandatoryPropertiesException, ConcurrentModificationException,
234        OperationRejectedException, LdapException {
235      impl.commit();
236    }
237
238
239
240    /** {@inheritDoc} */
241    public String toString() {
242      return impl.toString();
243    }
244  }
245
246
247
248  /**
249   * Managed object server implementation.
250   */
251  private static class StartTLSExtendedOperationHandlerCfgServerImpl implements
252    StartTLSExtendedOperationHandlerCfg {
253
254    /** Private implementation. */
255    private ServerManagedObject<? extends StartTLSExtendedOperationHandlerCfg> impl;
256
257    /** The value of the "enabled" property. */
258    private final boolean pEnabled;
259
260    /** The value of the "java-class" property. */
261    private final String pJavaClass;
262
263
264
265    /** Private constructor. */
266    private StartTLSExtendedOperationHandlerCfgServerImpl(ServerManagedObject<? extends StartTLSExtendedOperationHandlerCfg> impl) {
267      this.impl = impl;
268      this.pEnabled = impl.getPropertyValue(INSTANCE.getEnabledPropertyDefinition());
269      this.pJavaClass = impl.getPropertyValue(INSTANCE.getJavaClassPropertyDefinition());
270    }
271
272
273
274    /** {@inheritDoc} */
275    public void addStartTLSChangeListener(
276        ConfigurationChangeListener<StartTLSExtendedOperationHandlerCfg> listener) {
277      impl.registerChangeListener(listener);
278    }
279
280
281
282    /** {@inheritDoc} */
283    public void removeStartTLSChangeListener(
284        ConfigurationChangeListener<StartTLSExtendedOperationHandlerCfg> listener) {
285      impl.deregisterChangeListener(listener);
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 StartTLSExtendedOperationHandlerCfg> configurationClass() {
319      return StartTLSExtendedOperationHandlerCfg.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}