|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opends.server.protocols.ldap.ProtocolOp
org.opends.server.protocols.ldap.ExtendedRequestProtocolOp
public class ExtendedRequestProtocolOp
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 |
---|
public ExtendedRequestProtocolOp(java.lang.String oid)
oid
- The OID for this extended request.public ExtendedRequestProtocolOp(java.lang.String oid, ASN1OctetString value)
oid
- The OID for this extended request.value
- The value for this extended request.Method Detail |
---|
public java.lang.String getOID()
public void setOID(java.lang.String oid)
oid
- The OID for this extended request.public ASN1OctetString getValue()
null
if there
is no value.public void setValue(ASN1OctetString value)
value
- The value for this extended request.public byte getType()
getType
in class ProtocolOp
public java.lang.String getProtocolOpName()
getProtocolOpName
in class ProtocolOp
public ASN1Element encode()
encode
in class ProtocolOp
public static ExtendedRequestProtocolOp decodeExtendedRequest(ASN1Element element) throws LDAPException
element
- The ASN.1 element to be decoded.
LDAPException
- If a problem occurs while attempting to decode the
provided ASN.1 element as an LDAP extended request
protocol op.public void toString(java.lang.StringBuilder buffer)
toString
in class ProtocolOp
buffer
- The buffer to which the string should be appended.public void toString(java.lang.StringBuilder buffer, int indent)
toString
in class ProtocolOp
buffer
- The buffer to which the information should be appended.indent
- The number of spaces from the margin that the lines should
be indented.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |