Package org.opends.server.protocols.ldap

Class ExtendedRequestProtocolOp

java.lang.Object

org.opends.server.protocols.ldap.ProtocolOp

org.opends.server.protocols.ldap.ExtendedRequestProtocolOp

public class ExtendedRequestProtocolOp
extends ProtocolOp

This class defines the structures and methods for an LDAP extended request protocol op, which is used to request some special type of processing defined in an extension to the LDAP protocol.

Constructor Summary

Constructors

Constructor	Description
ExtendedRequestProtocolOp(String oid)	Creates a new extended request protocol op with the specified OID and no value.
ExtendedRequestProtocolOp(String oid, ByteString value)	Creates a new extended request protocol op with the specified OID and value.

Method Summary

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

Methods inherited from class org.opends.server.protocols.ldap.ProtocolOp

toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ExtendedRequestProtocolOp

public ExtendedRequestProtocolOp(String oid)

Creates a new extended request protocol op with the specified OID and no value.

Parameters:

oid - The OID for this extended request.

ExtendedRequestProtocolOp

public ExtendedRequestProtocolOp(String oid,
                                 ByteString value)

Creates a new extended request protocol op with the specified OID and value.

Parameters:

oid - The OID for this extended request.

value - The value for this extended request.

Method Detail

getOID

public String getOID()

Retrieves the OID for this extended request.

Returns:

The OID for this extended request.

getValue

public ByteString getValue()

Retrieves the value for this extended request.

Returns:

The value for this extended request, or null if there is no value.

getType

public byte getType()

Retrieves the BER type for this protocol op.

Specified by:

getType in class ProtocolOp

Returns:

The BER type for this protocol op.

getProtocolOpName

public String getProtocolOpName()

Retrieves the name for this protocol op type.

Specified by:

getProtocolOpName in class ProtocolOp

Returns:

The name for this protocol op type.

write

public void write(ASN1Writer stream)
           throws IOException

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

Specified by:

write in class ProtocolOp

Parameters:

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

Throws:

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

toString

public void toString(StringBuilder buffer)

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

Specified by:

toString in class ProtocolOp

Parameters:

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

toString

public void toString(StringBuilder buffer,
                     int indent)

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

Specified by:

toString in class ProtocolOp

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.