public abstract class AbstractExtendedRequest<R extends ExtendedResponse> extends AbstractRequest implements ExtendedRequest<R>
Modifier and Type | Field and Description |
---|---|
protected R |
response
The associated response
|
controls
RESP_TYPE, TYPE
Constructor and Description |
---|
AbstractExtendedRequest()
Creates an ExtendedRequest implementing object used to perform
extended protocol operation on the server.
|
AbstractExtendedRequest(int id)
Creates an ExtendedRequest implementing object used to perform
extended protocol operation on the server.
|
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.
|
boolean |
equals(Object obj)
Checks to see if an object equals this ExtendedRequest.
|
String |
getRequestName()
Gets the Object Identifier corresponding to the extended request type.
|
MessageTypeEnum |
getResponseType()
Gets the protocol response message type for this request which produces
at least one response.
|
abstract R |
getResultResponse()
The result containing response for this request.
|
int |
hashCode() |
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 newOid)
Sets the Object Identifier corresponding to the extended request type.
|
String |
toString()
Get a String representation of an Extended Request
|
hasResponse
get, getControl, getControls, getMessageId, getType, hasControl, put, toString
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
hasResponse
get, getControl, getControls, getMessageId, getType, hasControl, put
protected R extends ExtendedResponse response
public AbstractExtendedRequest()
public AbstractExtendedRequest(int id)
id
- the sequential message identifierpublic String getRequestName()
getRequestName
in interface ExtendedRequest<R extends ExtendedResponse>
public ExtendedRequest<R> setRequestName(String newOid)
setRequestName
in interface ExtendedRequest<R extends ExtendedResponse>
newOid
- the dotted-decimal representation as a String of the OIDpublic ExtendedRequest<R> setMessageId(int messageId)
setMessageId
in interface ExtendedRequest<R extends ExtendedResponse>
setMessageId
in interface Message
setMessageId
in class AbstractMessage
messageId
- The message Idpublic ExtendedRequest<R> addControl(Control control) throws MessageException
addControl
in interface ExtendedRequest<R extends ExtendedResponse>
addControl
in interface Message
addControl
in class AbstractMessage
control
- the control to add.MessageException
- if controls cannot be added to this Message or the control is
not known etc.public ExtendedRequest<R> addAllControls(Control[] controls) throws MessageException
addAllControls
in interface ExtendedRequest<R extends ExtendedResponse>
addAllControls
in interface Message
addAllControls
in class AbstractMessage
controls
- the controls to add.MessageException
- if controls cannot be added to this Message or they are not known etc.public ExtendedRequest<R> removeControl(Control control) throws MessageException
removeControl
in interface ExtendedRequest<R extends ExtendedResponse>
removeControl
in interface Message
removeControl
in class AbstractMessage
control
- the control to remove.MessageException
- if controls cannot be added to this Message or the control is
not known etc.public MessageTypeEnum getResponseType()
getResponseType
in interface SingleReplyRequest<R extends ExtendedResponse>
public abstract R getResultResponse()
getResultResponse
in interface ResultResponseRequest<R extends ExtendedResponse>
public int hashCode()
hashCode
in class AbstractRequest
Object.hashCode()
public boolean equals(Object obj)
equals
in class AbstractRequest
obj
- the object to be checked for equalityCopyright © 2003-2014 The Apache Software Foundation. All Rights Reserved.