Package org.opends.server.protocols.ldap

Class ProtocolOp

java.lang.Object

org.opends.server.protocols.ldap.ProtocolOp

Direct Known Subclasses:

AbandonRequestProtocolOp, AddRequestProtocolOp, AddResponseProtocolOp, BindRequestProtocolOp, BindResponseProtocolOp, CompareRequestProtocolOp, CompareResponseProtocolOp, DeleteRequestProtocolOp, DeleteResponseProtocolOp, ExtendedRequestProtocolOp, ExtendedResponseProtocolOp, IntermediateResponseProtocolOp, ModifyDNRequestProtocolOp, ModifyDNResponseProtocolOp, ModifyRequestProtocolOp, ModifyResponseProtocolOp, SearchRequestProtocolOp, SearchResultDoneProtocolOp, SearchResultEntryProtocolOp, SearchResultReferenceProtocolOp, UnbindRequestProtocolOp

public abstract class ProtocolOp
extends Object

This class defines the structures and methods for an LDAP protocol op, which is the core of an LDAP message.

Constructor Summary

Constructors

Constructor	Description
ProtocolOp()

Method Summary

Modifier and Type	Method	Description
abstract String	getProtocolOpName()	Retrieves the name for this protocol op type.
abstract byte	getType()	Retrieves the BER type for this protocol op.
String	toString()	Retrieves a string representation of this LDAP protocol op.
abstract void	toString(StringBuilder buffer)	Appends a string representation of this LDAP protocol op to the provided buffer.
abstract void	toString(StringBuilder buffer, int indent)	Appends a multi-line string representation of this LDAP protocol op to the provided buffer.
abstract void	write(ASN1Writer stream)	Writes this protocol op to an ASN.1 output stream.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ProtocolOp

public ProtocolOp()

Method Detail

getType

public abstract byte getType()

Retrieves the BER type for this protocol op.

Returns:

The BER type for this protocol op.

getProtocolOpName

public abstract String getProtocolOpName()

Retrieves the name for this protocol op type.

Returns:

The name for this protocol op type.

write

public abstract void write(ASN1Writer stream)
                    throws IOException

Writes this protocol op to an ASN.1 output stream.

Parameters:

stream - The ASN.1 output stream to write to.

Throws:

IOException - If a problem occurs while writing to the stream.

toString

public String toString()

Retrieves a string representation of this LDAP protocol op.

Overrides:

toString in class Object

Returns:

A string representation of this LDAP protocol op.

toString

public abstract void toString(StringBuilder buffer)

Appends a string representation of this LDAP protocol op to the provided buffer.

Parameters:

buffer - The buffer to which the string should be appended.

toString

public abstract void toString(StringBuilder buffer,
                              int indent)

Appends a multi-line string representation of this LDAP protocol op to the provided buffer.

Parameters:

buffer - The buffer to which the information should be appended.

indent - The number of spaces from the margin that the lines should be indented.