org.apache.directory.shared.ldap.message
Class SubentriesControl

java.lang.Object
  extended byorg.apache.directory.shared.ldap.message.ControlImpl
      extended byorg.apache.directory.shared.ldap.message.SubentriesControl
All Implemented Interfaces:
Control, javax.naming.ldap.Control, java.io.Serializable

public class SubentriesControl
extends ControlImpl

The control for the visibility of subentries with search operations. For convenience we attach section 3 from RFC 3672 where the control is defined:

   3.  Subentries Control
  
   The subentries control MAY be sent with a searchRequest to control
   the visibility of entries and subentries which are within scope.
   Non-visible entries or subentries are not returned in response to the
   request.
  
   The subentries control is an LDAP Control whose controlType is
   1.3.6.1.4.1.4203.1.10.1, criticality is TRUE or FALSE (hence absent),
   and controlValue contains a BER-encoded BOOLEAN indicating
   visibility.  A controlValue containing the value TRUE indicates that
   subentries are visible and normal entries are not.  A controlValue
   containing the value FALSE indicates that normal entries are visible
   and subentries are not.
  
   Note that TRUE visibility has the three octet encoding { 01 01 FF }
   and FALSE visibility has the three octet encoding { 01 01 00 }.
   
   The controlValue SHALL NOT be absent.
   
   In absence of this control, subentries are not visible to singleLevel
   and wholeSubtree scope Search requests but are visible to baseObject
   scope Search requests.
   
   There is no corresponding response control.
   
   This control is not appropriate for non-Search operations.
 

Version:
$Rev: 379008 $
Author:
Apache Directory Project
See Also:
RFC 3672, Serialized Form

Field Summary
static java.lang.String CONTROL_OID
           
 
Fields inherited from interface javax.naming.ldap.Control
CRITICAL, NONCRITICAL
 
Constructor Summary
SubentriesControl()
           
 
Method Summary
 byte[] getEncodedValue()
           
 boolean isVisible()
           
 void setVisibility(boolean visibility)
           
 
Methods inherited from class org.apache.directory.shared.ldap.message.ControlImpl
getID, getType, getValue, isCritical, setCritical, setType, setValue
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CONTROL_OID

public static final java.lang.String CONTROL_OID
See Also:
Constant Field Values
Constructor Detail

SubentriesControl

public SubentriesControl()
Method Detail

setVisibility

public void setVisibility(boolean visibility)

isVisible

public boolean isVisible()

getEncodedValue

public byte[] getEncodedValue()


Copyright © 2003-2006 . All Rights Reserved.