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 09:37:41 UTC
svn commit: r1758923 - in
/directory/shared/trunk/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras:
controls/ppolicy/ controls/syncrepl/syncInfoValue/
controls/syncrepl/syncState/ controls/vlv/ extended/certGeneration/
extended/...
Author: elecharny
Date: Fri Sep 2 09:37:41 2016
New Revision: 1758923
URL: http://svn.apache.org/viewvc?rev=1758923&view=rev
Log:
Updated Javadocs
Modified:
directory/shared/trunk/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/ppolicy/PasswordPolicyImpl.java
directory/shared/trunk/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl/syncInfoValue/SyncInfoValue.java
directory/shared/trunk/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl/syncInfoValue/SyncRequestValue.java
directory/shared/trunk/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl/syncState/SyncStateValueImpl.java
directory/shared/trunk/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/vlv/VirtualListViewRequest.java
directory/shared/trunk/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/certGeneration/CertGenerationRequest.java
directory/shared/trunk/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/gracefulShutdown/GracefulShutdownRequestImpl.java
directory/shared/trunk/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/pwdModify/PasswordModifyRequest.java
directory/shared/trunk/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/whoAmI/WhoAmIResponse.java
directory/shared/trunk/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/whoAmI/WhoAmIResponseImpl.java
Modified: directory/shared/trunk/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/ppolicy/PasswordPolicyImpl.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/ppolicy/PasswordPolicyImpl.java?rev=1758923&r1=1758922&r2=1758923&view=diff
==============================================================================
--- directory/shared/trunk/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/ppolicy/PasswordPolicyImpl.java (original)
+++ directory/shared/trunk/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/ppolicy/PasswordPolicyImpl.java Fri Sep 2 09:37:41 2016
@@ -21,7 +21,7 @@ package org.apache.directory.api.ldap.ex
/**
- * A simple {@link PasswordPolicy} {@link Control} implementation.
+ * A simple {@link PasswordPolicy} Control implementation.
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
* @version $Rev$, $Date$
@@ -48,6 +48,8 @@ public class PasswordPolicyImpl implemen
/**
* Creates a new instance of a PasswordPolicy request Control without any
* response data associated with it.
+ *
+ * @param hasResponse A flag set to <tt>true</tt> if the control should have a response
*/
public PasswordPolicyImpl( boolean hasResponse )
{
@@ -65,6 +67,8 @@ public class PasswordPolicyImpl implemen
/**
* Creates a new instance of PasswordPolicy response Control with response
* information packaged into the control.
+ *
+ * @param response The encapsulated response
*/
public PasswordPolicyImpl( PasswordPolicyResponse response )
{
Modified: directory/shared/trunk/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl/syncInfoValue/SyncInfoValue.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl/syncInfoValue/SyncInfoValue.java?rev=1758923&r1=1758922&r2=1758923&view=diff
==============================================================================
--- directory/shared/trunk/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl/syncInfoValue/SyncInfoValue.java (original)
+++ directory/shared/trunk/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl/syncInfoValue/SyncInfoValue.java Fri Sep 2 09:37:41 2016
@@ -70,7 +70,7 @@ public interface SyncInfoValue extends C
/**
- * @param syncMode the syncMode to set
+ * @param type the synchronization type to set
*/
void setType( SynchronizationInfoEnum type );
@@ -124,7 +124,7 @@ public interface SyncInfoValue extends C
/**
- * @param syncUUIDs the syncUUIDs to set
+ * @param syncUUID the syncUUIDs to set
*/
void addSyncUUID( byte[] syncUUID );
}
\ No newline at end of file
Modified: directory/shared/trunk/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl/syncInfoValue/SyncRequestValue.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl/syncInfoValue/SyncRequestValue.java?rev=1758923&r1=1758922&r2=1758923&view=diff
==============================================================================
--- directory/shared/trunk/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl/syncInfoValue/SyncRequestValue.java (original)
+++ directory/shared/trunk/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl/syncInfoValue/SyncRequestValue.java Fri Sep 2 09:37:41 2016
@@ -42,7 +42,7 @@ public interface SyncRequestValue extend
/**
- * @param syncMode the syncMode to set
+ * @param mode the syncMode to set
*/
void setMode( SynchronizationModeEnum mode );
Modified: directory/shared/trunk/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl/syncState/SyncStateValueImpl.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl/syncState/SyncStateValueImpl.java?rev=1758923&r1=1758922&r2=1758923&view=diff
==============================================================================
--- directory/shared/trunk/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl/syncState/SyncStateValueImpl.java (original)
+++ directory/shared/trunk/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl/syncState/SyncStateValueImpl.java Fri Sep 2 09:37:41 2016
@@ -27,7 +27,7 @@ import org.apache.directory.api.util.Str
/**
- * A simple SyncStateValue {@link Control} implementation.
+ * A simple SyncStateValue Control implementation.
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
* @version $Rev$, $Date$
Modified: directory/shared/trunk/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/vlv/VirtualListViewRequest.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/vlv/VirtualListViewRequest.java?rev=1758923&r1=1758922&r2=1758923&view=diff
==============================================================================
--- directory/shared/trunk/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/vlv/VirtualListViewRequest.java (original)
+++ directory/shared/trunk/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/vlv/VirtualListViewRequest.java Fri Sep 2 09:37:41 2016
@@ -66,7 +66,7 @@ public interface VirtualListViewRequest
/**
- * @param beforeCount Set the number of entries to be returned after the target entry
+ * @param afterCount Set the number of entries to be returned after the target entry
*/
void setAfterCount( int afterCount );
@@ -78,7 +78,7 @@ public interface VirtualListViewRequest
/**
- * @param the position of the target entry
+ * @param offset the position of the target entry
*/
void setOffset( int offset );
Modified: directory/shared/trunk/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/certGeneration/CertGenerationRequest.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/certGeneration/CertGenerationRequest.java?rev=1758923&r1=1758922&r2=1758923&view=diff
==============================================================================
--- directory/shared/trunk/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/certGeneration/CertGenerationRequest.java (original)
+++ directory/shared/trunk/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/certGeneration/CertGenerationRequest.java Fri Sep 2 09:37:41 2016
@@ -34,7 +34,11 @@ public interface CertGenerationRequest e
String EXTENSION_OID = "1.3.6.1.4.1.18060.0.1.8";
- /** Get the Traget DN for the certificate storage */
+ /**
+ * Get the Target DN for the certificate storage
+ *
+ * @return The target DN
+ **/
String getTargetDN();
Modified: directory/shared/trunk/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/gracefulShutdown/GracefulShutdownRequestImpl.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/gracefulShutdown/GracefulShutdownRequestImpl.java?rev=1758923&r1=1758922&r2=1758923&view=diff
==============================================================================
--- directory/shared/trunk/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/gracefulShutdown/GracefulShutdownRequestImpl.java (original)
+++ directory/shared/trunk/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/gracefulShutdown/GracefulShutdownRequestImpl.java Fri Sep 2 09:37:41 2016
@@ -54,8 +54,6 @@ public class GracefulShutdownRequestImpl
/**
* Instantiates a new graceful shutdown request.
- *
- * @param messageId the message id
*/
public GracefulShutdownRequestImpl()
{
Modified: directory/shared/trunk/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/pwdModify/PasswordModifyRequest.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/pwdModify/PasswordModifyRequest.java?rev=1758923&r1=1758922&r2=1758923&view=diff
==============================================================================
--- directory/shared/trunk/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/pwdModify/PasswordModifyRequest.java (original)
+++ directory/shared/trunk/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/pwdModify/PasswordModifyRequest.java Fri Sep 2 09:37:41 2016
@@ -50,7 +50,7 @@ public interface PasswordModifyRequest e
/**
* Set the user identity
*
- * @param the userIdentity to set
+ * @param userIdentity The userIdentity to set
*/
void setUserIdentity( byte[] userIdentity );
@@ -64,7 +64,7 @@ public interface PasswordModifyRequest e
/**
* Set the old password
*
- * @param the oldPassword to set
+ * @param oldPassword The oldPassword to set
*/
void setOldPassword( byte[] oldPassword );
@@ -78,7 +78,7 @@ public interface PasswordModifyRequest e
/**
* Set a new password
*
- * @param the new password to set
+ * @param newPassword The new password to set
*/
void setNewPassword( byte[] newPassword );
}
Modified: directory/shared/trunk/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/whoAmI/WhoAmIResponse.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/whoAmI/WhoAmIResponse.java?rev=1758923&r1=1758922&r2=1758923&view=diff
==============================================================================
--- directory/shared/trunk/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/whoAmI/WhoAmIResponse.java (original)
+++ directory/shared/trunk/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/whoAmI/WhoAmIResponse.java Fri Sep 2 09:37:41 2016
@@ -86,7 +86,7 @@ public interface WhoAmIResponse extends
/**
* set the authzid
*
- * @param The authzid to set
+ * @param authzId The authzId to set
*/
void setAuthzId( byte[] authzId );
}
Modified: directory/shared/trunk/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/whoAmI/WhoAmIResponseImpl.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/whoAmI/WhoAmIResponseImpl.java?rev=1758923&r1=1758922&r2=1758923&view=diff
==============================================================================
--- directory/shared/trunk/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/whoAmI/WhoAmIResponseImpl.java (original)
+++ directory/shared/trunk/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/whoAmI/WhoAmIResponseImpl.java Fri Sep 2 09:37:41 2016
@@ -164,6 +164,8 @@ public class WhoAmIResponseImpl extends
/**
* Set the userId
+ *
+ * @param userId The User ID
*/
public void setUserId( String userId )
{
@@ -182,6 +184,8 @@ public class WhoAmIResponseImpl extends
/**
* Set the DN
+ *
+ * @param dn The DN to set
*/
public void setDn( Dn dn )
{