public class CompareRequestDsml extends AbstractResultResponseRequestDsml<CompareRequest,CompareResponse> implements CompareRequest
RESP_TYPE, TYPE
Constructor and Description |
---|
CompareRequestDsml(LdapApiService codec)
Creates a new getDecoratedMessage() of CompareRequestDsml.
|
CompareRequestDsml(LdapApiService codec,
CompareRequest ldapMessage)
Creates a new getDecoratedMessage() of CompareRequestDsml.
|
Modifier and Type | Method and Description |
---|---|
CompareRequest |
addAllControls(Control[] controls)
Adds an array of controls to this Message.
|
CompareRequest |
addControl(Control control)
Adds a control to this Message.
|
Value<?> |
getAssertionValue()
Gets the attribute value to use in making the comparison.
|
String |
getAttributeDesc()
Get the attribute description
|
String |
getAttributeId()
Gets the attribute id use in making the comparison.
|
Dn |
getName()
Get the entry to be compared
|
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.
|
CompareRequest |
removeControl(Control control)
Deletes a control removing it from this Message.
|
CompareRequest |
setAssertionValue(byte[] value)
Sets the attribute value to use in the comparison.
|
void |
setAssertionValue(Object assertionValue)
Set the assertion value
|
CompareRequest |
setAssertionValue(String value)
Sets the attribute value to use in the comparison.
|
void |
setAttributeDesc(String attributeDesc)
Set the attribute description
|
CompareRequest |
setAttributeId(String attrId)
Sets the attribute id used in the comparison.
|
CompareRequest |
setMessageId(int messageId)
Sets the Message ID for this request
|
CompareRequest |
setName(Dn entry)
Set the entry to be compared
|
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
abandon, addAbandonListener, isAbandoned
public CompareRequestDsml(LdapApiService codec)
public CompareRequestDsml(LdapApiService codec, CompareRequest ldapMessage)
ldapMessage
- the message to decoratepublic MessageTypeEnum getType()
getType
in interface Message
getType
in class AbstractDsmlMessageDecorator<CompareRequest>
public org.dom4j.Element toDsml(org.dom4j.Element root)
toDsml
in interface DsmlDecorator<CompareRequest>
toDsml
in class AbstractResultResponseRequestDsml<CompareRequest,CompareResponse>
root
- the root elementpublic Dn getName()
getName
in interface CompareRequest
public CompareRequest setName(Dn entry)
setName
in interface CompareRequest
entry
- The entry to set.public void setAssertionValue(Object assertionValue)
assertionValue
- The assertionValue to set.public String getAttributeDesc()
public void setAttributeDesc(String attributeDesc)
attributeDesc
- The attributeDesc to set.public MessageTypeEnum getResponseType()
getResponseType
in interface SingleReplyRequest<CompareResponse>
public CompareRequest setAssertionValue(String value)
setAssertionValue
in interface CompareRequest
value
- the attribute value used in comparison.public CompareRequest setAssertionValue(byte[] value)
setAssertionValue
in interface CompareRequest
value
- the attribute value used in comparison.public String getAttributeId()
getAttributeId
in interface CompareRequest
public CompareRequest setAttributeId(String attrId)
setAttributeId
in interface CompareRequest
attrId
- the attribute id used in comparison.public Value<?> getAssertionValue()
getAssertionValue
in interface CompareRequest
public CompareRequest setMessageId(int messageId)
setMessageId
in interface CompareRequest
setMessageId
in interface Message
setMessageId
in class AbstractDsmlMessageDecorator<CompareRequest>
messageId
- The message Idpublic CompareRequest addControl(Control control) throws MessageException
addControl
in interface CompareRequest
addControl
in interface Message
addControl
in class AbstractDsmlMessageDecorator<CompareRequest>
control
- the control to add.MessageException
- if controls cannot be added to this Message or the control is
not known etc.public CompareRequest addAllControls(Control[] controls) throws MessageException
addAllControls
in interface CompareRequest
addAllControls
in interface Message
addAllControls
in class AbstractDsmlMessageDecorator<CompareRequest>
controls
- the controls to add.MessageException
- if controls cannot be added to this Message or they are not known etc.public CompareRequest removeControl(Control control) throws MessageException
removeControl
in interface CompareRequest
removeControl
in interface Message
removeControl
in class AbstractDsmlMessageDecorator<CompareRequest>
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.