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.
String	getJavaClass()	Gets the "java-class" property.
SortedSet<PluginCfgDefn.PluginType>	getPluginType()	Gets the "plugin-type" property.
SortedSet<SambaPasswordPluginCfgDefn.PwdSyncPolicy>	getPwdSyncPolicy()	Gets the "pwd-sync-policy" property.
org.forgerock.opendj.ldap.DN	getSambaAdministratorDN()	Gets the "samba-administrator-dn" property.
void	setJavaClass(String value)	Sets the "java-class" property.
void	setPluginType(Collection<PluginCfgDefn.PluginType> values)	Sets the "plugin-type" property.
void	setPwdSyncPolicy(Collection<SambaPasswordPluginCfgDefn.PwdSyncPolicy> values)	Sets the "pwd-sync-policy" property.
void	setSambaAdministratorDN(org.forgerock.opendj.ldap.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

String getJavaClass()

Gets the "java-class" property.

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

Specified by:

getJavaClass in interface PluginCfgClient

Returns:

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

setJavaClass

void setJavaClass(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

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

Specified by:

getPluginType in interface PluginCfgClient

Returns:

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

setPluginType

void setPluginType(Collection<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

SortedSet<SambaPasswordPluginCfgDefn.PwdSyncPolicy> getPwdSyncPolicy()

Gets the "pwd-sync-policy" property.

Specifies which Samba passwords should be kept synchronized.

Returns:

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

setPwdSyncPolicy

void setPwdSyncPolicy(Collection<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

org.forgerock.opendj.ldap.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(org.forgerock.opendj.ldap.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.