Package org.ldaptive.ad.control

Class SearchOptionsControl

java.lang.Object

org.ldaptive.control.AbstractControl

org.ldaptive.ad.control.SearchOptionsControl

All Implemented Interfaces:

Control, RequestControl

public class SearchOptionsControl
extends AbstractControl
implements RequestControl

Request control for active directory servers to control various search behaviors. Control is defined as:

     searchOptionsValue ::= SEQUENCE {
       flag  INTEGER
     }
 

See http://msdn.microsoft.com/en-us/library/cc223324.aspx

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SearchOptionsControl.Flag	Types of flags.

Field Summary

Fields

Modifier and Type	Field	Description
private SearchOptionsControl.Flag	flag	flag.
private static int	HASH_CODE_SEED	hash code seed.
static String	OID	OID of this control.

Fields inherited from class org.ldaptive.control.AbstractControl

logger

Constructor Summary

Constructors

Constructor	Description
SearchOptionsControl()	Default constructor.
SearchOptionsControl(SearchOptionsControl.Flag f)	Creates a new search options control.
SearchOptionsControl(SearchOptionsControl.Flag f, boolean critical)	Creates a new search options control.

Method Summary

Modifier and Type	Method	Description
byte[]	encode()	Provides the BER encoding of this control.
boolean	equals(Object o)
SearchOptionsControl.Flag	getFlag()	Returns the flag.
int	hashCode()	Returns the hash code for this object.
boolean	hasValue()	Returns whether the control has a value associated with it.
void	setFlag(SearchOptionsControl.Flag f)	Sets the flag.
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

flag

private SearchOptionsControl.Flag flag

flag.

Constructor Detail

SearchOptionsControl

public SearchOptionsControl()

Default constructor.

SearchOptionsControl

public SearchOptionsControl(SearchOptionsControl.Flag f)

Creates a new search options control.

Parameters:

f - flag

SearchOptionsControl

public SearchOptionsControl(SearchOptionsControl.Flag f,
                            boolean critical)

Creates a new search options control.

Parameters:

f - flag

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

getFlag

public SearchOptionsControl.Flag getFlag()

Returns the flag.

Returns:

flag

setFlag

public void setFlag(SearchOptionsControl.Flag f)

Sets the flag.

Parameters:

f - flag

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