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.ManagedObjectAlreadyExistsException;
038import org.forgerock.opendj.config.ManagedObjectDefinition;
039import org.forgerock.opendj.config.PropertyOption;
040import org.forgerock.opendj.config.PropertyProvider;
041import org.forgerock.opendj.config.server.ConfigurationChangeListener;
042import org.forgerock.opendj.config.server.ServerManagedObject;
043import org.forgerock.opendj.config.Tag;
044import org.forgerock.opendj.config.TopCfgDefn;
045import org.forgerock.opendj.config.UndefinedDefaultBehaviorProvider;
046import org.forgerock.opendj.ldap.DN;
047import org.forgerock.opendj.ldap.LdapException;
048import org.forgerock.opendj.server.config.client.AccountStatusNotificationHandlerCfgClient;
049import org.forgerock.opendj.server.config.server.AccountStatusNotificationHandlerCfg;
050
051
052
053/**
054 * An interface for querying the Account Status Notification Handler
055 * managed object definition meta information.
056 * <p>
057 * Account Status Notification Handlers are invoked to provide
058 * notification to users in some form (for example, by an email
059 * message) when the status of a user's account has changed in some
060 * way. The Account Status Notification Handler can be used to notify
061 * the user and/or administrators of the change.
062 */
063public final class AccountStatusNotificationHandlerCfgDefn extends ManagedObjectDefinition<AccountStatusNotificationHandlerCfgClient, AccountStatusNotificationHandlerCfg> {
064
065  /** The singleton configuration definition instance. */
066  private static final AccountStatusNotificationHandlerCfgDefn INSTANCE = new AccountStatusNotificationHandlerCfgDefn();
067
068
069
070  /** The "enabled" property definition. */
071  private static final BooleanPropertyDefinition PD_ENABLED;
072
073
074
075  /** The "java-class" property definition. */
076  private static final ClassPropertyDefinition PD_JAVA_CLASS;
077
078
079
080  /** Build the "enabled" property definition. */
081  static {
082      BooleanPropertyDefinition.Builder builder = BooleanPropertyDefinition.createBuilder(INSTANCE, "enabled");
083      builder.setOption(PropertyOption.MANDATORY);
084      builder.setAdministratorAction(new AdministratorAction(AdministratorAction.Type.NONE, INSTANCE, "enabled"));
085      builder.setDefaultBehaviorProvider(new UndefinedDefaultBehaviorProvider<Boolean>());
086      PD_ENABLED = builder.getInstance();
087      INSTANCE.registerPropertyDefinition(PD_ENABLED);
088  }
089
090
091
092  /** Build the "java-class" property definition. */
093  static {
094      ClassPropertyDefinition.Builder builder = ClassPropertyDefinition.createBuilder(INSTANCE, "java-class");
095      builder.setOption(PropertyOption.MANDATORY);
096      builder.setAdministratorAction(new AdministratorAction(AdministratorAction.Type.COMPONENT_RESTART, INSTANCE, "java-class"));
097      builder.setDefaultBehaviorProvider(new UndefinedDefaultBehaviorProvider<String>());
098      builder.addInstanceOf("org.opends.server.api.AccountStatusNotificationHandler");
099      PD_JAVA_CLASS = builder.getInstance();
100      INSTANCE.registerPropertyDefinition(PD_JAVA_CLASS);
101  }
102
103
104
105  // Register the tags associated with this managed object definition.
106  static {
107    INSTANCE.registerTag(Tag.valueOf("user-management"));
108  }
109
110
111
112  /**
113   * Get the Account Status Notification Handler configuration
114   * definition singleton.
115   *
116   * @return Returns the Account Status Notification Handler
117   *         configuration definition singleton.
118   */
119  public static AccountStatusNotificationHandlerCfgDefn getInstance() {
120    return INSTANCE;
121  }
122
123
124
125  /**
126   * Private constructor.
127   */
128  private AccountStatusNotificationHandlerCfgDefn() {
129    super("account-status-notification-handler", TopCfgDefn.getInstance());
130  }
131
132
133
134  /** {@inheritDoc} */
135  public AccountStatusNotificationHandlerCfgClient createClientConfiguration(
136      ManagedObject<? extends AccountStatusNotificationHandlerCfgClient> impl) {
137    return new AccountStatusNotificationHandlerCfgClientImpl(impl);
138  }
139
140
141
142  /** {@inheritDoc} */
143  public AccountStatusNotificationHandlerCfg createServerConfiguration(
144      ServerManagedObject<? extends AccountStatusNotificationHandlerCfg> impl) {
145    return new AccountStatusNotificationHandlerCfgServerImpl(impl);
146  }
147
148
149
150  /** {@inheritDoc} */
151  public Class<AccountStatusNotificationHandlerCfg> getServerConfigurationClass() {
152    return AccountStatusNotificationHandlerCfg.class;
153  }
154
155
156
157  /**
158   * Get the "enabled" property definition.
159   * <p>
160   * Indicates whether the Account Status Notification Handler is
161   * enabled. Only enabled handlers are invoked whenever a related
162   * event occurs in the server.
163   *
164   * @return Returns the "enabled" property definition.
165   */
166  public BooleanPropertyDefinition getEnabledPropertyDefinition() {
167    return PD_ENABLED;
168  }
169
170
171
172  /**
173   * Get the "java-class" property definition.
174   * <p>
175   * Specifies the fully-qualified name of the Java class that
176   * provides the Account Status Notification Handler implementation.
177   *
178   * @return Returns the "java-class" property definition.
179   */
180  public ClassPropertyDefinition getJavaClassPropertyDefinition() {
181    return PD_JAVA_CLASS;
182  }
183
184
185
186  /**
187   * Managed object client implementation.
188   */
189  private static class AccountStatusNotificationHandlerCfgClientImpl implements
190    AccountStatusNotificationHandlerCfgClient {
191
192    /** Private implementation. */
193    private ManagedObject<? extends AccountStatusNotificationHandlerCfgClient> impl;
194
195
196
197    /** Private constructor. */
198    private AccountStatusNotificationHandlerCfgClientImpl(
199        ManagedObject<? extends AccountStatusNotificationHandlerCfgClient> impl) {
200      this.impl = impl;
201    }
202
203
204
205    /** {@inheritDoc} */
206    public Boolean isEnabled() {
207      return impl.getPropertyValue(INSTANCE.getEnabledPropertyDefinition());
208    }
209
210
211
212    /** {@inheritDoc} */
213    public void setEnabled(boolean value) {
214      impl.setPropertyValue(INSTANCE.getEnabledPropertyDefinition(), value);
215    }
216
217
218
219    /** {@inheritDoc} */
220    public String getJavaClass() {
221      return impl.getPropertyValue(INSTANCE.getJavaClassPropertyDefinition());
222    }
223
224
225
226    /** {@inheritDoc} */
227    public void setJavaClass(String value) {
228      impl.setPropertyValue(INSTANCE.getJavaClassPropertyDefinition(), value);
229    }
230
231
232
233    /** {@inheritDoc} */
234    public ManagedObjectDefinition<? extends AccountStatusNotificationHandlerCfgClient, ? extends AccountStatusNotificationHandlerCfg> definition() {
235      return INSTANCE;
236    }
237
238
239
240    /** {@inheritDoc} */
241    public PropertyProvider properties() {
242      return impl;
243    }
244
245
246
247    /** {@inheritDoc} */
248    public void commit() throws ManagedObjectAlreadyExistsException,
249        MissingMandatoryPropertiesException, ConcurrentModificationException,
250        OperationRejectedException, LdapException {
251      impl.commit();
252    }
253
254
255
256    /** {@inheritDoc} */
257    public String toString() {
258      return impl.toString();
259    }
260  }
261
262
263
264  /**
265   * Managed object server implementation.
266   */
267  private static class AccountStatusNotificationHandlerCfgServerImpl implements
268    AccountStatusNotificationHandlerCfg {
269
270    /** Private implementation. */
271    private ServerManagedObject<? extends AccountStatusNotificationHandlerCfg> impl;
272
273    /** The value of the "enabled" property. */
274    private final boolean pEnabled;
275
276    /** The value of the "java-class" property. */
277    private final String pJavaClass;
278
279
280
281    /** Private constructor. */
282    private AccountStatusNotificationHandlerCfgServerImpl(ServerManagedObject<? extends AccountStatusNotificationHandlerCfg> impl) {
283      this.impl = impl;
284      this.pEnabled = impl.getPropertyValue(INSTANCE.getEnabledPropertyDefinition());
285      this.pJavaClass = impl.getPropertyValue(INSTANCE.getJavaClassPropertyDefinition());
286    }
287
288
289
290    /** {@inheritDoc} */
291    public void addChangeListener(
292        ConfigurationChangeListener<AccountStatusNotificationHandlerCfg> listener) {
293      impl.registerChangeListener(listener);
294    }
295
296
297
298    /** {@inheritDoc} */
299    public void removeChangeListener(
300        ConfigurationChangeListener<AccountStatusNotificationHandlerCfg> listener) {
301      impl.deregisterChangeListener(listener);
302    }
303
304
305
306    /** {@inheritDoc} */
307    public boolean isEnabled() {
308      return pEnabled;
309    }
310
311
312
313    /** {@inheritDoc} */
314    public String getJavaClass() {
315      return pJavaClass;
316    }
317
318
319
320    /** {@inheritDoc} */
321    public Class<? extends AccountStatusNotificationHandlerCfg> configurationClass() {
322      return AccountStatusNotificationHandlerCfg.class;
323    }
324
325
326
327    /** {@inheritDoc} */
328    public DN dn() {
329      return impl.getDN();
330    }
331
332
333
334    /** {@inheritDoc} */
335    public String toString() {
336      return impl.toString();
337    }
338  }
339}