public final class PluginCfgDefn extends ManagedObjectDefinition<PluginCfgClient,PluginCfg>
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 | Class and Description |
---|---|
static class |
PluginCfgDefn.PluginType
Defines the set of permissable values for the "plugin-type" property.
|
Modifier and Type | Method and Description |
---|---|
PluginCfgClient |
createClientConfiguration(ManagedObject<? extends PluginCfgClient> impl)
Creates a client configuration view of the provided managed object.
|
PluginCfg |
createServerConfiguration(ServerManagedObject<? extends PluginCfg> impl)
Creates a server configuration view of the provided server managed
object.
|
BooleanPropertyDefinition |
getEnabledPropertyDefinition()
Get the "enabled" property definition.
|
static PluginCfgDefn |
getInstance()
Get the Plugin configuration definition singleton.
|
BooleanPropertyDefinition |
getInvokeForInternalOperationsPropertyDefinition()
Get the "invoke-for-internal-operations" property definition.
|
ClassPropertyDefinition |
getJavaClassPropertyDefinition()
Get the "java-class" property definition.
|
EnumPropertyDefinition<PluginCfgDefn.PluginType> |
getPluginTypePropertyDefinition()
Get the "plugin-type" property definition.
|
Class<PluginCfg> |
getServerConfigurationClass()
Gets the server configuration class instance associated with this managed
object definition.
|
getAggregationPropertyDefinition, getAggregationPropertyDefinitions, getAllAggregationPropertyDefinitions, getAllChildren, getAllConstraints, getAllPropertyDefinitions, getAllRelationDefinitions, getAllReverseAggregationPropertyDefinitions, getAllReverseRelationDefinitions, getAllTags, getChild, getChildren, getConstraints, getDescription, getDescription, getName, getParent, getPropertyDefinition, getPropertyDefinitions, getRelationDefinition, getRelationDefinitions, getReverseAggregationPropertyDefinitions, getReverseRelationDefinitions, getSynopsis, getSynopsis, getUserFriendlyName, getUserFriendlyName, getUserFriendlyPluralName, getUserFriendlyPluralName, hasChildren, hasOption, hasTag, initialize, isChildOf, isParentOf, isTop, registerConstraint, registerOption, registerPropertyDefinition, registerRelationDefinition, registerTag, resolveManagedObjectDefinition, toString, toString
public static PluginCfgDefn getInstance()
public PluginCfgClient createClientConfiguration(ManagedObject<? extends PluginCfgClient> impl)
ManagedObjectDefinition
createClientConfiguration
in class ManagedObjectDefinition<PluginCfgClient,PluginCfg>
impl
- The managed object.public PluginCfg createServerConfiguration(ServerManagedObject<? extends PluginCfg> impl)
ManagedObjectDefinition
createServerConfiguration
in class ManagedObjectDefinition<PluginCfgClient,PluginCfg>
impl
- The server managed object.public Class<PluginCfg> getServerConfigurationClass()
ManagedObjectDefinition
getServerConfigurationClass
in class ManagedObjectDefinition<PluginCfgClient,PluginCfg>
public BooleanPropertyDefinition getEnabledPropertyDefinition()
Indicates whether the plug-in is enabled for use.
public BooleanPropertyDefinition getInvokeForInternalOperationsPropertyDefinition()
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.
public ClassPropertyDefinition getJavaClassPropertyDefinition()
Specifies the fully-qualified name of the Java class that provides the plug-in implementation.
public EnumPropertyDefinition<PluginCfgDefn.PluginType> getPluginTypePropertyDefinition()
Specifies the set of plug-in types for the plug-in, which specifies the times at which the plug-in is invoked.
Copyright 2010-2018 ForgeRock AS.