Package com.example.opendj.server
Interface ExamplePluginCfg
-
- All Superinterfaces:
org.forgerock.opendj.config.Configuration
,org.forgerock.opendj.server.config.server.PluginCfg
public interface ExamplePluginCfg extends org.forgerock.opendj.server.config.server.PluginCfg
A server-side interface for querying Example Plugin settings.An example "Hello World" plugin.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addExampleChangeListener(org.forgerock.opendj.config.server.ConfigurationChangeListener<ExamplePluginCfg> listener)
Register to be notified when this Example Plugin is changed.Class<? extends ExamplePluginCfg>
configurationClass()
Gets the configuration class associated with this Example Plugin.String
getJavaClass()
Gets the "java-class" property.String
getMessage()
Gets the "message" property.void
removeExampleChangeListener(org.forgerock.opendj.config.server.ConfigurationChangeListener<ExamplePluginCfg> listener)
Deregister an existing Example Plugin configuration change listener.
-
-
-
Method Detail
-
configurationClass
Class<? extends ExamplePluginCfg> configurationClass()
Gets the configuration class associated with this Example Plugin.- Specified by:
configurationClass
in interfaceorg.forgerock.opendj.config.Configuration
- Specified by:
configurationClass
in interfaceorg.forgerock.opendj.server.config.server.PluginCfg
- Returns:
- Returns the configuration class associated with this Example Plugin.
-
addExampleChangeListener
void addExampleChangeListener(org.forgerock.opendj.config.server.ConfigurationChangeListener<ExamplePluginCfg> listener)
Register to be notified when this Example Plugin is changed.- Parameters:
listener
- The Example Plugin configuration change listener.
-
removeExampleChangeListener
void removeExampleChangeListener(org.forgerock.opendj.config.server.ConfigurationChangeListener<ExamplePluginCfg> listener)
Deregister an existing Example Plugin configuration change listener.- Parameters:
listener
- The Example Plugin configuration change listener.
-
getJavaClass
String getJavaClass()
Gets the "java-class" property.Specifies the fully-qualified name of the Java class that provides the plug-in implementation.
- Specified by:
getJavaClass
in interfaceorg.forgerock.opendj.server.config.server.PluginCfg
- Returns:
- Returns the value of the "java-class" property.
-
getMessage
String getMessage()
Gets the "message" property.The message to be logged.
- Returns:
- Returns the value of the "message" property.
-
-