com.rli.slapd.server

Class LDAPModification

java.lang.Object

com.rli.slapd.server.LDAPModification

All Implemented Interfaces:

java.io.Serializable

public class LDAPModification
extends java.lang.Object
implements java.io.Serializable

Specifies changes to be made to the values of an attribute. The change is specified in terms of the following aspects:

• the type of modification (add, replace, or delete the value of an attribute)
• the type of value being modified (string or binary)
• the name of the attribute being modified
• the actual value

After you specify a change to an attribute, you can execute the change by calling the LDAPConnection.modify method and specifying the DN of the entry that you want to modify.

See Also:

LDAPConnection.modify(java.lang.String, netscape.ldap.LDAPModification), Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	ADD Specifies that a value should be added to an attribute.
static int	DELETE Specifies that a value should be removed from an attribute.
static int	INCREMENT
static int	REPLACE Specifies that a value should replace the existing value in an attribute.

Constructor Summary

Constructors

Constructor and Description
LDAPModification(int op, LDAPAttribute attr) Specifies a modification to be made to an attribute.
LDAPModification(LDAPModification modif) clone constuctor

Method Summary

Modifier and Type	Method and Description
BERElement	encodeToBERElement() Retrieves the BER (Basic Encoding Rules) representation of the current modification.
boolean	equals(java.lang.Object obj)
static LDAPModification	findLDAPModification(LDAPModification[] arrayLDAPModification, java.lang.String attrName) find LDAPModification by its name, return null if not found.
LDAPAttribute	getAttribute() Returns the attribute (possibly with values) to be modified.
static int	getDirContextModificationOp(int ldapModificationOp) convert DirContext code to LDAPModification code
static int	getLDAPModificationOp(int dirContexOp) convert DirContext code to LDAPModification code
int	getOp() Returns the type of modification specified by this object.
static int	getOPcode(java.lang.String OPstring) Convert OP String to int code
int	getOpDirContext() code as used in DirContext is different.
static java.lang.String	getOPstring(int OPcode) Convert OP code to String
void	setAttribute(LDAPAttribute attribute) set the attribute (possibly with values) to be modified.
void	setOp(int operation) set the type of modification specified by this object.
java.lang.String	toString() Retrieves the string representation of the current modification.
java.lang.String	toString(java.lang.String entryDn)

Methods inherited from class java.lang.Object

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

Field Detail

ADD

public static final int ADD

Specifies that a value should be added to an attribute.

See Also:

Constant Field Values

DELETE

public static final int DELETE

Specifies that a value should be removed from an attribute.

See Also:

Constant Field Values

REPLACE

public static final int REPLACE

Specifies that a value should replace the existing value in an attribute.

See Also:

Constant Field Values

INCREMENT

public static final int INCREMENT

See Also:

Constant Field Values

Constructor Detail

LDAPModification

public LDAPModification(int op,
                        LDAPAttribute attr)

Specifies a modification to be made to an attribute.

Parameters:

op - the type of modification to make. This can be one of the following:

• LDAPModification.ADD (the value should be added to the attribute)
• LDAPModification.DELETE (the value should be removed from the attribute)
• LDAPModification.REPLACE (the value should replace the existing value of the attribute)
• LDAPModification.INCEMENT (RFC 4525)

attr - the attribute (possibly with values) to modify

See Also:

LDAPAttribute

LDAPModification

public LDAPModification(LDAPModification modif)

clone constuctor

Parameters:

modif -

Method Detail

getOp

public int getOp()

Returns the type of modification specified by this object.

Returns:

one of the following types of modifications:

• LDAPModification.ADD (the value should be added to the attribute)
• LDAPModification.DELETE (the value should be removed from the attribute)
• LDAPModification.REPLACE (the value should replace the existing value of the attribute)
• LDAPModification.INCEMENT (RFC 4525)

getOpDirContext

public int getOpDirContext()

code as used in DirContext is different. use this when going to "pure" JNDI world.

Returns:

getAttribute

public LDAPAttribute getAttribute()

Returns the attribute (possibly with values) to be modified.

Returns:

the attribute to be modified.

See Also:

LDAPAttribute

encodeToBERElement

public BERElement encodeToBERElement()

Retrieves the BER (Basic Encoding Rules) representation of the current modification.

Returns:

BER representation of the modification.

toString

public java.lang.String toString()

Retrieves the string representation of the current modification. For example:

 LDAPModification: REPLACE, LDAPAttribute {type='mail', values='babs@ace.com'}
 LDAPModification: ADD, LDAPAttribute {type='description', values='This entry was modified with the modattrs program'}
 

Overrides:

toString in class java.lang.Object

Returns:

string representation of the current modification.

toString

public java.lang.String toString(java.lang.String entryDn)

getLDAPModificationOp

public static int getLDAPModificationOp(int dirContexOp)

convert DirContext code to LDAPModification code

Parameters:

dirContexOp -

Returns:

getOPstring

public static java.lang.String getOPstring(int OPcode)

Convert OP code to String

Returns:

"invalid operation" if no match

getOPcode

public static int getOPcode(java.lang.String OPstring)

Convert OP String to int code

Parameters:

OPstring -

Returns:

-1 if no match

getDirContextModificationOp

public static int getDirContextModificationOp(int ldapModificationOp)

convert DirContext code to LDAPModification code

Parameters:

ldapModificationOp -

Returns:

setOp

public void setOp(int operation)

set the type of modification specified by this object.

• LDAPModification.ADD (the value should be added to the attribute)
• LDAPModification.DELETE (the value should be removed from the attribute)
• LDAPModification.REPLACE (the value should replace the existing value of the attribute)
• LDAPModification.INCEMENT (RFC 4525)

setAttribute

public void setAttribute(LDAPAttribute attribute)

set the attribute (possibly with values) to be modified. attribute the attribute to be modified.

See Also:

LDAPAttribute

findLDAPModification

public static LDAPModification findLDAPModification(LDAPModification[] arrayLDAPModification,
                                                    java.lang.String attrName)

find LDAPModification by its name, return null if not found.

Parameters:

arrayLDAPModification -

attrName -

Returns:

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object