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

Version:

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

Author:

Middleware Services

Nested Class Summary

static class

SearchOptionsControl.Flag Types of flags.

Field Summary

static String

OID OID of this control.

Fields inherited from class org.ldaptive.control.AbstractControl

logger

Constructor Summary

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

byte[]	encode() Provides the BER encoding of this control.
SearchOptionsControl.Flag	getFlag() Returns the flag.
int	hashCode() Returns the hash code for this object.
void	setFlag(SearchOptionsControl.Flag f) Sets the flag.
String	toString()

Methods inherited from class org.ldaptive.control.AbstractControl

equals, 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

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

getFlag

public SearchOptionsControl.Flag getFlag()

Returns the flag.

Returns:

flag

setFlag

public void setFlag(SearchOptionsControl.Flag f)

Sets the flag.

Parameters:

f - flag

hashCode

public int hashCode()

Returns the hash code for this object.

Specified by:

hashCode in class AbstractControl

Returns:

hash code

toString

public String toString()

Overrides:

toString in class Object

encode

public byte[] encode()

Provides the BER encoding of this control.

Specified by:

encode in interface RequestControl

Returns:

BER encoded request control