public interface ExtendedRequest<R extends ExtendedResponse> extends SingleReplyRequest<R>
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.
Modifier and Type | Field and Description |
---|---|
static MessageTypeEnum |
RESP_TYPE
Extended response message type enumeration value
|
static MessageTypeEnum |
TYPE
Extended request message type enumeration value
|
Modifier and Type | Method and Description |
---|---|
ExtendedRequest<R> |
addAllControls(Control[] controls)
Adds an array of controls to this Message.
|
ExtendedRequest<R> |
addControl(Control control)
Adds a control to this Message.
|
String |
getRequestName()
Gets the Object Identifier corresponding to the extended request type.
|
ExtendedRequest<R> |
removeControl(Control control)
Deletes a control removing it from this Message.
|
ExtendedRequest<R> |
setMessageId(int messageId)
Sets the Message ID for this request
|
ExtendedRequest<R> |
setRequestName(String oid)
Sets the Object Identifier corresponding to the extended request type.
|
getResponseType
getResultResponse
hasResponse
get, getControl, getControls, getMessageId, getType, hasControl, put
static final MessageTypeEnum TYPE
static final MessageTypeEnum RESP_TYPE
String getRequestName()
ExtendedRequest<R> setRequestName(String oid)
oid
- the dotted-decimal representation as a String of the OIDExtendedRequest<R> setMessageId(int messageId)
setMessageId
in interface Message
messageId
- The message IdExtendedRequest<R> addControl(Control control) throws MessageException
addControl
in interface Message
control
- the control to add.MessageException
- if controls cannot be added to this Message or the control is
not known etc.ExtendedRequest<R> addAllControls(Control[] controls) throws MessageException
addAllControls
in interface Message
controls
- the controls to add.MessageException
- if controls cannot be added to this Message or they are not known etc.ExtendedRequest<R> removeControl(Control control) throws MessageException
removeControl
in interface Message
control
- the control to remove.MessageException
- if controls cannot be added to this Message or the control is
not known etc.Copyright © 2003-2014 The Apache Software Foundation. All Rights Reserved.