Class SubentriesImpl
- java.lang.Object
-
- org.apache.directory.api.ldap.model.message.controls.AbstractControl
-
- org.apache.directory.api.ldap.model.message.controls.SubentriesImpl
-
- All Implemented Interfaces:
Control
,Subentries
public class SubentriesImpl extends AbstractControl implements Subentries
A simple Subentries Control implementation. This control is described in RFC 3672 : 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.- Author:
- Apache Directory Project
-
-
Field Summary
-
Fields inherited from interface org.apache.directory.api.ldap.model.message.controls.Subentries
OID
-
-
Constructor Summary
Constructors Constructor Description SubentriesImpl()
Default constructor
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(Object o)
int
hashCode()
boolean
isVisible()
returns Tells if the Subentry values are visible or notvoid
setVisibility(boolean visibility)
Set the visibility flagString
toString()
Return a String representing this EntryChangeControl.-
Methods inherited from class org.apache.directory.api.ldap.model.message.controls.AbstractControl
getOid, isCritical, setCritical
-
Methods inherited from interface org.apache.directory.api.ldap.model.message.Control
getOid, isCritical, setCritical
-
-
-
-
Constructor Detail
-
SubentriesImpl
public SubentriesImpl()
Default constructor
-
-
Method Detail
-
isVisible
public boolean isVisible()
returns Tells if the Subentry values are visible or not- Specified by:
isVisible
in interfaceSubentries
- Returns:
- true or false.
-
setVisibility
public void setVisibility(boolean visibility)
Description copied from interface:Subentries
Set the visibility flag- Specified by:
setVisibility
in interfaceSubentries
- Parameters:
visibility
- Set the visibility flag
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classAbstractControl
- See Also:
Object.hashCode()
-
equals
public boolean equals(Object o)
- Overrides:
equals
in classAbstractControl
- See Also:
Object.equals(Object)
-
toString
public String toString()
Return a String representing this EntryChangeControl.- Overrides:
toString
in classAbstractControl
-
-