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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
|
/* -*- 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) 1999
* 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.util;
import java.io.Serializable;
import org.ietf.ldap.LDAPControl;
/**
* An object of this class represents an LDIF record in an LDIF
* file (or in LDIF data). A record can contain a list of attributes
* (which describes an entry) or a list of modifications (which
* decribes the changes that need to be made to an entry).
* Each record also has a distinguished name.
* <P>
*
* You can get an <CODE>LDIFRecord</CODE> object from LDIF data
* by calling the <CODE>nextRecord</CODE> method of the
* <CODE>LDIF</CODE> object holding the data.
* <P>
*
* If you are constructing a new <CODE>LDIFRecord</CODE> object,
* you can specify the content of the record in one of the
* following ways:
* <P>
*
* <UL>
* <LI>To create a record that specifies an entry, use an object of
* the <CODE>LDIFAttributeContent</CODE> class.
* <LI>To create a record that specifies a modification to be made,
* use an object of one of the following classes:
* <UL>
* <LI>Use <CODE>LDIFAddContent</CODE> to add a new entry.
* <LI>Use <CODE>LDIFModifyContent</CODE> to modify an entry.
* <LI>Use <CODE>LDIFDeleteContent</CODE> to delete an entry.
* </UL>
* </UL>
* <P>
*
* @version 1.0
* @see org.ietf.ldap.util.LDIF
* @see org.ietf.ldap.util.LDIFAddContent
* @see org.ietf.ldap.util.LDIFModifyContent
* @see org.ietf.ldap.util.LDIFDeleteContent
* @see org.ietf.ldap.util.LDIFAttributeContent
*/
public class LDIFRecord implements Serializable {
/**
* Internal variables
*/
private String m_dn = null;
private LDIFBaseContent m_content = null;
static final long serialVersionUID = -6537481934870076178L;
/**
* Constructs a new <CODE>LDIFRecord</CODE> object with the
* specified content.
* @param dn distinguished name of the entry associated with
* the record
* @param content content of the LDIF record. You can specify
* an object of the <CODE>LDIFAttributeContent</CODE>,
* <CODE>LDIFAddContent</CODE>, <CODE>LDIFModifyContent</CODE>,
* or <CODE>LDIFDeleteContent</CODE> classes.
* @see org.ietf.ldap.util.LDIFAddContent
* @see org.ietf.ldap.util.LDIFModifyContent
* @see org.ietf.ldap.util.LDIFDeleteContent
* @see org.ietf.ldap.util.LDIFAttributeContent
*/
public LDIFRecord(String dn, LDIFContent content) {
m_dn = dn;
m_content = (LDIFBaseContent)content;
}
/**
* Retrieves the distinguished name of the LDIF record.
* @return the distinguished name of the LDIF record.
*/
public String getDN() {
return m_dn;
}
/**
* Retrieves the content of the LDIF record. The content is
* an object of the <CODE>LDIFAttributeContent</CODE>,
* <CODE>LDIFAddContent</CODE>, <CODE>LDIFModifyContent</CODE>,
* or <CODE>LDIFDeleteContent</CODE> classes.
* <P>
*
* To determine the class of the object, use the <CODE>getType</CODE>
* method of that object. <CODE>getType</CODE> returns one of
* the following values:
* <UL>
* <LI><CODE>LDIFContent.ATTRIBUTE_CONTENT</CODE> (the object is an
* <CODE>LDIFAttributeContent</CODE> object)
* <LI><CODE>LDIFContent.ADD_CONTENT</CODE> (the object is an
* <CODE>LDIFAddContent</CODE> object)
* <LI><CODE>LDIFContent.MODIFICATION_CONTENT</CODE> (the object is an
* <CODE>LDIFModifyContent</CODE> object)
* <LI><CODE>LDIFContent.DELETE_CONTENT</CODE> (the object is an
* <CODE>LDIFDeleteContent</CODE> object)
* </UL>
* <P>
*
* For example:
* <PRE>
* ...
* import org.ietf.ldap.*;
* import org.ietf.ldap.util.*;
* import java.io.*;
* import java.util.*;
* ...
* try {
* // Parse the LDIF file test.ldif.
* LDIF parser = new LDIF( "test.ldif" );
* // Iterate through each LDIF record in the file.
* LDIFRecord nextRec = parser.nextRecord();
* while ( nextRec != null ) {
* // Based on the type of content in the record,
* // get the content and cast it as the appropriate
* // type.
* switch( nextRec.getContent().getType() ) {
* case LDIFContent.ATTRIBUTE_CONTENT:
* LDIFAttributeContent attrContent =
* (LDIFAttributeContent)nextRec.getContent();
* break;
* case LDIFContent.ADD_CONTENT:
* LDIFAddContent addContent =
* (LDIFAddContent)nextRec.getContent();
* break;
* case LDIFContent.MODIFICATION_CONTENT:
* LDIFModifyContent modifyContent =
* (LDIFModifyContent)nextRec.getContent();
* break;
* case LDIFContent.DELETE_CONTENT:
* LDIFDeleteContent deleteContent =
* (LDIFDeleteContent)nextRec.getContent();
* break;
* }
* ...
* // Iterate through each record.
* nextRec = parser.nextRecord();
* }
* } catch ( IOException e ) {
* System.out.println( "Error: " + e.toString() );
* System.exit(1);
* }
* ...
* </PRE>
*
* @return the content of the LDIF record.
* @see org.ietf.ldap.util.LDIFAddContent
* @see org.ietf.ldap.util.LDIFModifyContent
* @see org.ietf.ldap.util.LDIFDeleteContent
* @see org.ietf.ldap.util.LDIFAttributeContent
*/
public LDIFContent getContent() {
return m_content;
}
/**
* Retrieves the list of controls specified in the content
* of the LDIF record, if any.
* @return an array of <CODE>LDAPControl</CODE> objects that
* represent any controls specified in the LDIF record,
* or <CODE>null</CODE> if none were specified.
*/
public LDAPControl[] getControls() {
return (m_content == null) ? null : m_content.getControls();
}
/**
* Gets the string representation of the <CODE>LDIFRecord</CODE>
* object.
* @return the string representation of the LDIF record.
*/
public String toString() {
return "LDIFRecord {dn=" + m_dn + ", content=" + m_content + "}";
}
}
|
