public class ExtendedRequestDsml<Q extends ExtendedRequest<P>,P extends ExtendedResponse> extends AbstractResultResponseRequestDsml<Q,P> implements ExtendedRequest<P>
RESP_TYPE, TYPE
Constructor and Description |
---|
ExtendedRequestDsml(LdapApiService codec,
Q ldapMessage)
Creates a new getDecoratedMessage() of ExtendedRequestDsml.
|
Modifier and Type | Method and Description |
---|---|
ExtendedRequest<P> |
addAllControls(Control[] controls)
Adds an array of controls to this Message.
|
ExtendedRequest<P> |
addControl(Control control)
Adds a control to this Message.
|
String |
getRequestName()
Get the extended request name
|
byte[] |
getRequestValue()
Get the extended request value
|
MessageTypeEnum |
getResponseType()
Gets the protocol response message type for this request which produces
at least one response.
|
MessageTypeEnum |
getType()
Gets the LDAP message type code associated with this Message.
|
ExtendedRequest<P> |
removeControl(Control control)
Deletes a control removing it from this Message.
|
ExtendedRequest<P> |
setMessageId(int messageId)
Sets the Message ID for this request
|
void |
setRequestName(Oid requestName)
Set the extended request name
|
ExtendedRequest<P> |
setRequestName(String oid)
Sets the Object Identifier corresponding to the extended request type.
|
void |
setRequestValue(byte[] requestValue)
Set the extended request value
|
org.dom4j.Element |
toDsml(org.dom4j.Element root)
Creates the Request Element and adds RequestID and Controls.
|
abandon, addAbandonListener, computeLength, encode, getResultResponse, isAbandoned
hasResponse
get, getCodecService, getControl, getControls, getCurrentControl, getDecorated, getMessageId, hasControl, put
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getResultResponse
hasResponse
get, getControl, getControls, getMessageId, hasControl, put
public ExtendedRequestDsml(LdapApiService codec, Q ldapMessage)
ldapMessage
- the message to decoratepublic MessageTypeEnum getType()
getType
in interface Message
getType
in class AbstractDsmlMessageDecorator<Q extends ExtendedRequest<P>>
public org.dom4j.Element toDsml(org.dom4j.Element root)
toDsml
in interface DsmlDecorator<Q extends ExtendedRequest<P>>
toDsml
in class AbstractResultResponseRequestDsml<Q extends ExtendedRequest<P>,P extends ExtendedResponse>
root
- the root elementpublic String getRequestName()
getRequestName
in interface ExtendedRequest<P extends ExtendedResponse>
public void setRequestName(Oid requestName)
requestName
- The request name to set.public byte[] getRequestValue()
public void setRequestValue(byte[] requestValue)
requestValue
- The request value to set.public MessageTypeEnum getResponseType()
getResponseType
in interface SingleReplyRequest<P extends ExtendedResponse>
public ExtendedRequest<P> setRequestName(String oid)
setRequestName
in interface ExtendedRequest<P extends ExtendedResponse>
oid
- the dotted-decimal representation as a String of the OIDpublic ExtendedRequest<P> setMessageId(int messageId)
setMessageId
in interface ExtendedRequest<P extends ExtendedResponse>
setMessageId
in interface Message
setMessageId
in class AbstractDsmlMessageDecorator<Q extends ExtendedRequest<P>>
messageId
- The message Idpublic ExtendedRequest<P> addControl(Control control) throws MessageException
addControl
in interface ExtendedRequest<P extends ExtendedResponse>
addControl
in interface Message
addControl
in class AbstractDsmlMessageDecorator<Q extends ExtendedRequest<P>>
control
- the control to add.MessageException
- if controls cannot be added to this Message or the control is
not known etc.public ExtendedRequest<P> addAllControls(Control[] controls) throws MessageException
addAllControls
in interface ExtendedRequest<P extends ExtendedResponse>
addAllControls
in interface Message
addAllControls
in class AbstractDsmlMessageDecorator<Q extends ExtendedRequest<P>>
controls
- the controls to add.MessageException
- if controls cannot be added to this Message or they are not known etc.public ExtendedRequest<P> removeControl(Control control) throws MessageException
removeControl
in interface ExtendedRequest<P extends ExtendedResponse>
removeControl
in interface Message
removeControl
in class AbstractDsmlMessageDecorator<Q extends ExtendedRequest<P>>
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.