Class CompareRequestImpl
- java.lang.Object
-
- org.apache.directory.api.ldap.model.message.AbstractMessage
-
- org.apache.directory.api.ldap.model.message.AbstractRequest
-
- org.apache.directory.api.ldap.model.message.AbstractAbandonableRequest
-
- org.apache.directory.api.ldap.model.message.CompareRequestImpl
-
- All Implemented Interfaces:
AbandonableRequest
,CompareRequest
,Message
,Request
,ResultResponseRequest
,SingleReplyRequest
public class CompareRequestImpl extends AbstractAbandonableRequest implements CompareRequest
Comparison request implementation.- Author:
- Apache Directory Project
-
-
Constructor Summary
Constructors Constructor Description CompareRequestImpl()
Creates an CompareRequest implementation to compare a named entry with an attribute value assertion pair.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CompareRequest
addAllControls(Control[] controls)
Adds an array of controls to this Message.CompareRequest
addControl(Control control)
Adds a control to this Message.boolean
equals(Object obj)
Checks to see if an object is equivalent to this CompareRequest.Value
getAssertionValue()
Gets the attribute value to use in making the comparison.String
getAttributeId()
Gets the attribute id use in making the comparison.Dn
getName()
Gets the distinguished name of the entry to be compared using the attribute value assertion.MessageTypeEnum
getResponseType()
Gets the protocol response message type for this request which produces at least one response.CompareResponse
getResultResponse()
The result containing response for this request.int
hashCode()
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.CompareRequest
setAssertionValue(String value)
Sets the attribute value to use in the comparison.CompareRequest
setAttributeId(String attributeId)
Sets the attribute id used in the comparison.CompareRequest
setMessageId(int messageId)
Sets the Message ID for this requestCompareRequest
setName(Dn name)
Sets the distinguished name of the entry to be compared using the attribute value assertion.String
toString()
Get a String representation of a Compare Request-
Methods inherited from class org.apache.directory.api.ldap.model.message.AbstractAbandonableRequest
abandon, addAbandonListener, isAbandoned
-
Methods inherited from class org.apache.directory.api.ldap.model.message.AbstractRequest
hasResponse
-
Methods inherited from class org.apache.directory.api.ldap.model.message.AbstractMessage
get, getControl, getControls, getMessageId, getType, hasControl, put, toString
-
Methods inherited from interface org.apache.directory.api.ldap.model.message.AbandonableRequest
abandon, addAbandonListener, isAbandoned
-
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
-
-
-
-
Constructor Detail
-
CompareRequestImpl
public CompareRequestImpl()
Creates an CompareRequest implementation to compare a named entry with an attribute value assertion pair.
-
-
Method Detail
-
getName
public Dn getName()
Gets the distinguished name of the entry to be compared using the attribute value assertion.- Specified by:
getName
in interfaceCompareRequest
- Returns:
- the Dn of the compared entry.
-
setName
public CompareRequest setName(Dn name)
Sets the distinguished name of the entry to be compared using the attribute value assertion.- Specified by:
setName
in interfaceCompareRequest
- Parameters:
name
- the Dn of the compared entry.- Returns:
- The CompareRequest instance
-
getAssertionValue
public Value getAssertionValue()
Gets the attribute value to use in making the comparison.- Specified by:
getAssertionValue
in interfaceCompareRequest
- Returns:
- the attribute value to used in comparison.
-
setAssertionValue
public CompareRequest setAssertionValue(String value)
Sets the attribute value to use in the comparison.- Specified by:
setAssertionValue
in interfaceCompareRequest
- Parameters:
value
- the attribute value used in comparison.- Returns:
- The CompareRequest instance
-
setAssertionValue
public CompareRequest setAssertionValue(byte[] value)
Sets the attribute value to use in the comparison.- Specified by:
setAssertionValue
in interfaceCompareRequest
- Parameters:
value
- the attribute value used in comparison.- Returns:
- The CompareRequest instance
-
getAttributeId
public String getAttributeId()
Gets the attribute id use in making the comparison.- Specified by:
getAttributeId
in interfaceCompareRequest
- Returns:
- the attribute id used in comparison.
-
setAttributeId
public CompareRequest setAttributeId(String attributeId)
Sets the attribute id used in the comparison.- Specified by:
setAttributeId
in interfaceCompareRequest
- Parameters:
attributeId
- the attribute id used in comparison.- Returns:
- The CompareRequest instance
-
setMessageId
public CompareRequest setMessageId(int messageId)
Sets the Message ID for this request- Specified by:
setMessageId
in interfaceCompareRequest
- Specified by:
setMessageId
in interfaceMessage
- Overrides:
setMessageId
in classAbstractMessage
- Parameters:
messageId
- The message Id- Returns:
- A Message reference
-
addControl
public CompareRequest addControl(Control control)
Adds a control to this Message.- Specified by:
addControl
in interfaceCompareRequest
- Specified by:
addControl
in interfaceMessage
- Overrides:
addControl
in classAbstractMessage
- Parameters:
control
- the control to add.- Returns:
- A Message reference
-
addAllControls
public CompareRequest addAllControls(Control[] controls)
Adds an array of controls to this Message.- Specified by:
addAllControls
in interfaceCompareRequest
- Specified by:
addAllControls
in interfaceMessage
- Overrides:
addAllControls
in classAbstractMessage
- Parameters:
controls
- the controls to add.- Returns:
- A Message reference
-
removeControl
public CompareRequest removeControl(Control control)
Deletes a control removing it from this Message.- Specified by:
removeControl
in interfaceCompareRequest
- Specified by:
removeControl
in interfaceMessage
- Overrides:
removeControl
in classAbstractMessage
- Parameters:
control
- the control to remove.- Returns:
- A Message reference
-
getResponseType
public MessageTypeEnum getResponseType()
Gets the protocol response message type for this request which produces at least one response.- Specified by:
getResponseType
in interfaceSingleReplyRequest
- Returns:
- the message type of the response.
-
getResultResponse
public CompareResponse getResultResponse()
The result containing response for this request.- Specified by:
getResultResponse
in interfaceResultResponseRequest
- Returns:
- the result containing response for this request
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classAbstractRequest
- Returns:
- the instance's hash code
- See Also:
Object.hashCode()
-
equals
public boolean equals(Object obj)
Checks to see if an object is equivalent to this CompareRequest.- Overrides:
equals
in classAbstractRequest
- Parameters:
obj
- the obj to compare with this CompareRequest- Returns:
- true if the obj is equal to this request, false otherwise
-
-