svn commit: r1096588 - in /directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/shared/ldap/model/message: Control.java controls/Subentries.java

[el...@apache.org]

Author: elecharny
Date: Mon Apr 25 20:34:16 2011
New Revision: 1096588

URL: http://svn.apache.org/viewvc?rev=1096588&view=rev
Log:
o Javadoc cleanup

Modified:
    directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/shared/ldap/model/message/Control.java
    directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/shared/ldap/model/message/controls/Subentries.java

Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/shared/ldap/model/message/Control.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/shared/ldap/model/message/Control.java?rev=1096588&r1=1096587&r2=1096588&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/shared/ldap/model/message/Control.java (original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/shared/ldap/model/message/Control.java Mon Apr 25 20:34:16 2011
@@ -22,7 +22,8 @@ package org.apache.directory.shared.ldap
 
 /**
  * Protocol request and response altering control interface. Any number of
- * controls may be associated with a protocol message.
+ * controls may be associated with a protocol message. Each control may be
+ * associated with a Request, a response, or both.
  * 
  * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
  */

Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/shared/ldap/model/message/controls/Subentries.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/shared/ldap/model/message/controls/Subentries.java?rev=1096588&r1=1096587&r2=1096588&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/shared/ldap/model/message/controls/Subentries.java (original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/shared/ldap/model/message/controls/Subentries.java Mon Apr 25 20:34:16 2011
@@ -23,7 +23,32 @@ import org.apache.directory.shared.ldap.
 
 
 /**
- * A searchRequest control : Subentries
+ * A simple Subentries Control. 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 <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
  */