org.ldaptive
Class SearchReference

java.lang.Object
  org.ldaptive.SearchReference

All Implemented Interfaces:

Message<ResponseControl>, ResponseMessage

public class SearchReference
extends Object
implements ResponseMessage

Simple bean representing a search reference.

Version:

$Revision: 2885 $ $Date: 2014-02-05 16:28:49 -0500 (Wed, 05 Feb 2014) $

Author:

Middleware Services

Constructor Summary

SearchReference(int id, ResponseControl[] c, Collection<String> urls)
Creates a search reference.

SearchReference(int id, ResponseControl[] c, String... url)
Creates a search reference.

Method Summary

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.
String[]	getReferralUrls() Returns the referral urls for this search reference.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchReference

public SearchReference(int id,
                       ResponseControl[] c,
                       String... url)

Creates a search reference.

Parameters:

id - message id

c - response controls

url - referral urls

SearchReference

public SearchReference(int id,
                       ResponseControl[] c,
                       Collection<String> urls)

Creates a search reference.

Parameters:

id - message id

c - response controls

urls - referral urls

Method Detail

getReferralUrls

public String[] getReferralUrls()

Returns the referral urls for this search reference.

Returns:

referral urls

getControls

public ResponseControl[] getControls()

Returns the controls for this message.

Specified by:

getControls in interface Message<ResponseControl>

Returns:

controls

getControl

public ResponseControl getControl(String oid)

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

Returns the message ID for this response message.

Specified by:

getMessageId in interface ResponseMessage

Returns:

message id

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object