Package org.forgerock.opendj.server.config.client

Interface SambaPasswordPluginCfgClient

All Superinterfaces:

ConfigurationClient, PluginCfgClient

public interface SambaPasswordPluginCfgClient
extends PluginCfgClient

A client-side interface for reading and modifying Samba Password Plugin settings.

Samba Password Synchronization Plugin.

Method Summary

Modifier and Type	Method	Description
ManagedObjectDefinition<? extends SambaPasswordPluginCfgClient,? extends SambaPasswordPluginCfg>	definition()	Get the configuration definition associated with this Samba Password Plugin.
ValueOrExpression<String>	getJavaClass()	Gets the "java-class" property.
SortedSet<ValueOrExpression<PluginCfgDefn.PluginType>>	getPluginType()	Gets the "plugin-type" property.
SortedSet<ValueOrExpression<SambaPasswordPluginCfgDefn.PwdSyncPolicy>>	getPwdSyncPolicy()	Gets the "pwd-sync-policy" property.
ValueOrExpression<Dn>	getSambaAdministratorDn()	Gets the "samba-administrator-dn" property.
void	setJavaClass(ValueOrExpression<String> value)	Sets the "java-class" property.
void	setPluginType(Collection<ValueOrExpression<PluginCfgDefn.PluginType>> values)	Sets the "plugin-type" property.
void	setPwdSyncPolicy(Collection<ValueOrExpression<SambaPasswordPluginCfgDefn.PwdSyncPolicy>> values)	Sets the "pwd-sync-policy" property.
void	setSambaAdministratorDn(ValueOrExpression<Dn> value)	Sets the "samba-administrator-dn" property.

Methods inherited from interface org.forgerock.opendj.config.ConfigurationClient

commit, properties

Methods inherited from interface org.forgerock.opendj.server.config.client.PluginCfgClient

isEnabled, isInvokeForInternalOperations, setEnabled, setInvokeForInternalOperations

Method Detail

definition

ManagedObjectDefinition<? extends SambaPasswordPluginCfgClient,? extends SambaPasswordPluginCfg> definition()

Get the configuration definition associated with this Samba Password Plugin.

Specified by:

definition in interface ConfigurationClient

Specified by:

definition in interface PluginCfgClient

Returns:

Returns the configuration definition associated with this Samba Password Plugin.

getJavaClass

@MandatoryProperty
ValueOrExpression<String> getJavaClass()

Gets the "java-class" property.

Specifies the fully-qualified name of the Java class that provides the plug-in implementation.

Default value: org.opends.server.plugins.SambaPasswordPlugin

Specified by:

getJavaClass in interface PluginCfgClient

Returns:

Returns the value of the "java-class" property.

setJavaClass

@MandatoryProperty
void setJavaClass(ValueOrExpression<String> value)
           throws 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 interface PluginCfgClient

Parameters:

value - The value of the "java-class" property.

Throws:

PropertyException - If the new value is invalid.

getPluginType

@MandatoryProperty
SortedSet<ValueOrExpression<PluginCfgDefn.PluginType>> getPluginType()

Gets the "plugin-type" property.

Specifies the set of plug-in types for the plug-in, which specifies the times at which the plug-in is invoked.

Default values: preoperationmodify, postoperationextended

Specified by:

getPluginType in interface PluginCfgClient

Returns:

Returns the values of the "plugin-type" property.

setPluginType

@MandatoryProperty
void setPluginType(Collection<ValueOrExpression<PluginCfgDefn.PluginType>> values)
            throws PropertyException

Sets the "plugin-type" property.

Specifies the set of plug-in types for the plug-in, which specifies the times at which the plug-in is invoked.

Specified by:

setPluginType in interface PluginCfgClient

Parameters:

values - The values of the "plugin-type" property.

Throws:

PropertyException - If one or more of the new values are invalid.

getPwdSyncPolicy

@MandatoryProperty
SortedSet<ValueOrExpression<SambaPasswordPluginCfgDefn.PwdSyncPolicy>> getPwdSyncPolicy()

Gets the "pwd-sync-policy" property.

Specifies which Samba passwords should be kept synchronized.

Default value: sync-nt-password

Returns:

Returns the values of the "pwd-sync-policy" property.

setPwdSyncPolicy

@MandatoryProperty
void setPwdSyncPolicy(Collection<ValueOrExpression<SambaPasswordPluginCfgDefn.PwdSyncPolicy>> values)
               throws PropertyException

Sets the "pwd-sync-policy" property.

Specifies which Samba passwords should be kept synchronized.

Parameters:

values - The values of the "pwd-sync-policy" property.

Throws:

PropertyException - If one or more of the new values are invalid.

getSambaAdministratorDn

ValueOrExpression<Dn> getSambaAdministratorDn()

Gets the "samba-administrator-dn" property.

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 value of the "samba-administrator-dn" property.

setSambaAdministratorDn

void setSambaAdministratorDn(ValueOrExpression<Dn> value)
                      throws PropertyException

Sets the "samba-administrator-dn" property.

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.

Parameters:

value - The value of the "samba-administrator-dn" property.

Throws:

PropertyException - If the new value is invalid.