public interface PluginCfgClient extends ConfigurationClient
Plugins provide a mechanism for executing custom code at specified points in operation processing and in the course of other events like connection establishment and termination, server startup and shutdown, and LDIF import and export.
Modifier and Type | Method and Description |
---|---|
ManagedObjectDefinition<? extends PluginCfgClient,? extends PluginCfg> |
definition()
Get the configuration definition associated with this Plugin.
|
ValueOrExpression<String> |
getJavaClass()
Gets the "java-class" property.
|
SortedSet<ValueOrExpression<PluginCfgDefn.PluginType>> |
getPluginType()
Gets the "plugin-type" property.
|
ValueOrExpression<Boolean> |
isEnabled()
Gets the "enabled" property.
|
ValueOrExpression<Boolean> |
isInvokeForInternalOperations()
Gets the "invoke-for-internal-operations" property.
|
void |
setEnabled(ValueOrExpression<Boolean> value)
Sets the "enabled" property.
|
void |
setInvokeForInternalOperations(ValueOrExpression<Boolean> value)
Sets the "invoke-for-internal-operations" property.
|
void |
setJavaClass(ValueOrExpression<String> value)
Sets the "java-class" property.
|
void |
setPluginType(Collection<ValueOrExpression<PluginCfgDefn.PluginType>> values)
Sets the "plugin-type" property.
|
commit, properties
ManagedObjectDefinition<? extends PluginCfgClient,? extends PluginCfg> definition()
definition
in interface ConfigurationClient
ValueOrExpression<Boolean> isEnabled()
Indicates whether the plug-in is enabled for use.
void setEnabled(ValueOrExpression<Boolean> value) throws PropertyException
Indicates whether the plug-in is enabled for use.
value
- The value of the "enabled" property.PropertyException
- If the new value is invalid.ValueOrExpression<Boolean> isInvokeForInternalOperations()
Indicates whether the plug-in should be invoked for internal operations.
Any plug-in that can be invoked for internal operations must ensure that it does not create any new internal operatons that can cause the same plug-in to be re-invoked.
void setInvokeForInternalOperations(ValueOrExpression<Boolean> value) throws PropertyException
Indicates whether the plug-in should be invoked for internal operations.
Any plug-in that can be invoked for internal operations must ensure that it does not create any new internal operatons that can cause the same plug-in to be re-invoked.
value
- The value of the "invoke-for-internal-operations" property.PropertyException
- If the new value is invalid.ValueOrExpression<String> getJavaClass()
Specifies the fully-qualified name of the Java class that provides the plug-in implementation.
void setJavaClass(ValueOrExpression<String> value) throws PropertyException
Specifies the fully-qualified name of the Java class that provides the plug-in implementation.
value
- The value of the "java-class" property.PropertyException
- If the new value is invalid.SortedSet<ValueOrExpression<PluginCfgDefn.PluginType>> getPluginType()
Specifies the set of plug-in types for the plug-in, which specifies the times at which the plug-in is invoked.
void setPluginType(Collection<ValueOrExpression<PluginCfgDefn.PluginType>> values) throws PropertyException
Specifies the set of plug-in types for the plug-in, which specifies the times at which the plug-in is invoked.
values
- The values of the "plugin-type" property.PropertyException
- If one or more of the new values are invalid.Copyright 2010-2018 ForgeRock AS.