org.apache.directory.shared.ldap.codec.search.controls.subentries
Class SubentriesControl

java.lang.Object
  extended by org.apache.directory.shared.asn1.AbstractAsn1Object
      extended by org.apache.directory.shared.ldap.codec.controls.AbstractControl
          extended by org.apache.directory.shared.ldap.codec.search.controls.subentries.SubentriesControl
All Implemented Interfaces:
Asn1Object, CodecControl, Control

public class SubentriesControl
extends AbstractControl

A searchRequest control : Subentries

Version:
$Rev: 912399 $
Author:
Apache Directory Project

Field Summary
static java.lang.String CONTROL_OID
          Ths control OID
 
Fields inherited from class org.apache.directory.shared.ldap.codec.controls.AbstractControl
decoder, value, valueLength
 
Fields inherited from class org.apache.directory.shared.asn1.AbstractAsn1Object
parent
 
Constructor Summary
SubentriesControl()
          Default constructor
 
Method Summary
 int computeLength()
          Compute the SubEntryControl length 0x01 0x01 [0x00|0xFF]
 java.nio.ByteBuffer encode(java.nio.ByteBuffer buffer)
          Encodes the Subentries control.
 byte[] getValue()
          Get the control value
 boolean isVisible()
          Check if the subEntry is visible
 void setVisibility(boolean visibility)
          Set the visibility flag
 java.lang.String toString()
          Return a String representing this EntryChangeControl.
 
Methods inherited from class org.apache.directory.shared.ldap.codec.controls.AbstractControl
computeLength, getDecoder, getOid, hasValue, isCritical, setCritical, setValue
 
Methods inherited from class org.apache.directory.shared.asn1.AbstractAsn1Object
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

CONTROL_OID

public static final java.lang.String CONTROL_OID
Ths control OID

See Also:
Constant Field Values
Constructor Detail

SubentriesControl

public SubentriesControl()
Default constructor

Method Detail

isVisible

public boolean isVisible()
Check if the subEntry is visible

Returns:
true or false.

setVisibility

public void setVisibility(boolean visibility)
Set the visibility flag

Parameters:
visibility - The visibility flag : true or false

computeLength

public int computeLength()
Compute the SubEntryControl length 0x01 0x01 [0x00|0xFF]

Specified by:
computeLength in interface Asn1Object
Specified by:
computeLength in interface CodecControl
Overrides:
computeLength in class AbstractControl
Returns:
The object's computed length

encode

public java.nio.ByteBuffer encode(java.nio.ByteBuffer buffer)
                           throws EncoderException
Encodes the Subentries control.

Specified by:
encode in interface Asn1Object
Specified by:
encode in interface CodecControl
Overrides:
encode in class AbstractControl
Parameters:
buffer - The encoded sink
Returns:
A ByteBuffer that contains the encoded PDU
Throws:
EncoderException - If anything goes wrong.

getValue

public byte[] getValue()
Get the control value

Specified by:
getValue in interface Control
Overrides:
getValue in class AbstractControl
Returns:
The control value

toString

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

Overrides:
toString in class AbstractControl


Copyright © 2003-2011 Apache Software Foundation. All Rights Reserved.