com.novell.ldap.util
Interface LDAPWriter

All Known Implementing Classes:

DOMWriter, DSMLWriter, LDIFWriter

public interface LDAPWriter

Describes the interfaces used by applications to write LDAP messages to an output destination.

See Also:

LDAPReader

Method Summary

void	finish() Writes any remaining data to the output destination.
java.lang.String	getVersion() Returns the version of data that will be writen to the output destination.
boolean	isRequest() Returns the type of data to write to the output destination, true if request data, or false if result data.
void	writeComments(java.lang.String comments) Writes an comments to the output destination.
void	writeEntry(LDAPEntry entry) Writes an LDAPEntry to the output destination.
void	writeEntry(LDAPEntry entry, LDAPControl[] controls) Writes an LDAPEntry to the output destination.
void	writeError(java.lang.Exception e) Writes an Exception to the output destination.
void	writeMessage(LDAPMessage message) Writes an LDAPMessage to the output destination.

Method Detail

getVersion

public java.lang.String getVersion()

Returns the version of data that will be writen to the output destination.

Returns:

the data version as a String value.

isRequest

public boolean isRequest()

Returns the type of data to write to the output destination, true if request data, or false if result data.

Returns:

true if the data type is request data.

writeMessage

public void writeMessage(LDAPMessage message)
                  throws java.io.IOException,
                         LDAPException

Writes an LDAPMessage to the output destination.

Parameters:

message - the LDAPMesssage to write.

Throws:

java.io.IOException - if an I/O error occurs.

LDAPException - for exceptions from LDAP

writeEntry

public void writeEntry(LDAPEntry entry)
                throws java.io.IOException,
                       LDAPException

Writes an LDAPEntry to the output destination.

Parameters:

entry - the LDAPEntry to write.

Throws:

java.io.IOException

LDAPException

writeEntry

public void writeEntry(LDAPEntry entry,
                       LDAPControl[] controls)
                throws java.io.IOException,
                       LDAPException

Writes an LDAPEntry to the output destination.

Parameters:

entry - the LDAPEntry to write.

controls - any controls associated with the entry

Throws:

java.io.IOException - if an I/O error occurs.

LDAPException - for exceptions from LDAP

writeComments

public void writeComments(java.lang.String comments)
                   throws java.io.IOException

Writes an comments to the output destination.

Parameters:

comments - The comments to write

Throws:

java.io.IOException

writeError

public void writeError(java.lang.Exception e)
                throws java.io.IOException

Writes an Exception to the output destination.

Parameters:

e - Exception to be written.

Throws:

java.io.IOException

finish

public void finish()
            throws java.io.IOException

Writes any remaining data to the output destination.

Throws:

java.io.IOException