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.client;
028    
029    
030    
031    import java.util.Collection;
032    import java.util.SortedSet;
033    import org.opends.server.admin.IllegalPropertyValueException;
034    import org.opends.server.admin.ManagedObjectDefinition;
035    import org.opends.server.admin.std.meta.ErrorLogAccountStatusNotificationHandlerCfgDefn.AccountStatusNotificationType;
036    import org.opends.server.admin.std.server.ErrorLogAccountStatusNotificationHandlerCfg;
037    
038    
039    
040    /**
041     * A client-side interface for reading and modifying Error Log Account
042     * Status Notification Handler settings.
043     * <p>
044     * The Error Log Account Status Notification Handler is a notification
045     * handler that writes information to the server error log whenever an
046     * appropriate account status event occurs.
047     */
048    public interface ErrorLogAccountStatusNotificationHandlerCfgClient extends AccountStatusNotificationHandlerCfgClient {
049    
050      /**
051       * Get the configuration definition associated with this Error Log Account Status Notification Handler.
052       *
053       * @return Returns the configuration definition associated with this Error Log Account Status Notification Handler.
054       */
055      ManagedObjectDefinition<? extends ErrorLogAccountStatusNotificationHandlerCfgClient, ? extends ErrorLogAccountStatusNotificationHandlerCfg> definition();
056    
057    
058    
059      /**
060       * Gets the "account-status-notification-type" property.
061       * <p>
062       * Indicates which types of event can trigger an account status
063       * notification.
064       *
065       * @return Returns the values of the "account-status-notification-type" property.
066       */
067      SortedSet<AccountStatusNotificationType> getAccountStatusNotificationType();
068    
069    
070    
071      /**
072       * Sets the "account-status-notification-type" property.
073       * <p>
074       * Indicates which types of event can trigger an account status
075       * notification.
076       *
077       * @param values The values of the "account-status-notification-type" property.
078       * @throws IllegalPropertyValueException
079       *           If one or more of the new values are invalid.
080       */
081      void setAccountStatusNotificationType(Collection<AccountStatusNotificationType> values) throws IllegalPropertyValueException;
082    
083    
084    
085      /**
086       * Gets the "java-class" property.
087       * <p>
088       * Specifies the fully-qualified name of the Java class that
089       * provides the Error Log Account Status Notification Handler
090       * 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 Error Log Account Status Notification Handler
103       * implementation.
104       *
105       * @param value The value of the "java-class" property.
106       * @throws IllegalPropertyValueException
107       *           If the new value is invalid.
108       */
109      void setJavaClass(String value) throws IllegalPropertyValueException;
110    
111    }