|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.ldap.protocol.IntermediateResponseProtocolOp
@InternalUseOnly public final class IntermediateResponseProtocolOp
This class provides an implementation of an LDAP intermediate response protocol op.
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 | |
---|---|
IntermediateResponseProtocolOp(IntermediateResponse response)
Creates a new intermediate response protocol op from the provided intermediate response object. |
|
IntermediateResponseProtocolOp(java.lang.String oid,
ASN1OctetString value)
Creates a new intermediate response protocol op with the provided information. |
Method Summary | |
---|---|
static IntermediateResponseProtocolOp |
decodeProtocolOp(ASN1Element element)
Decodes the provided ASN.1 element as a intermediate response protocol op. |
ASN1Element |
encodeProtocolOp()
Encodes this protocol op to an ASN.1 element suitable for inclusion in an encoded LDAP message. |
java.lang.String |
getOID()
Retrieves the OID for this intermediate response, if any. |
byte |
getProtocolOpType()
Retrieves the BER type for this protocol op. |
ASN1OctetString |
getValue()
Retrieves the value for this intermediate response, if any. |
IntermediateResponse |
toIntermediateResponse(Control... controls)
Creates a intermediate response from this protocol op. |
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 |
---|
public static final byte TYPE_OID
public static final byte TYPE_VALUE
Constructor Detail |
---|
public IntermediateResponseProtocolOp(java.lang.String oid, ASN1OctetString value)
oid
- The OID for this intermediate response, or null
if
there should not be an OID.value
- The value for this intermediate response, or null
if
there should not be a value.public IntermediateResponseProtocolOp(IntermediateResponse response)
response
- The intermediate response object to use to create this
protocol op.Method Detail |
---|
public java.lang.String getOID()
null
if there
is no response OID.public ASN1OctetString getValue()
null
if there
is no response value.public byte getProtocolOpType()
getProtocolOpType
in interface ProtocolOp
public ASN1Element encodeProtocolOp()
encodeProtocolOp
in interface ProtocolOp
public static IntermediateResponseProtocolOp decodeProtocolOp(ASN1Element element) throws LDAPException
element
- The ASN.1 element to be decoded.
LDAPException
- If the provided ASN.1 element cannot be decoded as
a intermediate response protocol op.public void writeTo(ASN1Buffer buffer)
writeTo
in interface ProtocolOp
buffer
- The ASN.1 buffer to which the encoded representation should
be written.public IntermediateResponse toIntermediateResponse(Control... controls)
controls
- The set of controls to include in the intermediate
response. It may be empty or null
if no controls
should be included.
public java.lang.String toString()
toString
in class java.lang.Object
public void toString(java.lang.StringBuilder buffer)
toString
in interface ProtocolOp
buffer
- The buffer to which the string representation should be
appended.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |