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