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.client;
027
028
029
030import org.opends.server.admin.ConfigurationClient;
031import org.opends.server.admin.ManagedObjectDefinition;
032import org.opends.server.admin.PropertyException;
033import org.opends.server.admin.std.server.AccountStatusNotificationHandlerCfg;
034
035
036
037/**
038 * A client-side interface for reading and modifying Account Status
039 * Notification Handler settings.
040 * <p>
041 * Account Status Notification Handlers are invoked to provide
042 * notification to users in some form (for example, by an email
043 * message) when the status of a user's account has changed in some
044 * way. The Account Status Notification Handler can be used to notify
045 * the user and/or administrators of the change.
046 */
047public interface AccountStatusNotificationHandlerCfgClient extends ConfigurationClient {
048
049  /**
050   * Get the configuration definition associated with this Account Status Notification Handler.
051   *
052   * @return Returns the configuration definition associated with this Account Status Notification Handler.
053   */
054  ManagedObjectDefinition<? extends AccountStatusNotificationHandlerCfgClient, ? extends AccountStatusNotificationHandlerCfg> definition();
055
056
057
058  /**
059   * Gets the "enabled" property.
060   * <p>
061   * Indicates whether the Account Status Notification Handler is
062   * enabled. Only enabled handlers are invoked whenever a related
063   * event occurs in the server.
064   *
065   * @return Returns the value of the "enabled" property.
066   */
067  Boolean isEnabled();
068
069
070
071  /**
072   * Sets the "enabled" property.
073   * <p>
074   * Indicates whether the Account Status Notification Handler is
075   * enabled. Only enabled handlers are invoked whenever a related
076   * event occurs in the server.
077   *
078   * @param value The value of the "enabled" property.
079   * @throws PropertyException
080   *           If the new value is invalid.
081   */
082  void setEnabled(boolean value) throws PropertyException;
083
084
085
086  /**
087   * Gets the "java-class" property.
088   * <p>
089   * Specifies the fully-qualified name of the Java class that
090   * provides the Account Status Notification Handler implementation.
091   *
092   * @return Returns the value of the "java-class" property.
093   */
094  String getJavaClass();
095
096
097
098  /**
099   * Sets the "java-class" property.
100   * <p>
101   * Specifies the fully-qualified name of the Java class that
102   * provides the Account Status Notification Handler implementation.
103   *
104   * @param value The value of the "java-class" property.
105   * @throws PropertyException
106   *           If the new value is invalid.
107   */
108  void setJavaClass(String value) throws PropertyException;
109
110}