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