131 lines
4.1 KiB
Java
131 lines
4.1 KiB
Java
/* -*- 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 netscape.ldap.util;
|
|
|
|
import java.util.*;
|
|
import netscape.ldap.*;
|
|
import java.io.*;
|
|
|
|
/**
|
|
* Abstract class for outputting LDAP entries to a stream.
|
|
*
|
|
* @version 1.0
|
|
*/
|
|
public abstract class LDAPWriter implements Serializable {
|
|
|
|
// static final long serialVersionUID = -2710382547996750924L;
|
|
protected PrintWriter m_pw;
|
|
private static MimeBase64Encoder m_encoder = new MimeBase64Encoder();
|
|
|
|
/**
|
|
* Constructs an <CODE>LDAPWriter</CODE> object to output entries
|
|
* to a stream.
|
|
*
|
|
* @param pw output stream
|
|
*/
|
|
public LDAPWriter( PrintWriter pw ) {
|
|
m_pw = pw;
|
|
}
|
|
|
|
/**
|
|
* The main method of LDAPWriter. It calls printEntryIntro,
|
|
* printAttribute, and printEntryEnd of derived classes.
|
|
*
|
|
* @param entry an LDAPEntry to be formatted to the output
|
|
* stream
|
|
*/
|
|
public void printEntry( LDAPEntry entry ) throws IOException {
|
|
printEntryStart( entry.getDN() );
|
|
/* Get the attributes of the entry */
|
|
LDAPAttributeSet attrs = entry.getAttributeSet();
|
|
Enumeration enumAttrs = attrs.getAttributes();
|
|
/* Loop on attributes */
|
|
while ( enumAttrs.hasMoreElements() ) {
|
|
LDAPAttribute anAttr =
|
|
(LDAPAttribute)enumAttrs.nextElement();
|
|
printAttribute( anAttr );
|
|
}
|
|
printEntryEnd( entry.getDN() );
|
|
}
|
|
|
|
/**
|
|
* Default schema writer - assumes an ordinary entry
|
|
*
|
|
* @param entry an LDAPEntry containing schema to be formatted
|
|
* to the output stream
|
|
*/
|
|
public void printSchema( LDAPEntry entry ) throws IOException {
|
|
printEntry( entry );
|
|
}
|
|
|
|
/**
|
|
* Print an attribute of an entry
|
|
*
|
|
* @param attr the attribute to format to the output stream
|
|
*/
|
|
protected abstract void printAttribute( LDAPAttribute attr );
|
|
|
|
/**
|
|
* Print prologue to entry
|
|
*
|
|
* @param dn the DN of the entry
|
|
*/
|
|
protected abstract void printEntryStart( String dn );
|
|
|
|
/**
|
|
* Print epilogue to entry
|
|
*
|
|
* @param dn the DN of the entry
|
|
*/
|
|
protected abstract void printEntryEnd( String dn );
|
|
|
|
protected String getPrintableValue( byte[] b ) {
|
|
String s = "";
|
|
ByteBuf inBuf = new ByteBuf( b, 0, b.length );
|
|
ByteBuf encodedBuf = new ByteBuf();
|
|
// Translate to base 64
|
|
m_encoder.translate( inBuf, encodedBuf );
|
|
int nBytes = encodedBuf.length();
|
|
if ( nBytes > 0 ) {
|
|
s = new String(encodedBuf.toBytes(),
|
|
0, nBytes);
|
|
}
|
|
return s;
|
|
}
|
|
}
|