Package netscape.ldap
Class LDAPModification
- java.lang.Object
-
- netscape.ldap.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.- Version:
- 1.0
- See Also:
LDAPConnection.modify(java.lang.String, netscape.ldap.LDAPModification)
, Serialized Form
-
-
Constructor Summary
Constructors Constructor Description LDAPModification(int op, LDAPAttribute attr)
Specifies a modification to be made to an attribute.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description LDAPAttribute
getAttribute()
Returns the attribute (possibly with values) to be modified.BERElement
getBERElement()
Retrieves the BER (Basic Encoding Rules) representation of the current modification.int
getOp()
Returns the type of modification specified by this object.java.lang.String
toString()
Retrieves the string representation of the current modification.
-
-
-
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
-
-
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)
attr
- the attribute (possibly with values) to modify- See Also:
LDAPAttribute
-
-
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)
-
getAttribute
public LDAPAttribute getAttribute()
Returns the attribute (possibly with values) to be modified.- Returns:
- the attribute to be modified.
- See Also:
LDAPAttribute
-
getBERElement
public BERElement getBERElement()
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 classjava.lang.Object
- Returns:
- string representation of the current modification.
-
-