You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@directory.apache.org by el...@apache.org on 2016/09/02 10:34:22 UTC
svn commit: r1758934 - in
/directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras:
controls/ad_impl/ controls/changeNotifications_impl/
controls/permissiveModify_impl/ controls/ppolicy_impl/
controls/syncrepl_impl/ ...
Author: elecharny
Date: Fri Sep 2 10:34:21 2016
New Revision: 1758934
URL: http://svn.apache.org/viewvc?rev=1758934&view=rev
Log:
Updated Javadocs
Modified:
directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/ad_impl/AdDirSyncContainer.java
directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/ad_impl/AdDirSyncDecorator.java
directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/ad_impl/AdShowDeletedDecorator.java
directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/changeNotifications_impl/ChangeNotificationsDecorator.java
directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/permissiveModify_impl/PermissiveModifyDecorator.java
directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/ppolicy_impl/PasswordPolicyFactory.java
directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl_impl/SyncDoneValueContainer.java
directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl_impl/SyncDoneValueDecorator.java
directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl_impl/SyncInfoValueContainer.java
directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl_impl/SyncInfoValueDecorator.java
directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl_impl/SyncRequestValueContainer.java
directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl_impl/SyncRequestValueDecorator.java
directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl_impl/SyncStateValueContainer.java
directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl_impl/SyncStateValueDecorator.java
directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/cancel/CancelRequestDecorator.java
directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/cancel/CancelResponseDecorator.java
directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/certGeneration/CertGenerationRequestDecorator.java
directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/certGeneration/CertGenerationResponseDecorator.java
directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/gracefulDisconnect/GracefulDisconnectResponseDecorator.java
directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/gracefulShutdown/GracefulShutdownRequestDecorator.java
directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/gracefulShutdown/GracefulShutdownResponseDecorator.java
directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/pwdModify/PasswordModifyResponseDecorator.java
directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/startTls/StartTlsResponseDecorator.java
directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/storedProcedure/StoredProcedureContainer.java
directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/storedProcedure/StoredProcedureFactory.java
directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/storedProcedure/StoredProcedureRequestDecorator.java
directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/storedProcedure/StoredProcedureResponseDecorator.java
directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/whoAmI/WhoAmIResponseDecorator.java
Modified: directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/ad_impl/AdDirSyncContainer.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/ad_impl/AdDirSyncContainer.java?rev=1758934&r1=1758933&r2=1758934&view=diff
==============================================================================
--- directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/ad_impl/AdDirSyncContainer.java (original)
+++ directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/ad_impl/AdDirSyncContainer.java Fri Sep 2 10:34:21 2016
@@ -40,9 +40,9 @@ public class AdDirSyncContainer extends
/**
- *
* Creates a new AdDirSyncControl Container object.
*
+ * @param codec The LDAP Service to use
*/
public AdDirSyncContainer( LdapApiService codec )
{
@@ -55,9 +55,10 @@ public class AdDirSyncContainer extends
/**
- *
* Creates a new AdDirSyncControl object.
*
+ * @param codec The LDAP Service to use
+ * @param control The AdDirSync control to decorate
*/
public AdDirSyncContainer( LdapApiService codec, AdDirSync control )
{
Modified: directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/ad_impl/AdDirSyncDecorator.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/ad_impl/AdDirSyncDecorator.java?rev=1758934&r1=1758933&r2=1758934&view=diff
==============================================================================
--- directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/ad_impl/AdDirSyncDecorator.java (original)
+++ directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/ad_impl/AdDirSyncDecorator.java Fri Sep 2 10:34:21 2016
@@ -52,6 +52,8 @@ public class AdDirSyncDecorator extends
/**
* Creates a new instance of AdDirSyncControlCodec.
+ *
+ * @param codec The LDAP Service to use
*/
public AdDirSyncDecorator( LdapApiService codec )
{
@@ -62,7 +64,7 @@ public class AdDirSyncDecorator extends
/**
* Creates a new instance of AdDirSyncDecorator.
*
- * @param codec The LDAP codec
+ * @param codec The LDAP Service to use
* @param control The control to be decorated
*/
public AdDirSyncDecorator( LdapApiService codec, AdDirSync control )
@@ -155,11 +157,13 @@ public class AdDirSyncDecorator extends
/**
* Compute the AdDirSync length. We use the client side control.
+ * <pre>
* 0x30 L1
* |
- * +--> 0x02 0x0(1-4) nnn (parentFirst)
- * +--> 0x02 0x0(1-4) nnn (maxReturnLength)
- * +--> 0x04 L2 xkcd!!!... (cookie)
+ * +--> 0x02 0x0(1-4) nnn (parentFirst)
+ * +--> 0x02 0x0(1-4) nnn (maxReturnLength)
+ * +--> 0x04 L2 xkcd!!!... (cookie)
+ * </pre>
*/
@Override
public int computeLength()
Modified: directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/ad_impl/AdShowDeletedDecorator.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/ad_impl/AdShowDeletedDecorator.java?rev=1758934&r1=1758933&r2=1758934&view=diff
==============================================================================
--- directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/ad_impl/AdShowDeletedDecorator.java (original)
+++ directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/ad_impl/AdShowDeletedDecorator.java Fri Sep 2 10:34:21 2016
@@ -40,6 +40,9 @@ public class AdShowDeletedDecorator exte
{
/**
* Default constructor
+ *
+ * @param codec The LDAP Service to use
+ * @param control The AdShowDeleted control to decorate
*/
public AdShowDeletedDecorator( LdapApiService codec, AdShowDeleted control )
{
Modified: directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/changeNotifications_impl/ChangeNotificationsDecorator.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/changeNotifications_impl/ChangeNotificationsDecorator.java?rev=1758934&r1=1758933&r2=1758934&view=diff
==============================================================================
--- directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/changeNotifications_impl/ChangeNotificationsDecorator.java (original)
+++ directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/changeNotifications_impl/ChangeNotificationsDecorator.java Fri Sep 2 10:34:21 2016
@@ -40,6 +40,9 @@ public class ChangeNotificationsDecorato
/**
* Default constructor
+ *
+ * @param codec The LDAP Service to use
+ * @param control The ChangeNotification control to decorate
*/
public ChangeNotificationsDecorator( LdapApiService codec, ChangeNotifications control )
{
Modified: directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/permissiveModify_impl/PermissiveModifyDecorator.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/permissiveModify_impl/PermissiveModifyDecorator.java?rev=1758934&r1=1758933&r2=1758934&view=diff
==============================================================================
--- directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/permissiveModify_impl/PermissiveModifyDecorator.java (original)
+++ directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/permissiveModify_impl/PermissiveModifyDecorator.java Fri Sep 2 10:34:21 2016
@@ -40,6 +40,9 @@ public class PermissiveModifyDecorator e
{
/**
* Default constructor
+ *
+ * @param codec The LDAP Service to use
+ * @param control The PermissiveModify control to decorate
*/
public PermissiveModifyDecorator( LdapApiService codec, PermissiveModify control )
{
Modified: directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/ppolicy_impl/PasswordPolicyFactory.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/ppolicy_impl/PasswordPolicyFactory.java?rev=1758934&r1=1758933&r2=1758934&view=diff
==============================================================================
--- directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/ppolicy_impl/PasswordPolicyFactory.java (original)
+++ directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/ppolicy_impl/PasswordPolicyFactory.java Fri Sep 2 10:34:21 2016
@@ -41,6 +41,7 @@ public class PasswordPolicyFactory imple
/**
* Creates a new instance of PasswordPolicyFactory.
*
+ * @param codec The LDAP Service to use
*/
public PasswordPolicyFactory( LdapApiService codec )
{
Modified: directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl_impl/SyncDoneValueContainer.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl_impl/SyncDoneValueContainer.java?rev=1758934&r1=1758933&r2=1758934&view=diff
==============================================================================
--- directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl_impl/SyncDoneValueContainer.java (original)
+++ directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl_impl/SyncDoneValueContainer.java Fri Sep 2 10:34:21 2016
@@ -40,9 +40,9 @@ public class SyncDoneValueContainer exte
/**
- *
* Creates a new SyncDoneValueControlContainer object.
*
+ * @param codec The LDAP Service to use
*/
public SyncDoneValueContainer( LdapApiService codec )
{
@@ -55,9 +55,10 @@ public class SyncDoneValueContainer exte
/**
- *
* Creates a new SyncDoneValueControlContainer object.
*
+ * @param codec The LDAP Service to use
+ * @param control The control to decorate
*/
public SyncDoneValueContainer( LdapApiService codec, SyncDoneValue control )
{
Modified: directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl_impl/SyncDoneValueDecorator.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl_impl/SyncDoneValueDecorator.java?rev=1758934&r1=1758933&r2=1758934&view=diff
==============================================================================
--- directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl_impl/SyncDoneValueDecorator.java (original)
+++ directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl_impl/SyncDoneValueDecorator.java Fri Sep 2 10:34:21 2016
@@ -53,6 +53,8 @@ public class SyncDoneValueDecorator exte
/**
* Creates a new instance of SyncDoneValueControlCodec.
+ *
+ * @param codec The LDAP Service to use
*/
public SyncDoneValueDecorator( LdapApiService codec )
{
@@ -74,10 +76,14 @@ public class SyncDoneValueDecorator exte
/**
* Compute the syncDoneValue length.
+ * <pre>
* 0x30 L1
* |
- * +--> 0x04 L2 xkcd!!!... (cookie)
- * +--> 0x01 0x01 [0x00|0xFF] (refreshDeletes)
+ * +--> 0x04 L2 xkcd!!!... (cookie)
+ * +--> 0x01 0x01 [0x00|0xFF] (refreshDeletes)
+ * </pre>
+ *
+ * @return The computed length
*/
@Override
public int computeLength()
Modified: directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl_impl/SyncInfoValueContainer.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl_impl/SyncInfoValueContainer.java?rev=1758934&r1=1758933&r2=1758934&view=diff
==============================================================================
--- directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl_impl/SyncInfoValueContainer.java (original)
+++ directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl_impl/SyncInfoValueContainer.java Fri Sep 2 10:34:21 2016
@@ -41,6 +41,8 @@ public class SyncInfoValueContainer exte
/**
* Creates a new SyncInfoValueControlContainer object. We will store one grammar,
* it's enough ...
+ *
+ * @param codec The LDAP Service to use
*/
public SyncInfoValueContainer( LdapApiService codec )
{
@@ -55,6 +57,9 @@ public class SyncInfoValueContainer exte
/**
* Creates a new SyncInfoValueControlContainer object. We will store one grammar,
* it's enough ...
+ *
+ * @param codec The LDAP Service to use
+ * @param control The control to decorate
*/
public SyncInfoValueContainer( LdapApiService codec, SyncInfoValue control )
{
Modified: directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl_impl/SyncInfoValueDecorator.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl_impl/SyncInfoValueDecorator.java?rev=1758934&r1=1758933&r2=1758934&view=diff
==============================================================================
--- directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl_impl/SyncInfoValueDecorator.java (original)
+++ directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl_impl/SyncInfoValueDecorator.java Fri Sep 2 10:34:21 2016
@@ -56,6 +56,8 @@ public class SyncInfoValueDecorator exte
/**
* The constructor for this codec. Dont't forget to set the type.
+ *
+ * @param codec The LDAP Service to use
*/
public SyncInfoValueDecorator( LdapApiService codec )
{
@@ -65,6 +67,9 @@ public class SyncInfoValueDecorator exte
/**
* The constructor for this codec. Dont't forget to set the type.
+ *
+ * @param codec The LDAP Service to use
+ * @param control The SyncInfoValue to decorate
*/
public SyncInfoValueDecorator( LdapApiService codec, SyncInfoValue control )
{
@@ -74,6 +79,8 @@ public class SyncInfoValueDecorator exte
/**
* The constructor for this codec.
+ *
+ * @param codec The LDAP Service to use
* @param type The kind of syncInfo we will store. Can be newCookie,
* refreshPresent, refreshDelete or syncIdSet
*/
@@ -205,33 +212,29 @@ public class SyncInfoValueDecorator exte
/**
* Compute the SyncInfoValue length.
- *
+ * <br>
* SyncInfoValue :
- *
+ * <pre>
* 0xA0 L1 abcd // newCookie
* 0xA1 L2 // refreshDelete
* |
- * [+--> 0x04 L3 abcd] // cookie
- * [+--> 0x01 0x01 (0x00|0xFF) // refreshDone
+ * [+--> 0x04 L3 abcd] // cookie
+ * [+--> 0x01 0x01 (0x00|0xFF) // refreshDone
* 0xA2 L4 // refreshPresent
* |
- * [+--> 0x04 L5 abcd] // cookie
- * [+--> 0x01 0x01 (0x00|0xFF) // refreshDone
+ * [+--> 0x04 L5 abcd] // cookie
+ * [+--> 0x01 0x01 (0x00|0xFF) // refreshDone
* 0xA3 L6 // syncIdSet
* |
- * [+--> 0x04 L7 abcd] // cookie
- * [+--> 0x01 0x01 (0x00|0xFF) // refreshDeletes
- * +--> 0x31 L8 // SET OF syncUUIDs
+ * [+--> 0x04 L7 abcd] // cookie
+ * [+--> 0x01 0x01 (0x00|0xFF) // refreshDeletes
+ * +--> 0x31 L8 // SET OF syncUUIDs
* |
- * [+--> 0x04 L9 abcd] // syncUUID public static final int AND_FILTER_TAG = 0xA0;
-
- public static final int OR_FILTER_TAG = 0xA1;
-
- public static final int NOT_FILTER_TAG = 0xA2;
-
- public static final int BIND_REQUEST_SASL_TAG = 0xA3;
-
- */
+ * [+--> 0x04 L9 abcd] // syncUUID
+ * </pre>
+ *
+ * @return The computed length
+ **/
@Override
public int computeLength()
{
Modified: directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl_impl/SyncRequestValueContainer.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl_impl/SyncRequestValueContainer.java?rev=1758934&r1=1758933&r2=1758934&view=diff
==============================================================================
--- directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl_impl/SyncRequestValueContainer.java (original)
+++ directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl_impl/SyncRequestValueContainer.java Fri Sep 2 10:34:21 2016
@@ -50,6 +50,8 @@ public class SyncRequestValueContainer e
/**
* Creates a new SyncRequestValueControlContainer object. We will store one grammar,
* it's enough ...
+ *
+ * @param control The control to store
*/
public SyncRequestValueContainer( SyncRequestValue control )
{
Modified: directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl_impl/SyncRequestValueDecorator.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl_impl/SyncRequestValueDecorator.java?rev=1758934&r1=1758933&r2=1758934&view=diff
==============================================================================
--- directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl_impl/SyncRequestValueDecorator.java (original)
+++ directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl_impl/SyncRequestValueDecorator.java Fri Sep 2 10:34:21 2016
@@ -130,14 +130,17 @@ public class SyncRequestValueDecorator e
/**
* Compute the SyncRequestValue length.
- *
+ * <br>
* SyncRequestValue :
+ * <pre>
* 0x30 L1
* |
- * +--> 0x0A 0x01 [0x00|0x01|0x02|0x03] (mode)
- * [+--> 0x04 L2 abcd... (cookie)
- * +--> 0x01 0x01 [0x00|0xFF] (reloadHint)
- *
+ * +--> 0x0A 0x01 [0x00|0x01|0x02|0x03] (mode)
+ * [+--> 0x04 L2 abcd... (cookie)
+ * +--> 0x01 0x01 [0x00|0xFF] (reloadHint)
+ * </pre>
+ *
+ * @return The computed length
*/
@Override
public int computeLength()
Modified: directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl_impl/SyncStateValueContainer.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl_impl/SyncStateValueContainer.java?rev=1758934&r1=1758933&r2=1758934&view=diff
==============================================================================
--- directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl_impl/SyncStateValueContainer.java (original)
+++ directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl_impl/SyncStateValueContainer.java Fri Sep 2 10:34:21 2016
@@ -50,6 +50,8 @@ public class SyncStateValueContainer ext
/**
* Creates a new SyncStateValueControlContainer object. We will store one grammar,
* it's enough ...
+ *
+ * @param control The control to store
*/
public SyncStateValueContainer( SyncStateValue control )
{
Modified: directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl_impl/SyncStateValueDecorator.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl_impl/SyncStateValueDecorator.java?rev=1758934&r1=1758933&r2=1758934&view=diff
==============================================================================
--- directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl_impl/SyncStateValueDecorator.java (original)
+++ directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl_impl/SyncStateValueDecorator.java Fri Sep 2 10:34:21 2016
@@ -119,14 +119,17 @@ public class SyncStateValueDecorator ext
/**
* Compute the SyncStateValue length.
- *
+ * <br>
* SyncStateValue :
+ * <pre>
* 0x30 L1
* |
- * +--> 0x0A 0x01 [0x00|0x01|0x02|0x03] (type)
- * [+--> 0x04 L2 abcd... (entryUUID)
- * [+--> 0x04 L3 abcd... (cookie)
- *
+ * +--> 0x0A 0x01 [0x00|0x01|0x02|0x03] (type)
+ * [+--> 0x04 L2 abcd... (entryUUID)
+ * [+--> 0x04 L3 abcd... (cookie)
+ * </pre>
+ *
+ * @return The computed length
*/
@Override
public int computeLength()
Modified: directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/cancel/CancelRequestDecorator.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/cancel/CancelRequestDecorator.java?rev=1758934&r1=1758933&r2=1758934&view=diff
==============================================================================
--- directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/cancel/CancelRequestDecorator.java (original)
+++ directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/cancel/CancelRequestDecorator.java Fri Sep 2 10:34:21 2016
@@ -109,7 +109,7 @@ public class CancelRequestDecorator exte
/**
* Sets the extended request's <b>requestValue</b> portion of the PDU.
*
- * @param payload byte array of data encapsulating ext. req. parameters
+ * @param requestValue byte array of data encapsulating ext. req. parameters
*/
@Override
public void setRequestValue( byte[] requestValue )
@@ -143,10 +143,11 @@ public class CancelRequestDecorator exte
/**
* Compute the Cancel length
- *
+ * <pre>
* 0x30 L1
* |
- * +--> 0x02 0x0(1-4) [0..2^31-1]
+ * +--> 0x02 0x0(1-4) [0..2^31-1]
+ * </pre>
*/
/* no qualifier */int computeLengthInternal()
{
Modified: directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/cancel/CancelResponseDecorator.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/cancel/CancelResponseDecorator.java?rev=1758934&r1=1758933&r2=1758934&view=diff
==============================================================================
--- directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/cancel/CancelResponseDecorator.java (original)
+++ directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/cancel/CancelResponseDecorator.java Fri Sep 2 10:34:21 2016
@@ -35,8 +35,8 @@ public class CancelResponseDecorator ext
/**
* Creates a new instance of CancelResponseDecorator.
*
- * @param codec
- * @param decoratedMessage
+ * @param codec The LDAP service instance
+ * @param decoratedMessage The decorated message
*/
public CancelResponseDecorator( LdapApiService codec, CancelResponse decoratedMessage )
{
Modified: directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/certGeneration/CertGenerationRequestDecorator.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/certGeneration/CertGenerationRequestDecorator.java?rev=1758934&r1=1758933&r2=1758934&view=diff
==============================================================================
--- directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/certGeneration/CertGenerationRequestDecorator.java (original)
+++ directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/certGeneration/CertGenerationRequestDecorator.java Fri Sep 2 10:34:21 2016
@@ -210,10 +210,10 @@ public class CertGenerationRequestDecora
* <pre>
* 0x30 L1
* |
- * +--> 0x04 LL target DN
- * +--> 0x04 LL issuer DN
- * +--> 0x04 LL subject DN
- * +--> 0x04 LL key algorithm
+ * +--> 0x04 LL target DN
+ * +--> 0x04 LL issuer DN
+ * +--> 0x04 LL subject DN
+ * +--> 0x04 LL key algorithm
* </pre>
*/
/* no qualifier */int computeLengthInternal()
Modified: directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/certGeneration/CertGenerationResponseDecorator.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/certGeneration/CertGenerationResponseDecorator.java?rev=1758934&r1=1758933&r2=1758934&view=diff
==============================================================================
--- directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/certGeneration/CertGenerationResponseDecorator.java (original)
+++ directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/certGeneration/CertGenerationResponseDecorator.java Fri Sep 2 10:34:21 2016
@@ -36,8 +36,8 @@ public class CertGenerationResponseDecor
/**
* Creates a new instance of CancelResponseDecorator.
*
- * @param codec
- * @param decoratedMessage
+ * @param codec The LDAP service instance
+ * @param decoratedMessage The decorated message
*/
public CertGenerationResponseDecorator( LdapApiService codec, CertGenerationResponse decoratedMessage )
{
Modified: directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/gracefulDisconnect/GracefulDisconnectResponseDecorator.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/gracefulDisconnect/GracefulDisconnectResponseDecorator.java?rev=1758934&r1=1758933&r2=1758934&view=diff
==============================================================================
--- directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/gracefulDisconnect/GracefulDisconnectResponseDecorator.java (original)
+++ directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/gracefulDisconnect/GracefulDisconnectResponseDecorator.java Fri Sep 2 10:34:21 2016
@@ -64,8 +64,8 @@ public class GracefulDisconnectResponseD
/**
* Creates a new instance of CancelResponseDecorator.
*
- * @param codec
- * @param decoratedMessage
+ * @param codec The LDAP service instance
+ * @param decoratedMessage The decorated message
*/
public GracefulDisconnectResponseDecorator( LdapApiService codec, GracefulDisconnectResponse decoratedMessage )
{
Modified: directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/gracefulShutdown/GracefulShutdownRequestDecorator.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/gracefulShutdown/GracefulShutdownRequestDecorator.java?rev=1758934&r1=1758933&r2=1758934&view=diff
==============================================================================
--- directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/gracefulShutdown/GracefulShutdownRequestDecorator.java (original)
+++ directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/gracefulShutdown/GracefulShutdownRequestDecorator.java Fri Sep 2 10:34:21 2016
@@ -55,8 +55,8 @@ public class GracefulShutdownRequestDeco
/**
* Creates a new instance of GracefulShutdownRequestDecorator.
*
- * @param codec
- * @param decoratedMessage
+ * @param codec The LDAP Service to use
+ * @param decoratedMessage The GracefulShutdownRequest control to decorate
*/
public GracefulShutdownRequestDecorator( LdapApiService codec, GracefulShutdownRequest decoratedMessage )
{
@@ -158,10 +158,10 @@ public class GracefulShutdownRequestDeco
* <pre>
* 0x30 L1
* |
- * +--> [0x02 0x0(1-4) [0..720] ]
- * +--> [0x80 0x0(1-3) [0..86400] ]
+ * +--> [0x02 0x0(1-4) [0..720] ]
+ * +--> [0x80 0x0(1-3) [0..86400] ]
* </pre>
- * L1 will always be < 11.
+ * L1 will always be < 11.
*/
/* no qualifier */int computeLengthInternal()
{
Modified: directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/gracefulShutdown/GracefulShutdownResponseDecorator.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/gracefulShutdown/GracefulShutdownResponseDecorator.java?rev=1758934&r1=1758933&r2=1758934&view=diff
==============================================================================
--- directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/gracefulShutdown/GracefulShutdownResponseDecorator.java (original)
+++ directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/gracefulShutdown/GracefulShutdownResponseDecorator.java Fri Sep 2 10:34:21 2016
@@ -36,8 +36,8 @@ public class GracefulShutdownResponseDec
/**
* Creates a new instance of GracefulShutdownResponseDecorator.
*
- * @param codec
- * @param decoratedMessage
+ * @param codec The LDAP service instance
+ * @param decoratedMessage The decorated message
*/
public GracefulShutdownResponseDecorator( LdapApiService codec, GracefulShutdownResponse decoratedMessage )
{
Modified: directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/pwdModify/PasswordModifyResponseDecorator.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/pwdModify/PasswordModifyResponseDecorator.java?rev=1758934&r1=1758933&r2=1758934&view=diff
==============================================================================
--- directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/pwdModify/PasswordModifyResponseDecorator.java (original)
+++ directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/pwdModify/PasswordModifyResponseDecorator.java Fri Sep 2 10:34:21 2016
@@ -51,6 +51,13 @@ public class PasswordModifyResponseDecor
private int requestLength = 0;
+ /**
+ *
+ * Creates a new instance of PasswordModifyResponseDecorator.
+ *
+ * @param codec The LDAP service instance
+ * @param decoratedMessage The decorated message
+ */
public PasswordModifyResponseDecorator( LdapApiService codec, PasswordModifyResponse decoratedMessage )
{
super( codec, decoratedMessage );
Modified: directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/startTls/StartTlsResponseDecorator.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/startTls/StartTlsResponseDecorator.java?rev=1758934&r1=1758933&r2=1758934&view=diff
==============================================================================
--- directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/startTls/StartTlsResponseDecorator.java (original)
+++ directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/startTls/StartTlsResponseDecorator.java Fri Sep 2 10:34:21 2016
@@ -33,6 +33,12 @@ import org.apache.directory.api.util.Str
*/
public class StartTlsResponseDecorator extends ExtendedResponseDecorator<StartTlsResponse> implements StartTlsResponse
{
+ /**
+ * Creates a new instance of StartTlsResponseDecorator.
+ *
+ * @param codec The LDAP service instance
+ * @param decoratedMessage The decorated message
+ */
public StartTlsResponseDecorator( LdapApiService codec, StartTlsResponse decoratedMessage )
{
super( codec, decoratedMessage );
Modified: directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/storedProcedure/StoredProcedureContainer.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/storedProcedure/StoredProcedureContainer.java?rev=1758934&r1=1758933&r2=1758934&view=diff
==============================================================================
--- directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/storedProcedure/StoredProcedureContainer.java (original)
+++ directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/storedProcedure/StoredProcedureContainer.java Fri Sep 2 10:34:21 2016
@@ -64,8 +64,7 @@ public class StoredProcedureContainer ex
* Set a StoredProcedure object into the container. It will be completed by the
* ldapDecoder.
*
- * @param ldapMessage
- * The ldapMessage to set.
+ * @param storedProcedure The Stored Procedure to set
*/
public void setStoredProcedure( StoredProcedureRequestDecorator storedProcedure )
{
@@ -73,6 +72,9 @@ public class StoredProcedureContainer ex
}
+ /**
+ * {@inheritDoc}
+ */
public void clean()
{
super.clean();
Modified: directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/storedProcedure/StoredProcedureFactory.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/storedProcedure/StoredProcedureFactory.java?rev=1758934&r1=1758933&r2=1758934&view=diff
==============================================================================
--- directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/storedProcedure/StoredProcedureFactory.java (original)
+++ directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/storedProcedure/StoredProcedureFactory.java Fri Sep 2 10:34:21 2016
@@ -44,7 +44,7 @@ public class StoredProcedureFactory impl
/**
* Creates a new instance of StoredProcedureFactory.
*
- * @param codec
+ * @param codec The LDAP Service to use
*/
public StoredProcedureFactory( LdapApiService codec )
{
Modified: directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/storedProcedure/StoredProcedureRequestDecorator.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/storedProcedure/StoredProcedureRequestDecorator.java?rev=1758934&r1=1758933&r2=1758934&view=diff
==============================================================================
--- directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/storedProcedure/StoredProcedureRequestDecorator.java (original)
+++ directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/storedProcedure/StoredProcedureRequestDecorator.java Fri Sep 2 10:34:21 2016
@@ -101,26 +101,26 @@ public class StoredProcedureRequestDecor
* <pre>
* 0x30 L1
* |
- * +--> 0x04 L2 language
- * +--> 0x04 L3 procedure
- * [+--> 0x30 L4 (parameters)
+ * +--> 0x04 L2 language
+ * +--> 0x04 L3 procedure
+ * [+--> 0x30 L4 (parameters)
* |
- * +--> 0x30 L5-1 (parameter)
+ * +--> 0x30 L5-1 (parameter)
* | |
- * | +--> 0x04 L6-1 type
- * | +--> 0x04 L7-1 value
+ * | +--> 0x04 L6-1 type
+ * | +--> 0x04 L7-1 value
* |
- * +--> 0x30 L5-2 (parameter)
+ * +--> 0x30 L5-2 (parameter)
* | |
- * | +--> 0x04 L6-2 type
- * | +--> 0x04 L7-2 value
+ * | +--> 0x04 L6-2 type
+ * | +--> 0x04 L7-2 value
* |
- * +--> ...
+ * +--> ...
* |
- * +--> 0x30 L5-m (parameter)
+ * +--> 0x30 L5-m (parameter)
* |
- * +--> 0x04 L6-m type
- * +--> 0x04 L7-m value
+ * +--> 0x04 L6-m type
+ * +--> 0x04 L7-m value
* </pre>
*/
/* no qualifier */ int computeLengthInternal()
Modified: directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/storedProcedure/StoredProcedureResponseDecorator.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/storedProcedure/StoredProcedureResponseDecorator.java?rev=1758934&r1=1758933&r2=1758934&view=diff
==============================================================================
--- directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/storedProcedure/StoredProcedureResponseDecorator.java (original)
+++ directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/storedProcedure/StoredProcedureResponseDecorator.java Fri Sep 2 10:34:21 2016
@@ -36,8 +36,8 @@ public class StoredProcedureResponseDeco
/**
* Creates a new instance of CancelResponseDecorator.
*
- * @param codec
- * @param decoratedMessage
+ * @param codec The LDAP service instance
+ * @param decoratedMessage The decorated message
*/
public StoredProcedureResponseDecorator( LdapApiService codec, StoredProcedureResponse decoratedMessage )
{
Modified: directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/whoAmI/WhoAmIResponseDecorator.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/whoAmI/WhoAmIResponseDecorator.java?rev=1758934&r1=1758933&r2=1758934&view=diff
==============================================================================
--- directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/whoAmI/WhoAmIResponseDecorator.java (original)
+++ directory/shared/trunk/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/whoAmI/WhoAmIResponseDecorator.java Fri Sep 2 10:34:21 2016
@@ -49,6 +49,12 @@ public class WhoAmIResponseDecorator ext
private WhoAmIResponse whoAmIResponse;
+ /**
+ * Creates a new instance of WhoAmIResponseDecorator.
+ *
+ * @param codec The LDAP service instance
+ * @param decoratedMessage The decorated message
+ */
public WhoAmIResponseDecorator( LdapApiService codec, WhoAmIResponse decoratedMessage )
{
super( codec, decoratedMessage );