com.unboundid.ldap.protocol
Class ExtendedRequestProtocolOp

java.lang.Object
  com.unboundid.ldap.protocol.ExtendedRequestProtocolOp

All Implemented Interfaces:

ProtocolOp, java.io.Serializable

@InternalUseOnly
@NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class ExtendedRequestProtocolOp
extends java.lang.Object
implements ProtocolOp

This class provides an implementation of an LDAP extended request protocol op.

See Also:

Serialized Form

Field Summary

static byte	TYPE_OID The BER type for the OID element.
static byte	TYPE_VALUE The BER type for the value element.

Constructor Summary

ExtendedRequestProtocolOp(java.lang.String oid, ASN1OctetString value)
Creates a new extended request protocol op with the provided information.

Method Summary

java.lang.String	getOID() Retrieves the OID for this extended request.
byte	getProtocolOpType() Retrieves the BER type for this protocol op.
ASN1OctetString	getValue() Retrieves the value for this extended request, if any.
java.lang.String	toString() Retrieves a string representation of this protocol op.
void	toString(java.lang.StringBuilder buffer) Appends a string representation of this LDAP protocol op to the provided buffer.
void	writeTo(ASN1Buffer buffer) Writes an ASN.1-encoded representation of this LDAP protocol op to the provided ASN.1 buffer.

Methods inherited from class java.lang.Object

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

Field Detail

TYPE_OID

public static final byte TYPE_OID

The BER type for the OID element.

See Also:

Constant Field Values

TYPE_VALUE

public static final byte TYPE_VALUE

The BER type for the value element.

See Also:

Constant Field Values

Constructor Detail

ExtendedRequestProtocolOp

public ExtendedRequestProtocolOp(java.lang.String oid,
                                 ASN1OctetString value)

Creates a new extended request protocol op with the provided information.

Parameters:

oid - The OID for this extended request.

value - The value for this extended request, or null if there should not be a value.

Method Detail

getOID

public java.lang.String getOID()

Retrieves the OID for this extended request.

Returns:

The OID for this extended request.

getValue

public ASN1OctetString getValue()

Retrieves the value for this extended request, if any.

Returns:

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

getProtocolOpType

public byte getProtocolOpType()

Retrieves the BER type for this protocol op.

Specified by:

getProtocolOpType in interface ProtocolOp

Returns:

The BER type for this protocol op.

writeTo

public void writeTo(ASN1Buffer buffer)

Writes an ASN.1-encoded representation of this LDAP protocol op to the provided ASN.1 buffer. This method is intended for internal use only and should not be used by third-party code.

Specified by:

writeTo in interface ProtocolOp

Parameters:

buffer - The ASN.1 buffer to which the encoded representation should be written.

toString

public java.lang.String toString()

Retrieves a string representation of this protocol op.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this protocol op.

toString

public void toString(java.lang.StringBuilder buffer)

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

Specified by:

toString in interface ProtocolOp

Parameters:

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