org.apache.directory.shared.ldap.message

Class CompareRequestImpl

java.lang.Object

org.apache.directory.shared.ldap.message.internal.InternalAbstractMessage

org.apache.directory.shared.ldap.message.internal.InternalAbstractRequest

org.apache.directory.shared.ldap.message.AbstractAbandonableRequest

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

All Implemented Interfaces:

InternalAbandonableRequest, InternalCompareRequest, InternalMessage, InternalRequest, InternalResultResponseRequest, SingleReplyRequest

public class CompareRequestImpl
extends AbstractAbandonableRequest
implements InternalCompareRequest

Comparison request implementation.

Version:

$Rev: 928945 $

Author:

Apache Directory Project

Field Summary

Fields inherited from interface org.apache.directory.shared.ldap.message.internal.InternalCompareRequest

RESP_TYPE, TYPE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
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.
InternalResultResponse	getResultResponse() The result containing response for this request.
void	setAssertionValue(byte[] attrVal) Sets the attribute value to use in the comparison.
void	setAssertionValue(String attrVal) Sets the attribute value to use in the comparison.
void	setAttributeId(String attrId) Sets the attribute id used in the comparison.
void	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.shared.ldap.message.AbstractAbandonableRequest

abandon, addAbandonListener, isAbandoned

Methods inherited from class org.apache.directory.shared.ldap.message.internal.InternalAbstractRequest

hashCode, hasResponse

Methods inherited from class org.apache.directory.shared.ldap.message.internal.InternalAbstractMessage

add, addAll, get, getControls, getMessageId, getType, hasControl, put, remove

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.directory.shared.ldap.message.internal.InternalRequest

hasResponse

Methods inherited from interface org.apache.directory.shared.ldap.message.internal.InternalMessage

add, addAll, get, getControls, getMessageId, getType, hasControl, put, remove

Methods inherited from interface org.apache.directory.shared.ldap.message.internal.InternalAbandonableRequest

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 DN getName()

Gets the distinguished name of the entry to be compared using the attribute value assertion.

Specified by:

getName in interface InternalCompareRequest

Returns:

the DN of the compared entry.

setName

public void setName(DN name)

Sets the distinguished name of the entry to be compared using the attribute value assertion.

Specified by:

setName in interface InternalCompareRequest

Parameters:

name - the DN of the compared entry.

getAssertionValue

public Value<?> getAssertionValue()

Gets the attribute value to use in making the comparison.

Specified by:

getAssertionValue in interface InternalCompareRequest

Returns:

the attribute value to used in comparison.

setAssertionValue

public void setAssertionValue(String attrVal)

Sets the attribute value to use in the comparison.

Specified by:

setAssertionValue in interface InternalCompareRequest

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 InternalCompareRequest

Parameters:

attrVal - the attribute value used in comparison.

getAttributeId

public String getAttributeId()

Gets the attribute id use in making the comparison.

Specified by:

getAttributeId in interface InternalCompareRequest

Returns:

the attribute id used in comparison.

setAttributeId

public void setAttributeId(String attrId)

Sets the attribute id used in the comparison.

Specified by:

setAttributeId in interface InternalCompareRequest

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 InternalResultResponse getResultResponse()

The result containing response for this request.

Specified by:

getResultResponse in interface InternalResultResponseRequest

Returns:

the result containing response for this request

equals

public boolean equals(Object obj)

Checks to see if an object is equivalent to this CompareRequest.

Overrides:

equals in class InternalAbstractMessage

Parameters:

obj - the obj to compare with this CompareRequest

Returns:

true if the obj is equal to this request, false otherwise

toString

public String toString()

Get a String representation of a Compare Request

Overrides:

toString in class Object

Returns:

A Compare Request String