Package org.forgerock.opendj.server.config.meta

Class SambaPasswordPluginCfgDefn

java.lang.Object

org.forgerock.opendj.config.AbstractManagedObjectDefinition<C,S>

org.forgerock.opendj.config.ManagedObjectDefinition<SambaPasswordPluginCfgClient,SambaPasswordPluginCfg>

org.forgerock.opendj.server.config.meta.SambaPasswordPluginCfgDefn

public final class SambaPasswordPluginCfgDefn
extends ManagedObjectDefinition<SambaPasswordPluginCfgClient,SambaPasswordPluginCfg>

An interface for querying the Samba Password Plugin managed object definition meta information.

Samba Password Synchronization Plugin.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SambaPasswordPluginCfgDefn.PwdSyncPolicy	Defines the set of permissable values for the "pwd-sync-policy" property.

Method Summary

Modifier and Type	Method	Description
SambaPasswordPluginCfgClient	createClientConfiguration(ManagedObject<? extends SambaPasswordPluginCfgClient> impl)	Creates a client configuration view of the provided managed object.
SambaPasswordPluginCfg	createServerConfiguration(ServerManagedObject<? extends SambaPasswordPluginCfg> impl)	Creates a server configuration view of the provided server managed object.
BooleanPropertyDefinition	getEnabledPropertyDefinition()	Get the "enabled" property definition.
static SambaPasswordPluginCfgDefn	getInstance()	Get the Samba Password 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.
EnumPropertyDefinition<SambaPasswordPluginCfgDefn.PwdSyncPolicy>	getPwdSyncPolicyPropertyDefinition()	Get the "pwd-sync-policy" property definition.
DNPropertyDefinition	getSambaAdministratorDNPropertyDefinition()	Get the "samba-administrator-dn" property definition.
Class<SambaPasswordPluginCfg>	getServerConfigurationClass()	Gets the server configuration class instance associated with this managed object definition.

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getInstance

public static SambaPasswordPluginCfgDefn getInstance()

Get the Samba Password Plugin configuration definition singleton.

Returns:

Returns the Samba Password Plugin configuration definition singleton.

createClientConfiguration

public SambaPasswordPluginCfgClient createClientConfiguration(ManagedObject<? extends SambaPasswordPluginCfgClient> impl)

Creates a client configuration view of the provided managed object. Modifications made to the underlying managed object will be reflected in the client configuration view and vice versa.

Specified by:

createClientConfiguration in class ManagedObjectDefinition<SambaPasswordPluginCfgClient,SambaPasswordPluginCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

public SambaPasswordPluginCfg createServerConfiguration(ServerManagedObject<? extends SambaPasswordPluginCfg> impl)

Creates a server configuration view of the provided server managed object.

Specified by:

createServerConfiguration in class ManagedObjectDefinition<SambaPasswordPluginCfgClient,SambaPasswordPluginCfg>

Parameters:

impl - The server managed object.

Returns:

Returns a server configuration view of the provided server managed object.

getServerConfigurationClass

public Class<SambaPasswordPluginCfg> getServerConfigurationClass()

Gets the server configuration class instance associated with this managed object definition.

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<SambaPasswordPluginCfgClient,SambaPasswordPluginCfg>

Returns:

Returns the server configuration class instance associated with this managed object definition.

getEnabledPropertyDefinition

public BooleanPropertyDefinition getEnabledPropertyDefinition()

Get the "enabled" property definition.

Indicates whether the plug-in is enabled for use.

Returns:

Returns the "enabled" property definition.

getInvokeForInternalOperationsPropertyDefinition

public 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 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.

getPluginTypePropertyDefinition

public EnumPropertyDefinition<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.

getPwdSyncPolicyPropertyDefinition

public EnumPropertyDefinition<SambaPasswordPluginCfgDefn.PwdSyncPolicy> getPwdSyncPolicyPropertyDefinition()

Get the "pwd-sync-policy" property definition.

Specifies which Samba passwords should be kept synchronized.

Returns:

Returns the "pwd-sync-policy" property definition.

getSambaAdministratorDNPropertyDefinition

public DNPropertyDefinition getSambaAdministratorDNPropertyDefinition()

Get the "samba-administrator-dn" property definition.

Specifies the distinguished name of the user which Samba uses to perform Password Modify extended operations against this directory server in order to synchronize the userPassword attribute after the LanMan or NT passwords have been updated.

The user must have the 'password-reset' privilege and should not be a root user. This user name can be used in order to identify Samba connections and avoid double re-synchronization of the same password. If this property is left undefined, then no password updates will be skipped.

Returns:

Returns the "samba-administrator-dn" property definition.