Package org.apache.directory.api.ldap.model.message

Class AbstractRequest

java.lang.Object

org.apache.directory.api.ldap.model.message.AbstractMessage

org.apache.directory.api.ldap.model.message.AbstractRequest

All Implemented Interfaces:

Message, Request

Direct Known Subclasses:

AbandonRequestImpl, AbstractAbandonableRequest, AbstractExtendedRequest, UnbindRequestImpl

public abstract class AbstractRequest
extends AbstractMessage
implements Request

The base request message class.

Author:

Apache Directory Project

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static long	serialVersionUID

Fields inherited from class org.apache.directory.api.ldap.model.message.AbstractMessage

controls

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractRequest(int id, MessageTypeEnum type, boolean hasResponse)	Subclasses must provide these parameters via a super constructor call.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)	Checks to see if two messages are equivalent.
int	hashCode()
boolean	hasResponse()	Indicator flag used to determine whether or not this type of request produces a reply.

Methods inherited from class org.apache.directory.api.ldap.model.message.AbstractMessage

addAllControls, addControl, get, getControl, getControls, getMessageId, getType, hasControl, put, removeControl, setMessageId, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.directory.api.ldap.model.message.Message

addAllControls, addControl, get, getControl, getControls, getMessageId, getType, hasControl, put, removeControl, setMessageId

Field Detail

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

AbstractRequest

protected AbstractRequest(int id,
                          MessageTypeEnum type,
                          boolean hasResponse)

Subclasses must provide these parameters via a super constructor call.

Parameters:

id - the sequential message identifier

type - the request type enum

hasResponse - flag indicating if this request generates a response

Method Detail

hasResponse

public boolean hasResponse()

Indicator flag used to determine whether or not this type of request produces a reply.

Specified by:

hasResponse in interface Request

Returns:

true if any reply is generated, false if no response is generated

equals

public boolean equals(Object obj)

Checks to see if two messages are equivalent. Messages equivalence does not factor in parameters accessible through the get() and put() operations, nor do they factor in the Lockable properties of the Message. Only the type, controls, and the messageId are evaluated for equality.

Overrides:

equals in class AbstractMessage

Parameters:

obj - the object to compare this Message to for equality

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractMessage

Returns:

the instance's hash code

See Also:

Object.hashCode()