org.apache.directory.shared.ldap.message
Interface InternalExtendedRequest

All Superinterfaces:

javax.naming.ldap.ExtendedRequest, InternalMessage, InternalRequest, InternalResultResponseRequest, java.io.Serializable, SingleReplyRequest

All Known Implementing Classes:

CancelRequest, CertGenerationRequest, ExtendedRequestImpl, GracefulShutdownRequest, LaunchDiagnosticUiRequest, StoredProcedureRequest

public interface InternalExtendedRequest
extends SingleReplyRequest, javax.naming.ldap.ExtendedRequest

Extended protocol request message used to add to more operations to the protocol. Here's what RFC 2251 says about it:

  4.12. Extended Operation
 
   An extension mechanism has been added in this version of LDAP, in
   order to allow additional operations to be defined for services not
   available elsewhere in this protocol, for instance digitally signed
   operations and results.
 
   The extended operation allows clients to make requests and receive
   responses with predefined syntaxes and semantics.  These may be
   defined in RFCs or be private to particular implementations.  Each
   request MUST have a unique OBJECT IDENTIFIER assigned to it.
 
        ExtendedRequest ::= [APPLICATION 23] SEQUENCE {
                requestName      [0] LDAPOID,
                requestValue     [1] OCTET STRING OPTIONAL }
 
   The requestName is a dotted-decimal representation of the OBJECT
   IDENTIFIER corresponding to the request. The requestValue is
   information in a form defined by that request, encapsulated inside an
   OCTET STRING.
  <pre>
 





Version:
  
$Revision: 764131 $
Author:
  
Apache Directory Project







Field Summary




static MessageTypeEnum
RESP_TYPE



          Extended response message type enumeration value



static MessageTypeEnum
TYPE



          Extended request message type enumeration value


 



Method Summary




 java.lang.String
getOid()



          Gets the Object Idendifier corresponding to the extended request type.



 byte[]
getPayload()



          Gets the extended request's requestValue portion of the PDU.



 void
setOid(java.lang.String oid)



          Sets the Object Idendifier corresponding to the extended request type.



 void
setPayload(byte[] payload)



          Sets the extended request's requestValue portion of the PDU.


 
Methods inherited from interface org.apache.directory.shared.ldap.message.SingleReplyRequest
getResponseType
 
Methods inherited from interface org.apache.directory.shared.ldap.message.InternalResultResponseRequest
getResultResponse
 
Methods inherited from interface org.apache.directory.shared.ldap.message.InternalRequest
hasResponse
 
Methods inherited from interface org.apache.directory.shared.ldap.message.InternalMessage
add, addAll, get, getControls, getMessageId, getType, hasControl, put, remove
 
Methods inherited from interface javax.naming.ldap.ExtendedRequest
createExtendedResponse, getEncodedValue, getID
 





Field Detail



TYPE
static final MessageTypeEnum TYPE

Extended request message type enumeration value







RESP_TYPE
static final MessageTypeEnum RESP_TYPE

Extended response message type enumeration value








Method Detail



getOid
java.lang.String getOid()

Gets the Object Idendifier corresponding to the extended request type.
 This is the requestName portion of the ext. req. PDU.






Returns:
the dotted-decimal representation as a String of the OID





setOid
void setOid(java.lang.String oid)

Sets the Object Idendifier corresponding to the extended request type.





Parameters:
oid - the dotted-decimal representation as a String of the OID





getPayload
byte[] getPayload()

Gets the extended request's requestValue portion of the PDU. The
 form of the data is request specific and is determined by the extended
 request OID.






Returns:
byte array of data





setPayload
void setPayload(byte[] payload)

Sets the extended request's requestValue portion of the PDU.





Parameters:
payload - byte array of data encapsulating ext. req. parameters