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