Package org.ldaptive.control

Class SortRequestControl

java.lang.Object

org.ldaptive.control.AbstractControl

org.ldaptive.control.SortRequestControl

All Implemented Interfaces:

Control, RequestControl

public class SortRequestControl
extends AbstractControl
implements RequestControl

Request control for server side sorting. See RFC 2891. Control is defined as:

   SortKeyList ::= SEQUENCE OF SEQUENCE {
      attributeType   AttributeDescription,
      orderingRule    [0] MatchingRuleId OPTIONAL,
      reverseOrder    [1] BOOLEAN DEFAULT FALSE }
 

Field Summary

Fields

Modifier and Type	Field	Description
private static int	HASH_CODE_SEED	hash code seed.
static String	OID	OID of this control.
private SortKey[]	sortKeys	sort keys.

Fields inherited from class org.ldaptive.control.AbstractControl

logger

Constructor Summary

Constructors

Constructor	Description
SortRequestControl()	Default constructor.
SortRequestControl(SortKey[] keys)	Creates a new sort request control.
SortRequestControl(SortKey[] keys, boolean critical)	Creates a new sort request control.

Method Summary

Modifier and Type	Method	Description
byte[]	encode()	Provides the BER encoding of this control.
boolean	equals(Object o)
SortKey[]	getSortKeys()	Returns the sort keys.
int	hashCode()	Returns the hash code for this object.
boolean	hasValue()	Returns whether the control has a value associated with it.
void	setSortKeys(SortKey[] keys)	Sets the sort keys.
String	toString()

Methods inherited from class org.ldaptive.control.AbstractControl

getCriticality, getOID

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ldaptive.control.Control

getCriticality, getOID

Field Detail

OID

public static final String OID

OID of this control.

See Also:

Constant Field Values

HASH_CODE_SEED

private static final int HASH_CODE_SEED

hash code seed.

See Also:

Constant Field Values

sortKeys

private SortKey[] sortKeys

sort keys.

Constructor Detail

SortRequestControl

public SortRequestControl()

Default constructor.

SortRequestControl

public SortRequestControl(SortKey[] keys)

Creates a new sort request control.

Parameters:

keys - sort keys

SortRequestControl

public SortRequestControl(SortKey[] keys,
                          boolean critical)

Creates a new sort request control.

Parameters:

keys - sort keys

critical - whether this control is critical

Method Detail

hasValue

public boolean hasValue()

Description copied from interface: RequestControl

Returns whether the control has a value associated with it.

Specified by:

hasValue in interface RequestControl

Returns:

whether the control has a value

getSortKeys

public SortKey[] getSortKeys()

Returns the sort keys.

Returns:

sort keys

setSortKeys

public void setSortKeys(SortKey[] keys)

Sets the sort keys.

Parameters:

keys - sort keys

equals

public boolean equals(Object o)

Overrides:

equals in class AbstractControl

hashCode

public int hashCode()

Description copied from class: AbstractControl

Returns the hash code for this object.

Specified by:

hashCode in class AbstractControl

Returns:

hash code

toString

public String toString()

Overrides:

toString in class AbstractControl

encode

public byte[] encode()

Description copied from interface: RequestControl

Provides the BER encoding of this control.

Specified by:

encode in interface RequestControl

Returns:

BER encoded request control