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
|
/* -*- 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):
* bugzilla 62700: Joe Rank (joer@trapdoor.net)
*
* 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.util.*;
import org.ietf.ldap.*;
import java.io.*;
/**
* Class for outputting LDAP entries to a stream as LDIF.
*
* @version 1.0
*/
public class LDIFWriter extends LDAPWriter {
// static final long serialVersionUID = -2710382547996750924L;
private String m_sep;
private boolean m_foldLines;
private boolean m_attrsOnly;
private boolean m_toFiles;
private static final String DEFAULT_SEPARATOR = ":";
private static final int MAX_LINE = 77;
/**
* Constructs an <CODE>LDIFWriter</CODE> object to output entries
* to a stream as LDIF.
*
* @param pw output stream
*/
public LDIFWriter( PrintWriter pw ) {
this( pw, false, DEFAULT_SEPARATOR, true, false );
}
/**
* Constructs an <CODE>LDIFWriter</CODE> object to output entries
* to a stream as LDIF.
*
* @param pw output stream
* @param attrsOnly <code>true</code> if only attribute names, not
* values, are to be printed
* @param separator String to use between attribute names and values;
* the default is ":"
* @param foldLines <code>true</code> to fold lines at 77 characters,
* <code>false</code> to not fold them; the default is <code>true</code>.
* @param toFiles <code>true</code> to write each attribute value to a
* file in the temp folder, <code>false</code> to write them to the
* output stream in printable format; the default is <code>false</code>.
*/
public LDIFWriter( PrintWriter pw, boolean attrsOnly,
String separator, boolean foldLines,
boolean toFiles ) {
super( pw );
m_attrsOnly = attrsOnly;
m_sep = separator;
m_foldLines = foldLines;
m_toFiles = toFiles;
}
/**
* Print an attribute of an entry
*
* @param attr the attribute to format to the output stream
*/
protected void printAttribute( LDAPAttribute attr ) {
String attrName = attr.getName();
if ( m_attrsOnly ) {
printString( attrName + m_sep );
return;
}
/* Loop on values for this attribute */
Enumeration enumVals = attr.getByteValues();
if ( enumVals != null ) {
while (enumVals.hasMoreElements()) {
if ( m_toFiles ) {
try {
FileOutputStream f = getTempFile( attrName );
f.write( (byte[])enumVals.nextElement() );
} catch ( Exception e ) {
System.err.println( "Error writing values " +
"of " + attrName + ", " +
e.toString() );
System.exit(1);
}
} else {
byte[] b = (byte[])enumVals.nextElement();
String s;
if ( LDIF.isPrintable(b) ) {
try {
s = new String( b, "UTF8" );
} catch ( UnsupportedEncodingException e ) {
s = "";
}
printString( attrName + m_sep + " " + s );
} else {
s = getPrintableValue( b );
if ( s.length() > 0 ) {
printString( attrName + ":: " + s );
} else {
printString( attrName + m_sep + ' ' );
}
}
}
}
} else {
printString( attrName + m_sep + ' ' );
}
}
/**
* Print prologue to entry
*
* @param dn the DN of the entry
*/
protected void printEntryStart( String dn ) {
if ( dn == null ) {
printString( "dn" + m_sep + " ");
} else {
byte[] b = null;
try {
b = dn.getBytes( "UTF8" );
} catch ( UnsupportedEncodingException ex ) {
}
if ( LDIF.isPrintable(b) ) {
printString( "dn" + m_sep + " " + dn );
} else {
dn = getPrintableValue( b );
printString( "dn" + m_sep + m_sep + " " + dn );
}
}
}
/**
* Print epilogue to entry
*
* @param dn the DN of the entry
*/
protected void printEntryEnd( String dn ) {
m_pw.println();
}
protected void printString( String value ) {
if ( m_foldLines ) {
LDIF.breakString( m_pw, value, MAX_LINE );
} else {
m_pw.print( value );
m_pw.print( '\n' );
}
}
/**
* Create a unique file name in the temp folder and open an
* output stream to the file
*
* @param name base name of file; an extension is appended which
* consists of a number that makes the name unique
* @return an open output stream to the file
* @exception IOException if the file couldn't be opened for output
*/
protected FileOutputStream getTempFile( String name )
throws IOException {
int num = 0;
File f;
String filename;
do {
filename = name + '.' + num;
f = new File( filename );
num++;
} while ( f.exists() );
printString(name + m_sep + " " + filename);
return new FileOutputStream( f );
}
}
|
