Package org.ldaptive

Class SearchResultReference

java.lang.Object

org.ldaptive.AbstractMessage

org.ldaptive.SearchResultReference

All Implemented Interfaces:

Message

public class SearchResultReference
extends AbstractMessage

LDAP search result entry defined as:

   SearchResultReference ::= [APPLICATION 19] SEQUENCE
     SIZE (1..MAX) OF uri URI * 

Author:

Middleware Services

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SearchResultReference.Builder
protected static class	SearchResultReference.ReferralUriHandler	Parse handler implementation for the referral URL.

Nested classes/interfaces inherited from class org.ldaptive.AbstractMessage

AbstractMessage.AbstractBuilder<B,T extends AbstractMessage>, AbstractMessage.ControlParser, AbstractMessage.ControlsHandler, AbstractMessage.MessageIDHandler

Field Summary

Fields

Modifier and Type	Field	Description
static int	PROTOCOL_OP	BER protocol number.

Constructor Summary

Constructors

Constructor	Description
SearchResultReference()	Default constructor.
SearchResultReference(DERBuffer buffer)	Creates a new search result reference.

Method Summary

Modifier and Type	Method	Description
void	addUris(java.lang.String... uri)	Adds a new URI to this reference.
void	addUris(java.util.Collection<java.lang.String> uris)	Adds a new URI to this reference.
static SearchResultReference.Builder	builder()	Creates a builder for this class.
boolean	equals(java.lang.Object o)
java.lang.String[]	getUris()
int	hashCode()	Returns the hash code for this object.
static SearchResultReference	sort(SearchResultReference ref)	Returns a new reference whose URIs are sorted naturally.
java.lang.String	toString()

Methods inherited from class org.ldaptive.AbstractMessage

addControls, copyValues, getControls, getMessageID, setMessageID

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ldaptive.Message

getControl

Field Detail

PROTOCOL_OP

public static final int PROTOCOL_OP

BER protocol number.

See Also:

Constant Field Values

Constructor Detail

SearchResultReference

public SearchResultReference()

Default constructor.

SearchResultReference

public SearchResultReference(DERBuffer buffer)

Creates a new search result reference.

Parameters:

buffer - to decode

Method Detail

getUris

public java.lang.String[] getUris()

addUris

public void addUris(java.lang.String... uri)

Adds a new URI to this reference.

Parameters:

uri - to add

addUris

public void addUris(java.util.Collection<java.lang.String> uris)

Adds a new URI to this reference.

Parameters:

uris - to add

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class AbstractMessage

hashCode

public int hashCode()

Description copied from class: AbstractMessage

Returns the hash code for this object.

Specified by:

hashCode in class AbstractMessage

Returns:

hash code

toString

public java.lang.String toString()

Overrides:

toString in class AbstractMessage

sort

public static SearchResultReference sort(SearchResultReference ref)

Returns a new reference whose URIs are sorted naturally.

Parameters:

ref - reference to sort

Returns:

sorted reference

builder

public static SearchResultReference.Builder builder()

Creates a builder for this class.

Returns:

new builder