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 010 * trunk/opends/resource/legal-notices/OpenDS.LICENSE 011 * or https://OpenDS.dev.java.net/OpenDS.LICENSE. 012 * See the License for the specific language governing permissions 013 * and limitations under the License. 014 * 015 * When distributing Covered Code, include this CDDL HEADER in each 016 * file and include the License file at 017 * trunk/opends/resource/legal-notices/OpenDS.LICENSE. If applicable, 018 * add the following below this CDDL HEADER, with the fields enclosed 019 * by brackets "[]" replaced with your own identifying information: 020 * Portions Copyright [yyyy] [name of copyright owner] 021 * 022 * CDDL HEADER END 023 * 024 * 025 * Copyright 2008 Sun Microsystems, Inc. 026 */ 027 package org.opends.server.admin.std.server; 028 029 030 031 import java.util.SortedSet; 032 import org.opends.server.admin.server.ConfigurationChangeListener; 033 import org.opends.server.admin.std.meta.ErrorLogAccountStatusNotificationHandlerCfgDefn.AccountStatusNotificationType; 034 035 036 037 /** 038 * A server-side interface for querying Error Log Account Status 039 * Notification Handler settings. 040 * <p> 041 * The Error Log Account Status Notification Handler is a notification 042 * handler that writes information to the server error log whenever an 043 * appropriate account status event occurs. 044 */ 045 public interface ErrorLogAccountStatusNotificationHandlerCfg extends AccountStatusNotificationHandlerCfg { 046 047 /** 048 * Gets the configuration class associated with this Error Log Account Status Notification Handler. 049 * 050 * @return Returns the configuration class associated with this Error Log Account Status Notification Handler. 051 */ 052 Class<? extends ErrorLogAccountStatusNotificationHandlerCfg> configurationClass(); 053 054 055 056 /** 057 * Register to be notified when this Error Log Account Status Notification Handler is changed. 058 * 059 * @param listener 060 * The Error Log Account Status Notification Handler configuration change listener. 061 */ 062 void addErrorLogChangeListener(ConfigurationChangeListener<ErrorLogAccountStatusNotificationHandlerCfg> listener); 063 064 065 066 /** 067 * Deregister an existing Error Log Account Status Notification Handler configuration change listener. 068 * 069 * @param listener 070 * The Error Log Account Status Notification Handler configuration change listener. 071 */ 072 void removeErrorLogChangeListener(ConfigurationChangeListener<ErrorLogAccountStatusNotificationHandlerCfg> listener); 073 074 075 076 /** 077 * Gets the "account-status-notification-type" property. 078 * <p> 079 * Indicates which types of event can trigger an account status 080 * notification. 081 * 082 * @return Returns an unmodifiable set containing the values of the "account-status-notification-type" property. 083 */ 084 SortedSet<AccountStatusNotificationType> getAccountStatusNotificationType(); 085 086 087 088 /** 089 * Gets the "java-class" property. 090 * <p> 091 * Specifies the fully-qualified name of the Java class that 092 * provides the Error Log Account Status Notification Handler 093 * implementation. 094 * 095 * @return Returns the value of the "java-class" property. 096 */ 097 String getJavaClass(); 098 099 }