com.sun.slamd.scripting.ldap
Class LDAPModificationSetVariable

java.lang.Object
  com.sun.slamd.scripting.engine.Variable
      com.sun.slamd.scripting.ldap.LDAPModificationSetVariable

All Implemented Interfaces:

Argument

public class LDAPModificationSetVariable

extends Variable

This class defines a variable intended to store LDAP modifications so that they can be sent to a directory server. An LDAP modification set has the following methods:

• addModification(ldapmodification modification) -- Adds the specified LDAP modification to this modification set.
• removeAll() -- Removes all modifications from this modification set.

Field Summary

static java.lang.String	ADD_MODIFICATION_METHOD_NAME The name of the method that adds a modification to this modification set.
static int	ADD_MODIFICATION_METHOD_NUMBER The methodNumber for the "addModification" method.
static Method[]	LDAP_MODIFICATION_SET_VARIABLE_METHODS The set of methods associated with LDAP modification set variables.
static java.lang.String	LDAP_MODIFICATION_SET_VARIABLE_TYPE The name that will be used for the data type of LDAP modification set variables.
static java.lang.String	REMOVE_ALL_METHOD_NAME The name of the method that removes all modifications from this modification set.
static int	REMOVE_ALL_METHOD_NUMBER The method number for the "removeAll" method.

Constructor Summary

LDAPModificationSetVariable()
Creates a new variable with no name, to be used only when creating a variable with Class.newInstance(), and only when setName() is called after that to set the name.

Method Summary

void	assign(Argument argument) Assigns the value of the provided argument to this variable.
Variable	executeMethod(int lineNumber, int methodNumber, Argument[] arguments) Executes the specified method, using the provided variables as arguments to the method, and makes the return value available to the caller.
int	getMethodNumber(java.lang.String methodName, java.lang.String[] argumentTypes) Retrieves the method number for the method that has the specified name and argument types, or -1 if there is no such method.
Method[]	getMethods() Retrieves a list of all methods defined for this variable.
java.lang.String	getReturnTypeForMethod(java.lang.String methodName, java.lang.String[] argumentTypes) Retrieves the return type for the method with the specified name and argument types.
java.lang.String	getValueAsString() Retrieves a string representation of the value of this argument.
java.lang.String	getVariableTypeName() Retrieves the name of the variable type for this variable.
boolean	hasMethod(java.lang.String methodName) Indicates whether this variable type has a method with the specified name.
netscape.ldap.LDAPModification[]	toLDAPModifications() Retrieves this set of LDAP modifications as an array of LDAPModification objects.

Methods inherited from class com.sun.slamd.scripting.engine.Variable

getArgumentAsString, getArgumentType, getArgumentValue, getName, getStatTrackers, isValidIdentifier, setName, startStatTrackers, stopStatTrackers

Methods inherited from class java.lang.Object

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

Field Detail

LDAP_MODIFICATION_SET_VARIABLE_TYPE

public static final java.lang.String LDAP_MODIFICATION_SET_VARIABLE_TYPE

The name that will be used for the data type of LDAP modification set variables.

See Also:

Constant Field Values

ADD_MODIFICATION_METHOD_NAME

public static final java.lang.String ADD_MODIFICATION_METHOD_NAME

The name of the method that adds a modification to this modification set.

See Also:

Constant Field Values

ADD_MODIFICATION_METHOD_NUMBER

public static final int ADD_MODIFICATION_METHOD_NUMBER

The methodNumber for the "addModification" method.

See Also:

Constant Field Values

REMOVE_ALL_METHOD_NAME

public static final java.lang.String REMOVE_ALL_METHOD_NAME

The name of the method that removes all modifications from this modification set.

See Also:

Constant Field Values

REMOVE_ALL_METHOD_NUMBER

public static final int REMOVE_ALL_METHOD_NUMBER

The method number for the "removeAll" method.

See Also:

Constant Field Values

LDAP_MODIFICATION_SET_VARIABLE_METHODS

public static final Method[] LDAP_MODIFICATION_SET_VARIABLE_METHODS

The set of methods associated with LDAP modification set variables.

Constructor Detail

LDAPModificationSetVariable

public LDAPModificationSetVariable()
                            throws ScriptException

Creates a new variable with no name, to be used only when creating a variable with Class.newInstance(), and only when setName() is called after that to set the name.

Throws:

ScriptException - If a problem occurs while initializing the new variable.

Method Detail

toLDAPModifications

public netscape.ldap.LDAPModification[] toLDAPModifications()

Retrieves this set of LDAP modifications as an array of LDAPModification objects.

Returns:

This set of LDAP modifications as an array of LDAPModification objects.

getVariableTypeName

public java.lang.String getVariableTypeName()

Retrieves the name of the variable type for this variable.

Specified by:

getVariableTypeName in class Variable

Returns:

The name of the variable type for this variable.

getMethods

public Method[] getMethods()

Retrieves a list of all methods defined for this variable.

Specified by:

getMethods in class Variable

Returns:

A list of all methods defined for this variable.

hasMethod

public boolean hasMethod(java.lang.String methodName)

Indicates whether this variable type has a method with the specified name.

Specified by:

hasMethod in class Variable

Parameters:

methodName - The name of the method.

Returns:

true if this variable has a method with the specified name, or false if it does not.

getMethodNumber

public int getMethodNumber(java.lang.String methodName,
                           java.lang.String[] argumentTypes)

Retrieves the method number for the method that has the specified name and argument types, or -1 if there is no such method.

Specified by:

getMethodNumber in class Variable

Parameters:

methodName - The name of the method.

argumentTypes - The list of argument types for the method.

Returns:

The method number for the method that has the specified name and argument types.

getReturnTypeForMethod

public java.lang.String getReturnTypeForMethod(java.lang.String methodName,
                                               java.lang.String[] argumentTypes)

Retrieves the return type for the method with the specified name and argument types.

Specified by:

getReturnTypeForMethod in class Variable

Parameters:

methodName - The name of the method.

argumentTypes - The set of argument types for the method.

Returns:

The return type for the method, or null if there is no such method defined.

executeMethod

public Variable executeMethod(int lineNumber,
                              int methodNumber,
                              Argument[] arguments)
                       throws ScriptException

Executes the specified method, using the provided variables as arguments to the method, and makes the return value available to the caller.

Specified by:

executeMethod in class Variable

Parameters:

lineNumber - The line number of the script in which the method call occurs.

methodNumber - The method number of the method to execute.

arguments - The set of arguments to use for the method.

Returns:

The value returned from the method, or null if it does not return a value.

Throws:

ScriptException - If the specified method does not exist, or if a problem occurs while attempting to execute it.

assign

public void assign(Argument argument)
            throws ScriptException

Assigns the value of the provided argument to this variable. The value of the provided argument must be of the same type as this variable.

Specified by:

assign in class Variable

Parameters:

argument - The argument whose value should be assigned to this variable.

Throws:

ScriptException - If a problem occurs while performing the assignment.

getValueAsString

public java.lang.String getValueAsString()

Retrieves a string representation of the value of this argument.

Returns:

A string representation of the value of this argument.