Package com.example.opendj.meta
Class ExamplePluginCfgDefn
- java.lang.Object
-
- org.forgerock.opendj.config.AbstractManagedObjectDefinition<C,S>
-
- org.forgerock.opendj.config.ManagedObjectDefinition<ExamplePluginCfgClient,ExamplePluginCfg>
-
- com.example.opendj.meta.ExamplePluginCfgDefn
-
public final class ExamplePluginCfgDefn extends org.forgerock.opendj.config.ManagedObjectDefinition<ExamplePluginCfgClient,ExamplePluginCfg>
An interface for querying the Example Plugin managed object definition meta information.An example "Hello World" plugin.
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description ExamplePluginCfgClient
createClientConfiguration(org.forgerock.opendj.config.client.ManagedObject<? extends ExamplePluginCfgClient> impl)
ExamplePluginCfg
createServerConfiguration(org.forgerock.opendj.config.server.ServerManagedObject<? extends ExamplePluginCfg> impl)
org.forgerock.opendj.config.BooleanPropertyDefinition
getEnabledPropertyDefinition()
Get the "enabled" property definition.static ExamplePluginCfgDefn
getInstance()
Get the Example Plugin configuration definition singleton.org.forgerock.opendj.config.BooleanPropertyDefinition
getInvokeForInternalOperationsPropertyDefinition()
Get the "invoke-for-internal-operations" property definition.org.forgerock.opendj.config.ClassPropertyDefinition
getJavaClassPropertyDefinition()
Get the "java-class" property definition.org.forgerock.opendj.config.StringPropertyDefinition
getMessagePropertyDefinition()
Get the "message" property definition.org.forgerock.opendj.config.EnumPropertyDefinition<org.forgerock.opendj.server.config.meta.PluginCfgDefn.PluginType>
getPluginTypePropertyDefinition()
Get the "plugin-type" property definition.Class<ExamplePluginCfg>
getServerConfigurationClass()
-
Methods inherited from class org.forgerock.opendj.config.AbstractManagedObjectDefinition
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
-
-
-
-
Method Detail
-
getInstance
public static ExamplePluginCfgDefn getInstance()
Get the Example Plugin configuration definition singleton.- Returns:
- Returns the Example Plugin configuration definition singleton.
-
createClientConfiguration
public ExamplePluginCfgClient createClientConfiguration(org.forgerock.opendj.config.client.ManagedObject<? extends ExamplePluginCfgClient> impl)
- Specified by:
createClientConfiguration
in classorg.forgerock.opendj.config.ManagedObjectDefinition<ExamplePluginCfgClient,ExamplePluginCfg>
-
createServerConfiguration
public ExamplePluginCfg createServerConfiguration(org.forgerock.opendj.config.server.ServerManagedObject<? extends ExamplePluginCfg> impl)
- Specified by:
createServerConfiguration
in classorg.forgerock.opendj.config.ManagedObjectDefinition<ExamplePluginCfgClient,ExamplePluginCfg>
-
getServerConfigurationClass
public Class<ExamplePluginCfg> getServerConfigurationClass()
- Specified by:
getServerConfigurationClass
in classorg.forgerock.opendj.config.ManagedObjectDefinition<ExamplePluginCfgClient,ExamplePluginCfg>
-
getEnabledPropertyDefinition
public org.forgerock.opendj.config.BooleanPropertyDefinition getEnabledPropertyDefinition()
Get the "enabled" property definition.Indicates whether the plug-in is enabled for use.
- Returns:
- Returns the "enabled" property definition.
-
getInvokeForInternalOperationsPropertyDefinition
public org.forgerock.opendj.config.BooleanPropertyDefinition getInvokeForInternalOperationsPropertyDefinition()
Get the "invoke-for-internal-operations" property definition.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.
- Returns:
- Returns the "invoke-for-internal-operations" property definition.
-
getJavaClassPropertyDefinition
public org.forgerock.opendj.config.ClassPropertyDefinition getJavaClassPropertyDefinition()
Get the "java-class" property definition.Specifies the fully-qualified name of the Java class that provides the plug-in implementation.
- Returns:
- Returns the "java-class" property definition.
-
getMessagePropertyDefinition
public org.forgerock.opendj.config.StringPropertyDefinition getMessagePropertyDefinition()
Get the "message" property definition.The message to be logged.
- Returns:
- Returns the "message" property definition.
-
getPluginTypePropertyDefinition
public org.forgerock.opendj.config.EnumPropertyDefinition<org.forgerock.opendj.server.config.meta.PluginCfgDefn.PluginType> getPluginTypePropertyDefinition()
Get the "plugin-type" property definition.Specifies the set of plug-in types for the plug-in, which specifies the times at which the plug-in is invoked.
- Returns:
- Returns the "plugin-type" property definition.
-
-