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