org.opends.server.protocols.ldap
Class ExtendedRequestProtocolOp

java.lang.Object
  extended by org.opends.server.protocols.ldap.ProtocolOp
      extended by 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
ExtendedRequestProtocolOp(java.lang.String oid)
          Creates a new extended request protocol op with the specified OID and no value.
ExtendedRequestProtocolOp(java.lang.String oid, ASN1OctetString value)
          Creates a new extended request protocol op with the specified OID and value.
 
Method Summary
static ExtendedRequestProtocolOp decodeExtendedRequest(ASN1Element element)
          Decodes the provided ASN.1 element as an LDAP extended request protocol op.
 ASN1Element encode()
          Encodes this protocol op to an ASN.1 element suitable for including in an LDAP message.
 java.lang.String getOID()
          Retrieves the OID for this extended request.
 java.lang.String getProtocolOpName()
          Retrieves the name for this protocol op type.
 byte getType()
          Retrieves the BER type for this protocol op.
 ASN1OctetString getValue()
          Retrieves the value for this extended request.
 void setOID(java.lang.String oid)
          Specifies the OID for this extended request.
 void setValue(ASN1OctetString value)
          Specifies the value for this extended request.
 void toString(java.lang.StringBuilder buffer)
          Appends a string representation of this LDAP protocol op to the provided buffer.
 void toString(java.lang.StringBuilder buffer, int indent)
          Appends a multi-line string representation of this LDAP protocol op to the provided buffer.
 
Methods inherited from class org.opends.server.protocols.ldap.ProtocolOp
decode, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ExtendedRequestProtocolOp

public ExtendedRequestProtocolOp(java.lang.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(java.lang.String oid,
                                 ASN1OctetString 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 java.lang.String getOID()
Retrieves the OID for this extended request.

Returns:
The OID for this extended request.

setOID

public void setOID(java.lang.String oid)
Specifies the OID for this extended request.

Parameters:
oid - The OID for this extended request.

getValue

public ASN1OctetString getValue()
Retrieves the value for this extended request.

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

setValue

public void setValue(ASN1OctetString value)
Specifies the value for this extended request.

Parameters:
value - The value for this extended request.

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 java.lang.String getProtocolOpName()
Retrieves the name for this protocol op type.

Specified by:
getProtocolOpName in class ProtocolOp
Returns:
The name for this protocol op type.

encode

public ASN1Element encode()
Encodes this protocol op to an ASN.1 element suitable for including in an LDAP message.

Specified by:
encode in class ProtocolOp
Returns:
The ASN.1 element containing the encoded protocol op.

decodeExtendedRequest

public static ExtendedRequestProtocolOp decodeExtendedRequest(ASN1Element element)
                                                       throws LDAPException
Decodes the provided ASN.1 element as an LDAP extended request protocol op.

Parameters:
element - The ASN.1 element to be decoded.
Returns:
The decoded extended request protocol op.
Throws:
LDAPException - If a problem occurs while attempting to decode the provided ASN.1 element as an LDAP extended request 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 class ProtocolOp
Parameters:
buffer - The buffer to which the string should be appended.

toString

public void toString(java.lang.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.