001/*
002 * The contents of this file are subject to the terms of the Common Development and
003 * Distribution License (the License). You may not use this file except in compliance with the
004 * License.
005 *
006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
007 * specific language governing permission and limitations under the License.
008 *
009 * When distributing Covered Software, include this CDDL Header Notice in each file and include
010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
011 * Header, with the fields enclosed by brackets [] replaced by your own identifying
012 * information: "Portions Copyright [year] [name of copyright owner]".
013 *
014 * Copyright 2008 Sun Microsystems, Inc.
015 */
016package org.forgerock.opendj.server.config.client;
017
018
019
020import java.util.Collection;
021import java.util.SortedSet;
022import org.forgerock.opendj.config.ManagedObjectDefinition;
023import org.forgerock.opendj.config.PropertyException;
024import org.forgerock.opendj.server.config.meta.ErrorLogAccountStatusNotificationHandlerCfgDefn.AccountStatusNotificationType;
025import org.forgerock.opendj.server.config.server.ErrorLogAccountStatusNotificationHandlerCfg;
026
027
028
029/**
030 * A client-side interface for reading and modifying Error Log Account
031 * Status Notification Handler settings.
032 * <p>
033 * The Error Log Account Status Notification Handler is a notification
034 * handler that writes information to the server error log whenever an
035 * appropriate account status event occurs.
036 */
037public interface ErrorLogAccountStatusNotificationHandlerCfgClient extends AccountStatusNotificationHandlerCfgClient {
038
039  /**
040   * Get the configuration definition associated with this Error Log Account Status Notification Handler.
041   *
042   * @return Returns the configuration definition associated with this Error Log Account Status Notification Handler.
043   */
044  ManagedObjectDefinition<? extends ErrorLogAccountStatusNotificationHandlerCfgClient, ? extends ErrorLogAccountStatusNotificationHandlerCfg> definition();
045
046
047
048  /**
049   * Gets the "account-status-notification-type" property.
050   * <p>
051   * Indicates which types of event can trigger an account status
052   * notification.
053   *
054   * @return Returns the values of the "account-status-notification-type" property.
055   */
056  SortedSet<AccountStatusNotificationType> getAccountStatusNotificationType();
057
058
059
060  /**
061   * Sets the "account-status-notification-type" property.
062   * <p>
063   * Indicates which types of event can trigger an account status
064   * notification.
065   *
066   * @param values The values of the "account-status-notification-type" property.
067   * @throws PropertyException
068   *           If one or more of the new values are invalid.
069   */
070  void setAccountStatusNotificationType(Collection<AccountStatusNotificationType> values) throws PropertyException;
071
072
073
074  /**
075   * Gets the "java-class" property.
076   * <p>
077   * Specifies the fully-qualified name of the Java class that
078   * provides the Error Log Account Status Notification Handler
079   * implementation.
080   *
081   * @return Returns the value of the "java-class" property.
082   */
083  String getJavaClass();
084
085
086
087  /**
088   * Sets the "java-class" property.
089   * <p>
090   * Specifies the fully-qualified name of the Java class that
091   * provides the Error Log Account Status Notification Handler
092   * implementation.
093   *
094   * @param value The value of the "java-class" property.
095   * @throws PropertyException
096   *           If the new value is invalid.
097   */
098  void setJavaClass(String value) throws PropertyException;
099
100}