org.apache.directory.shared.ldap.message
Class CompareRequestImpl

java.lang.Object
  extended byorg.apache.directory.shared.ldap.message.AbstractMessage
      extended byorg.apache.directory.shared.ldap.message.AbstractRequest
          extended byorg.apache.directory.shared.ldap.message.AbstractAbandonableRequest
              extended byorg.apache.directory.shared.ldap.message.CompareRequestImpl
All Implemented Interfaces:
AbandonableRequest, CompareRequest, Message, Request, ResultResponseRequest, SingleReplyRequest

public class CompareRequestImpl
extends AbstractAbandonableRequest
implements CompareRequest

Lockable comparison request implementation.

Version:
$Rev: 379008 $
Author:
Apache Directory Project

Field Summary
 
Fields inherited from interface org.apache.directory.shared.ldap.message.CompareRequest
RESP_TYPE, TYPE
 
Constructor Summary
CompareRequestImpl(int id)
          Creates an CompareRequest implementation to compare a named entry with an attribute value assertion pair.
 
Method Summary
 boolean equals(java.lang.Object obj)
          Checks to see if an object is equivalent to this CompareRequest.
 byte[] getAssertionValue()
          Gets the attribute value to use in making the comparison.
 java.lang.String getAttributeId()
          Gets the attribute id use in making the comparison.
 java.lang.String 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.
 ResultResponse getResultResponse()
          The result containing response for this request.
 void setAssertionValue(byte[] attrVal)
          Sets the attribute value to use in the comparison.
 void setAssertionValue(java.lang.String attrVal)
          Sets the attribute value to use in the comparison.
 void setAttributeId(java.lang.String attrId)
          Sets the attribute id used in the comparison.
 void setName(java.lang.String name)
          Sets the distinguished name of the entry to be compared using the attribute value assertion.
 java.lang.String toString()
          Get a String representation of a Compare Request
 
Methods inherited from class org.apache.directory.shared.ldap.message.AbstractAbandonableRequest
abandon, addAbandonListener, isAbandoned
 
Methods inherited from class org.apache.directory.shared.ldap.message.AbstractRequest
hasResponse
 
Methods inherited from class org.apache.directory.shared.ldap.message.AbstractMessage
add, get, getControls, getMessageId, getType, put, remove
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.apache.directory.shared.ldap.message.Request
hasResponse
 
Methods inherited from interface org.apache.directory.shared.ldap.message.Message
add, get, getControls, getMessageId, getType, put, remove
 
Methods inherited from interface org.apache.directory.shared.ldap.message.AbandonableRequest
abandon, addAbandonListener, isAbandoned
 

Constructor Detail

CompareRequestImpl

public CompareRequestImpl(int id)
Creates an CompareRequest implementation to compare a named entry with an attribute value assertion pair.

Parameters:
id - the sequence identifier of the CompareRequest message.
Method Detail

getName

public java.lang.String getName()
Gets the distinguished name of the entry to be compared using the attribute value assertion.

Specified by:
getName in interface CompareRequest
Returns:
the DN of the compared entry.

setName

public void setName(java.lang.String name)
Sets the distinguished name of the entry to be compared using the attribute value assertion.

Specified by:
setName in interface CompareRequest
Parameters:
name - the DN of the compared entry.

getAssertionValue

public byte[] getAssertionValue()
Gets the attribute value to use in making the comparison.

Specified by:
getAssertionValue in interface CompareRequest
Returns:
the attribute value to used in comparison.

setAssertionValue

public void setAssertionValue(java.lang.String attrVal)
Sets the attribute value to use in the comparison.

Specified by:
setAssertionValue in interface CompareRequest
Parameters:
attrVal - the attribute value used in comparison.

setAssertionValue

public void setAssertionValue(byte[] attrVal)
Sets the attribute value to use in the comparison.

Specified by:
setAssertionValue in interface CompareRequest
Parameters:
attrVal - the attribute value used in comparison.

getAttributeId

public java.lang.String getAttributeId()
Gets the attribute id use in making the comparison.

Specified by:
getAttributeId in interface CompareRequest
Returns:
the attribute id used in comparison.

setAttributeId

public void setAttributeId(java.lang.String attrId)
Sets the attribute id used in the comparison.

Specified by:
setAttributeId in interface CompareRequest
Parameters:
attrId - the attribute id used in comparison.

getResponseType

public MessageTypeEnum getResponseType()
Gets the protocol response message type for this request which produces at least one response.

Specified by:
getResponseType in interface SingleReplyRequest
Returns:
the message type of the response.

getResultResponse

public ResultResponse getResultResponse()
The result containing response for this request.

Specified by:
getResultResponse in interface ResultResponseRequest
Returns:
the result containing response for this request

equals

public boolean equals(java.lang.Object obj)
Checks to see if an object is equivalent to this CompareRequest.

Overrides:
equals in class AbstractMessage
Parameters:
obj - the obj to compare with this CompareRequest
Returns:
true if the obj is equal to this request, false otherwise

toString

public java.lang.String toString()
Get a String representation of a Compare Request

Returns:
A Compare Request String


Copyright © 2003-2006 . All Rights Reserved.