Package org.frankframework.ldap

Enum Class LdapSender.Operation

java.lang.Object

java.lang.Enum<LdapSender.Operation>

org.frankframework.ldap.LdapSender.Operation

All Implemented Interfaces:

Serializable, Comparable<LdapSender.Operation>, Constable, DocumentedEnum

Enclosing class:

LdapSender

public static enum LdapSender.Operation
extends Enum<LdapSender.Operation>
implements DocumentedEnum

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CHALLENGE	Check username and password against LDAP specifying principal and credential using parameters.
CHANGE_UNICODE_PWD	Typical user change-password operation (one of the two methods to modify the unicodePwd attribute in AD (http://support.microsoft.com/kb/263991)).
CREATE	Create an attribute or an entry.
DEEP_SEARCH	Search for an entry in the complete tree below the specified root.
DELETE	Delete an attribute or an entry.
GET_TREE	Get a copy of the complete tree below the specified root.
READ	Read the contents of an entry.
SEARCH	Search for an entry in the direct children of the specified root.
SUB_CONTEXTS	Get a list of the direct children of the specifed root.
UPDATE	Update an attribute or an entry.

Method Summary

Modifier and Type	Method	Description
static LdapSender.Operation	valueOf(String name)	Returns the enum constant of this class with the specified name.
static LdapSender.Operation[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.frankframework.doc.DocumentedEnum

getLabel, name

Enum Constant Details

READ

public static final LdapSender.Operation READ

Read the contents of an entry. Configuration requirements:

• parameter 'entryName', resolving to RDN of entry to read
• optional xml-inputmessage containing attributes to be returned

CREATE

public static final LdapSender.Operation CREATE

Create an attribute or an entry. Configuration requirements:

• parameter 'entryName', resolving to RDN of entry to create
• xml-inputmessage containing attributes to create

UPDATE

public static final LdapSender.Operation UPDATE

Update an attribute or an entry. Configuration requirements:

• parameter 'entryName', resolving to RDN of entry to update
• xml-inputmessage containing attributes to update
• optional parameter 'newEntryName', new RDN of entry

DELETE

public static final LdapSender.Operation DELETE

Delete an attribute or an entry. Configuration requirements:

• parameter 'entryName', resolving to RDN of entry to delete
• when manipulationSubject is set to attribute: xml-inputmessage containing attributes to be deleted

SEARCH

public static final LdapSender.Operation SEARCH

Search for an entry in the direct children of the specified root. Configuration requirements:

• parameter 'entryName', resolving to RDN of entry to read
• parameter 'filterExpression', specifying the entries searched for
• optional attribute 'attributesToReturn' containing attributes to be returned

DEEP_SEARCH

public static final LdapSender.Operation DEEP_SEARCH

Search for an entry in the complete tree below the specified root. Configuration requirements:

• parameter 'entryName', resolving to RDN of entry to read
• parameter 'filterExpression', specifying the entries searched for
• optional attribute 'attributesToReturn' containing attributes to be returned

SUB_CONTEXTS

public static final LdapSender.Operation SUB_CONTEXTS

Get a list of the direct children of the specifed root. Configuration requirements:

• parameter 'entryName', resolving to RDN of entry to read
• optional attribute 'attributesToReturn' containing attributes to be returned

GET_TREE

public static final LdapSender.Operation GET_TREE

Get a copy of the complete tree below the specified root. Configuration requirements:

• parameter 'entryName', resolving to RDN of entry to read
• optional attribute 'attributesToReturn' containing attributes to be returned

CHALLENGE

public static final LdapSender.Operation CHALLENGE

Check username and password against LDAP specifying principal and credential using parameters. Configuration requirements:

• parameter 'principal', resolving to RDN of user who's password should be verified
• parameter 'credentials', password to verify

CHANGE_UNICODE_PWD

public static final LdapSender.Operation CHANGE_UNICODE_PWD

Typical user change-password operation (one of the two methods to modify the unicodePwd attribute in AD (http://support.microsoft.com/kb/263991)). Configuration requirements:

• parameter 'entryName', resolving to RDN of user who's password should be changed
• parameter 'oldPassword', current password, will be encoded as required by Active Directory (a UTF-16 encoded Unicode string containing the password surrounded by quotation marks) before sending it to the LDAP server. It's advised to set attribute hidden to true for parameter.
• parameter 'newPassword', new password, will be encoded as required by Active Directory (a UTF-16 encoded Unicode string containing the password surrounded by quotation marks) before sending it to the LDAP server. It's advised to set attribute hidden to true for parameter.

Method Details

values

public static LdapSender.Operation[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static LdapSender.Operation valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null