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
010     * trunk/opends/resource/legal-notices/OpenDS.LICENSE
011     * or https://OpenDS.dev.java.net/OpenDS.LICENSE.
012     * See the License for the specific language governing permissions
013     * and limitations under the License.
014     *
015     * When distributing Covered Code, include this CDDL HEADER in each
016     * file and include the License file at
017     * trunk/opends/resource/legal-notices/OpenDS.LICENSE.  If applicable,
018     * add the following below this CDDL HEADER, with the fields enclosed
019     * by brackets "[]" replaced with your own identifying information:
020     *      Portions Copyright [yyyy] [name of copyright owner]
021     *
022     * CDDL HEADER END
023     *
024     *
025     *      Copyright 2008 Sun Microsystems, Inc.
026     */
027    package org.opends.server.admin.std.server;
028    
029    
030    
031    import org.opends.server.admin.Configuration;
032    import org.opends.server.admin.server.ConfigurationChangeListener;
033    
034    
035    
036    /**
037     * A server-side interface for querying Account Status Notification
038     * Handler settings.
039     * <p>
040     * Account Status Notification Handlers are invoked to provide
041     * notification to users in some form (for example, by an email
042     * message) when the status of a user's account has changed in some
043     * way. The Account Status Notification Handler can be used to notify
044     * the user and/or administrators of the change.
045     */
046    public interface AccountStatusNotificationHandlerCfg extends Configuration {
047    
048      /**
049       * Gets the configuration class associated with this Account Status Notification Handler.
050       *
051       * @return Returns the configuration class associated with this Account Status Notification Handler.
052       */
053      Class<? extends AccountStatusNotificationHandlerCfg> configurationClass();
054    
055    
056    
057      /**
058       * Register to be notified when this Account Status Notification Handler is changed.
059       *
060       * @param listener
061       *          The Account Status Notification Handler configuration change listener.
062       */
063      void addChangeListener(ConfigurationChangeListener<AccountStatusNotificationHandlerCfg> listener);
064    
065    
066    
067      /**
068       * Deregister an existing Account Status Notification Handler configuration change listener.
069       *
070       * @param listener
071       *          The Account Status Notification Handler configuration change listener.
072       */
073      void removeChangeListener(ConfigurationChangeListener<AccountStatusNotificationHandlerCfg> listener);
074    
075    
076    
077      /**
078       * Gets the "enabled" property.
079       * <p>
080       * Indicates whether the Account Status Notification Handler is
081       * enabled. Only enabled handlers are invoked whenever a related
082       * event occurs in the server.
083       *
084       * @return Returns the value of the "enabled" property.
085       */
086      boolean isEnabled();
087    
088    
089    
090      /**
091       * Gets the "java-class" property.
092       * <p>
093       * Specifies the fully-qualified name of the Java class that
094       * provides the Account Status Notification Handler implementation.
095       *
096       * @return Returns the value of the "java-class" property.
097       */
098      String getJavaClass();
099    
100    }