Interface ExtendedRequest
-
- All Superinterfaces:
Message
,Request
,ResultResponseRequest
,SingleReplyRequest
- All Known Subinterfaces:
CancelRequest
,CertGenerationRequest
,EndTransactionRequest
,GracefulShutdownRequest
,PasswordModifyRequest
,StartTlsRequest
,StartTransactionRequest
,StoredProcedureRequest
,WhoAmIRequest
- All Known Implementing Classes:
AbstractExtendedRequest
,CancelRequestDecorator
,CancelRequestImpl
,CertGenerationRequestDecorator
,CertGenerationRequestImpl
,EndTransactionRequestDecorator
,EndTransactionRequestImpl
,ExtendedRequestDecorator
,ExtendedRequestDsml
,ExtendedRequestImpl
,GracefulShutdownRequestDecorator
,GracefulShutdownRequestImpl
,PasswordModifyRequestDecorator
,PasswordModifyRequestImpl
,StartTlsRequestDecorator
,StartTlsRequestImpl
,StartTransactionRequestDecorator
,StartTransactionRequestImpl
,StoredProcedureRequestDecorator
,StoredProcedureRequestImpl
,WhoAmIRequestDecorator
,WhoAmIRequestImpl
public interface ExtendedRequest extends SingleReplyRequest
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.
- Author:
- Apache Directory Project
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ExtendedRequest
addAllControls(Control[] controls)
Adds an array of controls to this Message.ExtendedRequest
addControl(Control control)
Adds a control to this Message.String
getRequestName()
Gets the Object Identifier corresponding to the extended request type.ExtendedRequest
removeControl(Control control)
Deletes a control removing it from this Message.ExtendedRequest
setMessageId(int messageId)
Sets the Message ID for this requestExtendedRequest
setRequestName(String oid)
Sets the Object Identifier corresponding to the extended request type.-
Methods inherited from interface org.apache.directory.api.ldap.model.message.Message
get, getControl, getControls, getMessageId, getType, hasControl, put
-
Methods inherited from interface org.apache.directory.api.ldap.model.message.Request
hasResponse
-
Methods inherited from interface org.apache.directory.api.ldap.model.message.ResultResponseRequest
getResultResponse
-
Methods inherited from interface org.apache.directory.api.ldap.model.message.SingleReplyRequest
getResponseType
-
-
-
-
Method Detail
-
getRequestName
String getRequestName()
Gets the Object Identifier corresponding to the extended request type. This is the requestName portion of the ExtendedRequst PDU.- Returns:
- the dotted-decimal representation as a String of the OID
-
setRequestName
ExtendedRequest setRequestName(String oid)
Sets the Object Identifier corresponding to the extended request type.- Parameters:
oid
- the dotted-decimal representation as a String of the OID- Returns:
- The ExtendedRequest instance
-
setMessageId
ExtendedRequest setMessageId(int messageId)
Sets the Message ID for this request- Specified by:
setMessageId
in interfaceMessage
- Parameters:
messageId
- The message Id- Returns:
- A Message reference
-
addControl
ExtendedRequest addControl(Control control)
Adds a control to this Message.- Specified by:
addControl
in interfaceMessage
- Parameters:
control
- the control to add.- Returns:
- A Message reference
-
addAllControls
ExtendedRequest addAllControls(Control[] controls)
Adds an array of controls to this Message.- Specified by:
addAllControls
in interfaceMessage
- Parameters:
controls
- the controls to add.- Returns:
- A Message reference
-
removeControl
ExtendedRequest removeControl(Control control)
Deletes a control removing it from this Message.- Specified by:
removeControl
in interfaceMessage
- Parameters:
control
- the control to remove.- Returns:
- A Message reference
-
-