org.apache.directory.shared.ldap.codec.search.controls
Class PSearchControl

java.lang.Object
  extended by org.apache.directory.shared.asn1.Asn1Object
      extended by org.apache.directory.shared.ldap.codec.search.controls.PSearchControl

public class PSearchControl
extends org.apache.directory.shared.asn1.Asn1Object

A persistence search object

Author:
Apache Directory Project

Field Summary
static int CHANGE_TYPE_ADD
          Definition of the change types
static int CHANGE_TYPE_DELETE
           
static int CHANGE_TYPE_MODDN
           
static int CHANGE_TYPE_MODIFY
           
static int CHANGE_TYPES_MAX
           
static int CHANGE_TYPES_MIN
          Min and Max values for the possible combined change types
 
Fields inherited from class org.apache.directory.shared.asn1.Asn1Object
parent
 
Constructor Summary
PSearchControl()
          Default constructor
 
Method Summary
 int computeLength()
          Compute the PSearchControl length 0x30 L1 | +--> 0x02 0x0(1-4) [0..2^31-1] (changeTypes) +--> 0x01 0x01 [0x00 | 0xFF] (changeOnly) +--> 0x01 0x01 [0x00 | 0xFF] (returnRCs)
 java.nio.ByteBuffer encode(java.nio.ByteBuffer buffer)
          Encodes the persistent search control.
 int getChangeTypes()
           
 boolean isChangesOnly()
           
 boolean isReturnECs()
           
 void setChangesOnly(boolean changesOnly)
           
 void setChangeTypes(int changeTypes)
           
 void setReturnECs(boolean returnECs)
           
 java.lang.String toString()
          Return a String representing this PSearchControl.
 
Methods inherited from class org.apache.directory.shared.asn1.Asn1Object
addLength, getCurrentLength, getExpectedLength, getParent, getTlvId, setCurrentLength, setExpectedLength, setParent
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

CHANGE_TYPE_ADD

public static final int CHANGE_TYPE_ADD
Definition of the change types

See Also:
Constant Field Values

CHANGE_TYPE_DELETE

public static final int CHANGE_TYPE_DELETE
See Also:
Constant Field Values

CHANGE_TYPE_MODIFY

public static final int CHANGE_TYPE_MODIFY
See Also:
Constant Field Values

CHANGE_TYPE_MODDN

public static final int CHANGE_TYPE_MODDN
See Also:
Constant Field Values

CHANGE_TYPES_MIN

public static final int CHANGE_TYPES_MIN
Min and Max values for the possible combined change types

See Also:
Constant Field Values

CHANGE_TYPES_MAX

public static final int CHANGE_TYPES_MAX
See Also:
Constant Field Values
Constructor Detail

PSearchControl

public PSearchControl()
Default constructor

Method Detail

setChangesOnly

public void setChangesOnly(boolean changesOnly)

isChangesOnly

public boolean isChangesOnly()

setReturnECs

public void setReturnECs(boolean returnECs)

isReturnECs

public boolean isReturnECs()

setChangeTypes

public void setChangeTypes(int changeTypes)

getChangeTypes

public int getChangeTypes()

computeLength

public int computeLength()
Compute the PSearchControl length 0x30 L1 | +--> 0x02 0x0(1-4) [0..2^31-1] (changeTypes) +--> 0x01 0x01 [0x00 | 0xFF] (changeOnly) +--> 0x01 0x01 [0x00 | 0xFF] (returnRCs)

Specified by:
computeLength in class org.apache.directory.shared.asn1.Asn1Object

encode

public java.nio.ByteBuffer encode(java.nio.ByteBuffer buffer)
                           throws org.apache.directory.shared.asn1.codec.EncoderException
Encodes the persistent search control.

Overrides:
encode in class org.apache.directory.shared.asn1.Asn1Object
Parameters:
buffer - The encoded sink
Returns:
A ByteBuffer that contains the encoded PDU
Throws:
org.apache.directory.shared.asn1.codec.EncoderException - If anything goes wrong.

toString

public java.lang.String toString()
Return a String representing this PSearchControl.

Overrides:
toString in class java.lang.Object


Copyright © 2004-2011. All Rights Reserved.