Package com.example.opendj.client
Interface ExamplePluginCfgClient
-
- All Superinterfaces:
org.forgerock.opendj.config.ConfigurationClient
,org.forgerock.opendj.server.config.client.PluginCfgClient
public interface ExamplePluginCfgClient extends org.forgerock.opendj.server.config.client.PluginCfgClient
A client-side interface for reading and modifying Example Plugin settings.An example "Hello World" plugin.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description org.forgerock.opendj.config.ManagedObjectDefinition<? extends ExamplePluginCfgClient,? extends ExamplePluginCfg>
definition()
Get the configuration definition associated with this Example Plugin.String
getJavaClass()
Gets the "java-class" property.String
getMessage()
Gets the "message" property.void
setJavaClass(String value)
Sets the "java-class" property.void
setMessage(String value)
Sets the "message" property.
-
-
-
Method Detail
-
definition
org.forgerock.opendj.config.ManagedObjectDefinition<? extends ExamplePluginCfgClient,? extends ExamplePluginCfg> definition()
Get the configuration definition associated with this Example Plugin.- Specified by:
definition
in interfaceorg.forgerock.opendj.config.ConfigurationClient
- Specified by:
definition
in interfaceorg.forgerock.opendj.server.config.client.PluginCfgClient
- Returns:
- Returns the configuration definition associated with this Example Plugin.
-
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.client.PluginCfgClient
- Returns:
- Returns the value of the "java-class" property.
-
setJavaClass
void setJavaClass(String value) throws org.forgerock.opendj.config.PropertyException
Sets the "java-class" property.Specifies the fully-qualified name of the Java class that provides the plug-in implementation.
- Specified by:
setJavaClass
in interfaceorg.forgerock.opendj.server.config.client.PluginCfgClient
- Parameters:
value
- The value of the "java-class" property.- Throws:
org.forgerock.opendj.config.PropertyException
- If the new value is invalid.
-
getMessage
String getMessage()
Gets the "message" property.The message to be logged.
- Returns:
- Returns the value of the "message" property.
-
setMessage
void setMessage(String value) throws org.forgerock.opendj.config.PropertyException
Sets the "message" property.The message to be logged.
- Parameters:
value
- The value of the "message" property.- Throws:
org.forgerock.opendj.config.PropertyException
- If the new value is invalid.
-
-