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.GetSymmetricKeyExtendedOperationHandlerCfgClient;
049import org.forgerock.opendj.server.config.server.ExtendedOperationHandlerCfg;
050import org.forgerock.opendj.server.config.server.GetSymmetricKeyExtendedOperationHandlerCfg;
051
052
053
054/**
055 * An interface for querying the Get Symmetric Key Extended Operation
056 * Handler managed object definition meta information.
057 * <p>
058 * The Get Symmetric Key Extended Operation Handler is used by the
059 * OpenDJ cryptographic framework for creating and obtaining symmetric
060 * encryption keys.
061 */
062public final class GetSymmetricKeyExtendedOperationHandlerCfgDefn extends ManagedObjectDefinition<GetSymmetricKeyExtendedOperationHandlerCfgClient, GetSymmetricKeyExtendedOperationHandlerCfg> {
063
064  // The singleton configuration definition instance.
065  private static final GetSymmetricKeyExtendedOperationHandlerCfgDefn INSTANCE = new GetSymmetricKeyExtendedOperationHandlerCfgDefn();
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.crypto.GetSymmetricKeyExtendedOperation");
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 Symmetric Key Extended Operation Handler
098   * configuration definition singleton.
099   *
100   * @return Returns the Get Symmetric Key Extended Operation Handler
101   *         configuration definition singleton.
102   */
103  public static GetSymmetricKeyExtendedOperationHandlerCfgDefn getInstance() {
104    return INSTANCE;
105  }
106
107
108
109  /**
110   * Private constructor.
111   */
112  private GetSymmetricKeyExtendedOperationHandlerCfgDefn() {
113    super("get-symmetric-key-extended-operation-handler", ExtendedOperationHandlerCfgDefn.getInstance());
114  }
115
116
117
118  /**
119   * {@inheritDoc}
120   */
121  public GetSymmetricKeyExtendedOperationHandlerCfgClient createClientConfiguration(
122      ManagedObject<? extends GetSymmetricKeyExtendedOperationHandlerCfgClient> impl) {
123    return new GetSymmetricKeyExtendedOperationHandlerCfgClientImpl(impl);
124  }
125
126
127
128  /**
129   * {@inheritDoc}
130   */
131  public GetSymmetricKeyExtendedOperationHandlerCfg createServerConfiguration(
132      ServerManagedObject<? extends GetSymmetricKeyExtendedOperationHandlerCfg> impl) {
133    return new GetSymmetricKeyExtendedOperationHandlerCfgServerImpl(impl);
134  }
135
136
137
138  /**
139   * {@inheritDoc}
140   */
141  public Class<GetSymmetricKeyExtendedOperationHandlerCfg> getServerConfigurationClass() {
142    return GetSymmetricKeyExtendedOperationHandlerCfg.class;
143  }
144
145
146
147  /**
148   * Get the "enabled" property definition.
149   * <p>
150   * Indicates whether the Get Symmetric Key Extended Operation
151   * Handler is enabled (that is, whether the types of extended
152   * operations are 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 Get Symmetric Key Extended Operation Handler
167   * implementation.
168   *
169   * @return Returns the "java-class" property definition.
170   */
171  public ClassPropertyDefinition getJavaClassPropertyDefinition() {
172    return PD_JAVA_CLASS;
173  }
174
175
176
177  /**
178   * Managed object client implementation.
179   */
180  private static class GetSymmetricKeyExtendedOperationHandlerCfgClientImpl implements
181    GetSymmetricKeyExtendedOperationHandlerCfgClient {
182
183    // Private implementation.
184    private ManagedObject<? extends GetSymmetricKeyExtendedOperationHandlerCfgClient> impl;
185
186
187
188    // Private constructor.
189    private GetSymmetricKeyExtendedOperationHandlerCfgClientImpl(
190        ManagedObject<? extends GetSymmetricKeyExtendedOperationHandlerCfgClient> impl) {
191      this.impl = impl;
192    }
193
194
195
196    /**
197     * {@inheritDoc}
198     */
199    public Boolean isEnabled() {
200      return impl.getPropertyValue(INSTANCE.getEnabledPropertyDefinition());
201    }
202
203
204
205    /**
206     * {@inheritDoc}
207     */
208    public void setEnabled(boolean value) {
209      impl.setPropertyValue(INSTANCE.getEnabledPropertyDefinition(), value);
210    }
211
212
213
214    /**
215     * {@inheritDoc}
216     */
217    public String getJavaClass() {
218      return impl.getPropertyValue(INSTANCE.getJavaClassPropertyDefinition());
219    }
220
221
222
223    /**
224     * {@inheritDoc}
225     */
226    public void setJavaClass(String value) {
227      impl.setPropertyValue(INSTANCE.getJavaClassPropertyDefinition(), value);
228    }
229
230
231
232    /**
233     * {@inheritDoc}
234     */
235    public ManagedObjectDefinition<? extends GetSymmetricKeyExtendedOperationHandlerCfgClient, ? extends GetSymmetricKeyExtendedOperationHandlerCfg> definition() {
236      return INSTANCE;
237    }
238
239
240
241    /**
242     * {@inheritDoc}
243     */
244    public PropertyProvider properties() {
245      return impl;
246    }
247
248
249
250    /**
251     * {@inheritDoc}
252     */
253    public void commit() throws ManagedObjectAlreadyExistsException,
254        MissingMandatoryPropertiesException, ConcurrentModificationException,
255        OperationRejectedException, LdapException {
256      impl.commit();
257    }
258
259  }
260
261
262
263  /**
264   * Managed object server implementation.
265   */
266  private static class GetSymmetricKeyExtendedOperationHandlerCfgServerImpl implements
267    GetSymmetricKeyExtendedOperationHandlerCfg {
268
269    // Private implementation.
270    private ServerManagedObject<? extends GetSymmetricKeyExtendedOperationHandlerCfg> 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 GetSymmetricKeyExtendedOperationHandlerCfgServerImpl(ServerManagedObject<? extends GetSymmetricKeyExtendedOperationHandlerCfg> 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 addGetSymmetricKeyChangeListener(
293        ConfigurationChangeListener<GetSymmetricKeyExtendedOperationHandlerCfg> listener) {
294      impl.registerChangeListener(listener);
295    }
296
297
298
299    /**
300     * {@inheritDoc}
301     */
302    public void removeGetSymmetricKeyChangeListener(
303        ConfigurationChangeListener<GetSymmetricKeyExtendedOperationHandlerCfg> 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 GetSymmetricKeyExtendedOperationHandlerCfg> configurationClass() {
348      return GetSymmetricKeyExtendedOperationHandlerCfg.class;
349    }
350
351
352
353    /**
354     * {@inheritDoc}
355     */
356    public DN dn() {
357      return impl.getDN();
358    }
359
360  }
361}