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.Configuration; 022import org.forgerock.opendj.config.server.ConfigurationChangeListener; 023import org.forgerock.opendj.server.config.meta.PluginCfgDefn.PluginType; 024 025 026 027/** 028 * A server-side interface for querying Plugin settings. 029 * <p> 030 * Plugins provide a mechanism for executing custom code at specified 031 * points in operation processing and in the course of other events 032 * like connection establishment and termination, server startup and 033 * shutdown, and LDIF import and export. 034 */ 035public interface PluginCfg extends Configuration { 036 037 /** 038 * Gets the configuration class associated with this Plugin. 039 * 040 * @return Returns the configuration class associated with this Plugin. 041 */ 042 Class<? extends PluginCfg> configurationClass(); 043 044 045 046 /** 047 * Register to be notified when this Plugin is changed. 048 * 049 * @param listener 050 * The Plugin configuration change listener. 051 */ 052 void addChangeListener(ConfigurationChangeListener<PluginCfg> listener); 053 054 055 056 /** 057 * Deregister an existing Plugin configuration change listener. 058 * 059 * @param listener 060 * The Plugin configuration change listener. 061 */ 062 void removeChangeListener(ConfigurationChangeListener<PluginCfg> listener); 063 064 065 066 /** 067 * Gets the "enabled" property. 068 * <p> 069 * Indicates whether the plug-in is enabled for use. 070 * 071 * @return Returns the value of the "enabled" property. 072 */ 073 boolean isEnabled(); 074 075 076 077 /** 078 * Gets the "invoke-for-internal-operations" property. 079 * <p> 080 * Indicates whether the plug-in should be invoked for internal 081 * operations. 082 * <p> 083 * Any plug-in that can be invoked for internal operations must 084 * ensure that it does not create any new internal operatons that can 085 * cause the same plug-in to be re-invoked. 086 * 087 * @return Returns the value of the "invoke-for-internal-operations" property. 088 */ 089 boolean isInvokeForInternalOperations(); 090 091 092 093 /** 094 * Gets the "java-class" property. 095 * <p> 096 * Specifies the fully-qualified name of the Java class that 097 * provides the plug-in implementation. 098 * 099 * @return Returns the value of the "java-class" property. 100 */ 101 String getJavaClass(); 102 103 104 105 /** 106 * Gets the "plugin-type" property. 107 * <p> 108 * Specifies the set of plug-in types for the plug-in, which 109 * specifies the times at which the plug-in is invoked. 110 * 111 * @return Returns an unmodifiable set containing the values of the "plugin-type" property. 112 */ 113 SortedSet<PluginType> getPluginType(); 114 115}