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 java.util.SortedSet; 021import org.forgerock.opendj.config.server.ConfigurationChangeListener; 022import org.forgerock.opendj.server.config.meta.ErrorLogAccountStatusNotificationHandlerCfgDefn.AccountStatusNotificationType; 023 024 025 026/** 027 * A server-side interface for querying Error Log Account Status 028 * Notification Handler settings. 029 * <p> 030 * The Error Log Account Status Notification Handler is a notification 031 * handler that writes information to the server error log whenever an 032 * appropriate account status event occurs. 033 */ 034public interface ErrorLogAccountStatusNotificationHandlerCfg extends AccountStatusNotificationHandlerCfg { 035 036 /** 037 * Gets the configuration class associated with this Error Log Account Status Notification Handler. 038 * 039 * @return Returns the configuration class associated with this Error Log Account Status Notification Handler. 040 */ 041 Class<? extends ErrorLogAccountStatusNotificationHandlerCfg> configurationClass(); 042 043 044 045 /** 046 * Register to be notified when this Error Log Account Status Notification Handler is changed. 047 * 048 * @param listener 049 * The Error Log Account Status Notification Handler configuration change listener. 050 */ 051 void addErrorLogChangeListener(ConfigurationChangeListener<ErrorLogAccountStatusNotificationHandlerCfg> listener); 052 053 054 055 /** 056 * Deregister an existing Error Log Account Status Notification Handler configuration change listener. 057 * 058 * @param listener 059 * The Error Log Account Status Notification Handler configuration change listener. 060 */ 061 void removeErrorLogChangeListener(ConfigurationChangeListener<ErrorLogAccountStatusNotificationHandlerCfg> listener); 062 063 064 065 /** 066 * Gets the "account-status-notification-type" property. 067 * <p> 068 * Indicates which types of event can trigger an account status 069 * notification. 070 * 071 * @return Returns an unmodifiable set containing the values of the "account-status-notification-type" property. 072 */ 073 SortedSet<AccountStatusNotificationType> getAccountStatusNotificationType(); 074 075 076 077 /** 078 * Gets the "java-class" property. 079 * <p> 080 * Specifies the fully-qualified name of the Java class that 081 * provides the Error Log Account Status Notification Handler 082 * implementation. 083 * 084 * @return Returns the value of the "java-class" property. 085 */ 086 String getJavaClass(); 087 088}