1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
*
* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is mozilla.org code.
*
* The Initial Developer of the Original Code is
* Netscape Communications Corporation.
* Portions created by the Initial Developer are Copyright (C) 2001
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
*
* Alternatively, the contents of this file may be used under the terms of
* either the GNU General Public License Version 2 or later (the "GPL"), or
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the MPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
package org.ietf.ldap;
import java.io.Serializable;
import org.ietf.ldap.ber.stream.*;
/**
* Specifies changes to be made to the values of an attribute. The change is
* specified in terms of the following aspects:
* <P>
*
* <UL>
* <LI>the type of modification (add, replace, or delete the value of an attribute)
* <LI>the type of value being modified (string or binary)
* <LI>the name of the attribute being modified
* <LI>the actual value
* </UL>
* <P>
*
* After you specify a change to an attribute, you can execute the change
* by calling the <CODE>LDAPConnection.modify</CODE> method and specifying
* the DN of the entry that you want to modify.
* <P>
*
* @version 1.0
* @see org.ietf.ldap.LDAPConnection#modify(java.lang.String, org.ietf.ldap.LDAPModification)
*/
public class LDAPModification implements Serializable {
static final long serialVersionUID = 4836472112866826595L;
/**
* Specifies that a value should be added to an attribute.
*/
public static final int ADD = 0;
/**
* Specifies that a value should be removed from an attribute.
*/
public static final int DELETE = 1;
/**
* Specifies that a value should replace the existing value in an attribute.
*/
public static final int REPLACE = 2;
/**
* Internal variables
*/
private int operation;
private LDAPAttribute attribute;
/**
* Specifies a modification to be made to an attribute.
* @param op the type of modification to make. This can be one of the following:
* <P>
* <UL>
* <LI><CODE>LDAPModification.ADD</CODE> (the value should be added to the attribute)
* <LI><CODE>LDAPModification.DELETE</CODE> (the value should be removed from the attribute)
* <LI><CODE>LDAPModification.REPLACE</CODE> (the value should replace the existing value of the attribute)
* </UL><P>
* @param attr the attribute (possibly with values) to modify
* @see org.ietf.ldap.LDAPAttribute
*/
public LDAPModification( int op, LDAPAttribute attr ) {
operation = op;
attribute = attr;
}
/**
* Returns the attribute (possibly with values) to be modified.
* @return the attribute to be modified.
* @see org.ietf.ldap.LDAPAttribute
*/
public LDAPAttribute getAttribute() {
return attribute;
}
/**
* Returns the type of modification specified by this object.
* @return one of the following types of modifications:
* <P>
* <UL>
* <LI><CODE>LDAPModification.ADD</CODE> (the value should be added to the attribute)
* <LI><CODE>LDAPModification.DELETE</CODE> (the value should be removed from the attribute)
* <LI><CODE>LDAPModification.REPLACE</CODE> (the value should replace the existing value of the attribute)
* </UL><P>
*/
public int getOp() {
return operation;
}
/**
* Retrieves the BER (Basic Encoding Rules) representation
* of the current modification.
* @return BER representation of the modification.
*/
public BERElement getBERElement() {
BERSequence seq = new BERSequence();
seq.addElement(new BEREnumerated(operation));
seq.addElement(attribute.getBERElement());
return seq;
}
/**
* Retrieves the string representation of the current
* modification. For example:
*
* <PRE>
* LDAPModification: REPLACE, LDAPAttribute {type='mail', values='babs@ace.com'}
* LDAPModification: ADD, LDAPAttribute {type='description', values='This entry was modified with the modattrs program'}
* </PRE>
*
* @return string representation of the current modification.
*/
public String toString() {
String s = "LDAPModification: ";
if ( operation == ADD )
s += "ADD, ";
else if ( operation == DELETE )
s += "DELETE, ";
else if ( operation == REPLACE )
s += "REPLACE, ";
else
s += "INVALID OP, ";
s += attribute;
return s;
}
}
|
