Package org.ldaptive

Class SearchEntry

java.lang.Object

org.ldaptive.AbstractLdapBean

org.ldaptive.LdapEntry

org.ldaptive.SearchEntry

All Implemented Interfaces:

Serializable, Message<ResponseControl>, ResponseMessage

public class SearchEntry
extends LdapEntry
implements ResponseMessage

Simple bean representing a search entry.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private static int	HASH_CODE_SEED	hash code seed.
private int	messageId	message ID.
private ResponseControl[]	responseControls	response controls.
private static long	serialVersionUID	serial version uid.

Constructor Summary

Constructors

Constructor	Description
SearchEntry(int id, ResponseControl[] c)	Creates a new search entry.
SearchEntry(int id, ResponseControl[] c, SortBehavior sb)	Creates a new search entry.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
ResponseControl	getControl(String oid)	Returns the first response control with the supplied OID for this response message.
ResponseControl[]	getControls()	Returns the controls for this message.
int	getMessageId()	Returns the message ID for this response message.
int	hashCode()
String	toString()

Methods inherited from class org.ldaptive.LdapEntry

addAttribute, addAttributes, clear, computeModifications, getAttribute, getAttribute, getAttributeNames, getAttributes, getDn, removeAttribute, removeAttribute, removeAttributes, renameAttribute, setDn, size

Methods inherited from class org.ldaptive.AbstractLdapBean

getSortBehavior

Methods inherited from class java.lang.Object

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

Field Detail

HASH_CODE_SEED

private static final int HASH_CODE_SEED

hash code seed.

See Also:

Constant Field Values

serialVersionUID

private static final long serialVersionUID

serial version uid.

See Also:

Constant Field Values

responseControls

private final ResponseControl[] responseControls

response controls.

messageId

private final int messageId

message ID.

Constructor Detail

SearchEntry

public SearchEntry(int id,
                   ResponseControl[] c)

Creates a new search entry.

Parameters:

id - message id

c - response controls

SearchEntry

public SearchEntry(int id,
                   ResponseControl[] c,
                   SortBehavior sb)

Creates a new search entry.

Parameters:

id - message id

c - response controls

sb - sort behavior

Method Detail

getControls

public ResponseControl[] getControls()

Description copied from interface: Message

Returns the controls for this message.

Specified by:

getControls in interface Message<ResponseControl>

Returns:

controls

getControl

public ResponseControl getControl(String oid)

Description copied from interface: ResponseMessage

Returns the first response control with the supplied OID for this response message.

Specified by:

getControl in interface ResponseMessage

Parameters:

oid - of the response control to return

Returns:

response control or null if control could not be found

getMessageId

public int getMessageId()

Description copied from interface: ResponseMessage

Returns the message ID for this response message.

Specified by:

getMessageId in interface ResponseMessage

Returns:

message id

equals

public boolean equals(Object o)

Overrides:

equals in class LdapEntry

hashCode

public int hashCode()

Overrides:

hashCode in class LdapEntry

toString

public String toString()

Overrides:

toString in class LdapEntry