This is an automated email from the ASF dual-hosted git repository.
elecharny pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/directory-ldap-api.git
The following commit(s) were added to refs/heads/master by this push:
new 2d0c5eb Fixed many Javadoc issues
2d0c5eb is described below
commit 2d0c5ebaef3e14149348bc7fca8e38b84f233695
Author: emmanuel lecharny <elecharny@apache.org>
AuthorDate: Wed Mar 6 03:05:51 2019 +0100
Fixed many Javadoc issues
---
.../apache/directory/api/asn1/util/Asn1Buffer.java | 6 +-
.../apache/directory/api/dsmlv2/ParserUtils.java | 1 +
.../client/api/LdapClientTrustStoreManager.java | 14 ++---
.../ldap/client/api/LdapNetworkConnection.java | 65 ++++++++++++++++++++--
.../template/AbstractPasswordPolicyResponder.java | 2 +-
.../api/ldap/codec/StockCodecFactoryUtil.java | 2 -
.../codec/actions/controls/StoreControlName.java | 2 +-
.../api/ldap/codec/api/AbstractControlFactory.java | 1 +
.../api/ldap/codec/api/ControlFactory.java | 2 +
.../ldap/codec/api/ExtendedOperationFactory.java | 3 +
.../codec/api/IntermediateOperationFactory.java | 7 ++-
.../directory/api/ldap/codec/api/LdapEncoder.java | 7 ++-
.../api/ldap/codec/api/LdapMessageContainer.java | 2 -
.../ldap/codec/controls/OpaqueControlFactory.java | 4 +-
.../PersistentSearchContainer.java | 2 +-
.../ldap/codec/factory/SearchRequestFactory.java | 7 ++-
.../codec/factory/SearchResultEntryFactory.java | 1 -
.../codec/standalone/StandaloneLdapApiService.java | 6 +-
.../extended/pwdModify/PasswordModifyResponse.java | 2 +-
.../api/ldap/extras/ExtrasCodecFactoryUtil.java | 4 --
.../ads_impl/cancel/CancelRequestContainer.java | 2 +-
.../EndTransactionRequestContainer.java | 2 +-
.../pwdModify/PasswordModifyRequestContainer.java | 2 +-
.../syncrepl_impl/SyncInfoValueFactory.java | 2 -
pom.xml | 4 +-
25 files changed, 109 insertions(+), 43 deletions(-)
diff --git a/asn1/api/src/main/java/org/apache/directory/api/asn1/util/Asn1Buffer.java b/asn1/api/src/main/java/org/apache/directory/api/asn1/util/Asn1Buffer.java
index e4c2976..51fb3c2 100644
--- a/asn1/api/src/main/java/org/apache/directory/api/asn1/util/Asn1Buffer.java
+++ b/asn1/api/src/main/java/org/apache/directory/api/asn1/util/Asn1Buffer.java
@@ -59,7 +59,9 @@ public class Asn1Buffer
/**
- * @return The current position in the buffer
+ * Set the current position in the buffer
+ *
+ * @param pos The position to move the buffer to
*/
public void setPos( int pos )
{
@@ -106,6 +108,8 @@ public class Asn1Buffer
/**
* Extend the buffer
+ *
+ * @param size The new buffer size
*/
private void extend( int size )
{
diff --git a/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/ParserUtils.java b/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/ParserUtils.java
index cb4fbf6..b518ebf 100644
--- a/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/ParserUtils.java
+++ b/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/ParserUtils.java
@@ -226,6 +226,7 @@ public final class ParserUtils
* @param codec The LDAP Service to use
* @param element the element to add the Controls to
* @param controls a List of Controls
+ * @param isRequest A flag set to <tt>true</tt> if teh LDapMessage is a request
*/
public static void addControls( LdapApiService codec, Element element, Collection<Control>
controls, boolean isRequest )
{
diff --git a/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/LdapClientTrustStoreManager.java
b/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/LdapClientTrustStoreManager.java
index bca83c2..ea8dc02 100644
--- a/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/LdapClientTrustStoreManager.java
+++ b/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/LdapClientTrustStoreManager.java
@@ -110,9 +110,9 @@ public final class LdapClientTrustStoreManager implements X509TrustManager,
Seri
/**
* Determine if client certificate is to be trusted.
*
- * @param x509Chain
- * @param authNType
- * @throws CertificateException
+ * @param x509Chain The certificate chain
+ * @param authNType The key exchange algorithm being used
+ * @throws CertificateException If the trustManager cannot be found
*/
public synchronized void checkClientTrusted( X509Certificate[] x509Chain, String authNType
) throws CertificateException
{
@@ -127,9 +127,9 @@ public final class LdapClientTrustStoreManager implements X509TrustManager,
Seri
/**
* Determine if server certificate is to be trusted.
*
- * @param x509Chain
- * @param authNType
- * @throws CertificateException
+ * @param x509Chain The certificate chain
+ * @param authNType The key exchange algorithm being used
+ * @throws CertificateException If the trustManager cannot be found
*/
public synchronized void checkServerTrusted( X509Certificate[] x509Chain, String authNType
) throws
CertificateException
@@ -344,7 +344,7 @@ public final class LdapClientTrustStoreManager implements X509TrustManager,
Seri
* Read the trust store off the classpath.
*
* @return handle to inputStream containing the trust store
- * @throws CertificateException
+ * @throws CertificateException If the file cannot be found
*/
private InputStream getTrustStoreInputStream() throws CertificateException
{
diff --git a/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/LdapNetworkConnection.java
b/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/LdapNetworkConnection.java
index df941ab..a9661db 100644
--- a/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/LdapNetworkConnection.java
+++ b/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/LdapNetworkConnection.java
@@ -2459,6 +2459,11 @@ public class LdapNetworkConnection extends AbstractLdapConnection implements
Lda
/**
* Process the AddResponse received from the server
+ *
+ * @param addResponse The AddResponse to process
+ * @param addFuture The AddFuture to feed
+ * @param responseId The associated request message ID
+ * @throws InterruptedException If the Future is interrupted
*/
private void addReceived( AddResponse addResponse, AddFuture addFuture, int responseId
) throws InterruptedException
{
@@ -2487,8 +2492,14 @@ public class LdapNetworkConnection extends AbstractLdapConnection implements
Lda
/**
* Process the BindResponse received from the server
+ *
+ * @param bindResponse The BindResponse to process
+ * @param bindFuture The BindFuture to feed
+ * @param responseId The associated request message ID
+ * @throws InterruptedException If the Future is interrupted
*/
- private void bindReceived( BindResponse bindResponse, BindFuture bindFuture, int responseId
) throws InterruptedException
+ private void bindReceived( BindResponse bindResponse, BindFuture bindFuture, int responseId
)
+ throws InterruptedException
{
// remove the listener from the listener map
if ( bindResponse.getLdapResult().getResultCode() == ResultCodeEnum.SUCCESS )
@@ -2520,8 +2531,14 @@ public class LdapNetworkConnection extends AbstractLdapConnection implements
Lda
/**
* Process the CompareResponse received from the server
+ *
+ * @param compareResponse The CompareResponse to process
+ * @param compareFuture The CompareFuture to feed
+ * @param responseId The associated request message ID
+ * @throws InterruptedException If the Future is interrupted
*/
- private void compareReceived( CompareResponse compareResponse, CompareFuture compareFuture,
int responseId ) throws InterruptedException
+ private void compareReceived( CompareResponse compareResponse, CompareFuture compareFuture,
int responseId )
+ throws InterruptedException
{
// remove the listener from the listener map
if ( LOG.isDebugEnabled() )
@@ -2548,8 +2565,14 @@ public class LdapNetworkConnection extends AbstractLdapConnection implements
Lda
/**
* Process the DeleteResponse received from the server
+ *
+ * @param deleteResponse The DeleteResponse to process
+ * @param deleteFuture The DeleteFuture to feed
+ * @param responseId The associated request message ID
+ * @throws InterruptedException If the Future is interrupted
*/
- private void deleteReceived( DeleteResponse deleteResponse, DeleteFuture deleteFuture,
int responseId ) throws InterruptedException
+ private void deleteReceived( DeleteResponse deleteResponse, DeleteFuture deleteFuture,
int responseId )
+ throws InterruptedException
{
if ( LOG.isDebugEnabled() )
{
@@ -2575,6 +2598,12 @@ public class LdapNetworkConnection extends AbstractLdapConnection implements
Lda
/**
* Process the ExtendedResponse received from the server
+ *
+ * @param extendedResponse The ExtendedResponse to process
+ * @param extendedFuture The ExtendedFuture to feed
+ * @param responseId The associated request message ID
+ * @throws InterruptedException If the Future is interrupted
+ * @throws DecoderException If the response cannot be decoded
*/
private void extendedReceived( ExtendedResponse extendedResponse, ExtendedFuture extendedFuture,
int responseId )
throws InterruptedException, DecoderException
@@ -2605,6 +2634,10 @@ public class LdapNetworkConnection extends AbstractLdapConnection implements
Lda
/**
* Process the IntermediateResponse received from the server
+ *
+ * @param intermediateResponse The IntermediateResponse to process
+ * @param responseFuture The ResponseFuture to feed
+ * @throws InterruptedException If the Future is interrupted
*/
private void intermediateReceived( IntermediateResponse intermediateResponse, ResponseFuture<?
extends Response> responseFuture )
throws InterruptedException
@@ -2631,6 +2664,11 @@ public class LdapNetworkConnection extends AbstractLdapConnection implements
Lda
/**
* Process the ModifyResponse received from the server
+ *
+ * @param modifyResponse The ModifyResponse to process
+ * @param modifyFuture The ModifyFuture to feed
+ * @param responseId The associated request message ID
+ * @throws InterruptedException If the Future is interrupted
*/
private void modifyReceived( ModifyResponse modifyResponse, ModifyFuture modifyFuture,
int responseId )
throws InterruptedException
@@ -2665,6 +2703,11 @@ public class LdapNetworkConnection extends AbstractLdapConnection implements
Lda
/**
* Process the ModifyDnResponse received from the server
+ *
+ * @param modifyDnResponse The ModifyDnResponse to process
+ * @param modifyDnFuture The ModifyDnFuture to feed
+ * @param responseId The associated request message ID
+ * @throws InterruptedException If the Future is interrupted
*/
private void modifyDnReceived( ModifyDnResponse modifyDnResponse, ModifyDnFuture modifyDnFuture,
int responseId )
throws InterruptedException
@@ -2693,6 +2736,11 @@ public class LdapNetworkConnection extends AbstractLdapConnection implements
Lda
/**
* Process the SearchResultDone received from the server
+ *
+ * @param searchResultDone The SearchResultDone to process
+ * @param searchFuture The SearchFuture to feed
+ * @param responseId The associated request message ID
+ * @throws InterruptedException If the Future is interrupted
*/
private void searchResultDoneReceived( SearchResultDone searchResultDone, SearchFuture
searchFuture,
int responseId ) throws InterruptedException
@@ -2721,6 +2769,11 @@ public class LdapNetworkConnection extends AbstractLdapConnection implements
Lda
/**
* Process the SearchResultEntry received from the server
+ *
+ * @param searchResultEntry The SearchResultEntry to process
+ * @param searchFuture The SearchFuture to feed
+ * @throws InterruptedException If the Future is interrupted
+ * @throws LdapException If we weren't able to create a new Entry
*/
private void searchResultEntryReceived( SearchResultEntry searchResultEntry, SearchFuture
searchFuture )
throws InterruptedException, LdapException
@@ -2742,9 +2795,13 @@ public class LdapNetworkConnection extends AbstractLdapConnection implements
Lda
/**
* Process the SearchResultEntry received from the server
+ *
+ * @param searchResultReference The SearchResultReference to process
+ * @param searchFuture The SearchFuture to feed
+ * @throws InterruptedException If the Future is interrupted
*/
private void searchResultReferenceReceived( SearchResultReference searchResultReference,
SearchFuture searchFuture )
- throws InterruptedException, LdapException
+ throws InterruptedException
{
if ( LOG.isDebugEnabled() )
{
diff --git a/ldap/client/api/src/main/java/org/apache/directory/ldap/client/template/AbstractPasswordPolicyResponder.java
b/ldap/client/api/src/main/java/org/apache/directory/ldap/client/template/AbstractPasswordPolicyResponder.java
index 62b9109..0b2353b 100755
--- a/ldap/client/api/src/main/java/org/apache/directory/ldap/client/template/AbstractPasswordPolicyResponder.java
+++ b/ldap/client/api/src/main/java/org/apache/directory/ldap/client/template/AbstractPasswordPolicyResponder.java
@@ -70,7 +70,7 @@ public abstract class AbstractPasswordPolicyResponder implements PasswordPolicyR
* <code>resultCode</code>.
*
* @param resultResponse The result response
- * @param passwordPolicy The password policy in use
+ * @param passwordPolicyResponse The password policy in use
* @param resultCode The result
* @return The created PasswordException
*/
diff --git a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/StockCodecFactoryUtil.java
b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/StockCodecFactoryUtil.java
index cdba3aa..f096498 100644
--- a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/StockCodecFactoryUtil.java
+++ b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/StockCodecFactoryUtil.java
@@ -66,8 +66,6 @@ public final class StockCodecFactoryUtil
/**
* Loads the Controls implement out of the box in the codec.
*
- * @param requestControlFactories The Request Control factories to use
- * @param responseControlFactories The Response Control factories to use
* @param apiService The LDAP Service instance to use
*/
public static void loadStockControls( LdapApiService apiService )
diff --git a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/actions/controls/StoreControlName.java
b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/actions/controls/StoreControlName.java
index 9032abe..9056885 100644
--- a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/actions/controls/StoreControlName.java
+++ b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/actions/controls/StoreControlName.java
@@ -42,7 +42,7 @@ import org.slf4j.LoggerFactory;
* <pre>
* Control ::= SEQUENCE {
* controlType LDAPOID,
- * ...LdapMessageContainerDirect<Message>
+ * ...LdapMessageContainerDirect<Message>
* </pre>
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
diff --git a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/AbstractControlFactory.java
b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/AbstractControlFactory.java
index 9063ce4..9210f36 100644
--- a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/AbstractControlFactory.java
+++ b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/AbstractControlFactory.java
@@ -46,6 +46,7 @@ public abstract class AbstractControlFactory<C extends Control> implements
Contr
* Creates a new instance of AbstractControlFactory.
*
* @param codec The LdapApiSevice instance
+ * @param oid The control's OID
*/
protected AbstractControlFactory( LdapApiService codec, String oid )
{
diff --git a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/ControlFactory.java
b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/ControlFactory.java
index 8e12289..67edfaa 100644
--- a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/ControlFactory.java
+++ b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/ControlFactory.java
@@ -68,6 +68,7 @@ public interface ControlFactory<C extends Control>
* @param container The Asn1Container containing the control to feed
* @param control The control to feed
* @param controlBytes The data to decode
+ * @throws DecoderException If the value can't be decoded
*/
void decodeValue( ControlContainer container, Control control, byte[] controlBytes )
throws DecoderException;
@@ -77,6 +78,7 @@ public interface ControlFactory<C extends Control>
*
* @param control The control to feed
* @param controlBytes The data to decode
+ * @throws DecoderException If the value can't be decoded
*/
void decodeValue( Control control, byte[] controlBytes ) throws DecoderException;
}
diff --git a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/ExtendedOperationFactory.java
b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/ExtendedOperationFactory.java
index d582226..08de837 100644
--- a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/ExtendedOperationFactory.java
+++ b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/ExtendedOperationFactory.java
@@ -65,6 +65,7 @@ public interface ExtendedOperationFactory
* Creates a new ExtendedResponse, for the ExtendedRequest with no value
*
* @return The new ExtendedResponse.
+ * @throws DecoderException If the response cannot be decoded
*/
ExtendedResponse newResponse() throws DecoderException;
@@ -94,6 +95,7 @@ public interface ExtendedOperationFactory
*
* @param extendedRequest The ExtendedRequest Operation to feed
* @param requestValue The request value to decode
+ * @throws DecoderException If the value cannot be decoded
*/
void decodeValue( ExtendedRequest extendedRequest, byte[] requestValue ) throws DecoderException;
@@ -112,6 +114,7 @@ public interface ExtendedOperationFactory
*
* @param extendedResponse The ExtendedResponse Operation to feed
* @param responseValue The response value to decode
+ * @throws DecoderException If the value cannot be decoded
*/
void decodeValue( ExtendedResponse extendedResponse, byte[] responseValue ) throws DecoderException;
}
diff --git a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/IntermediateOperationFactory.java
b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/IntermediateOperationFactory.java
index 6347680..b4f204d 100644
--- a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/IntermediateOperationFactory.java
+++ b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/IntermediateOperationFactory.java
@@ -62,7 +62,7 @@ public interface IntermediateOperationFactory
* Encode the value part of the intermediate response operation.
*
* @param buffer The buffer into which to put the encoded value
- * @param IntermediateResponse The IntermediateResponse Operation to encode
+ * @param intermediateResponse The IntermediateResponse Operation to encode
*/
void encodeValue( Asn1Buffer buffer, IntermediateResponse intermediateResponse );
@@ -70,8 +70,9 @@ public interface IntermediateOperationFactory
/**
* Decode the value part of the intermediate response operation.
*
- * @param IntermediateResponse The IntermediateResponse Operation to feed
- * @param responseValue The response bvalue to decode
+ * @param intermediateResponse The IntermediateResponse Operation to feed
+ * @param responseValue The response value to decode
+ * @throws DecoderException If the value cannot be decoded
*/
void decodeValue( IntermediateResponse intermediateResponse, byte[] responseValue ) throws
DecoderException;
}
diff --git a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/LdapEncoder.java
b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/LdapEncoder.java
index 0d97baa..d8301dd 100644
--- a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/LdapEncoder.java
+++ b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/LdapEncoder.java
@@ -85,8 +85,10 @@ public final class LdapEncoder
*
*
* @param buffer The buffer that will contain the encoded control
- * @param control The control to encode
- * @return The control encoded in a byte[]
+ * @param codec The LdapApiService instance
+ * @param controls The controls to encode
+ * @param iterator The Iterator instance we are processing
+ * @param isRequest A flag set to <tt>true</tt> if the LdapMessage is a request
* @throws EncoderException If the encoding failed
*/
private static void encodeControls( Asn1Buffer buffer, LdapApiService codec,
@@ -264,6 +266,7 @@ public final class LdapEncoder
* LdapMessageLength = Length(0x30) + Length(L1) + L1
* </pre>
*
+ * @param buffer The Asn1Buffer instance in which we store the temporary result
* @param codec The LdapApiService instance
* @param message The message to encode
* @return A ByteBuffer that contains the PDU
diff --git a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/LdapMessageContainer.java
b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/LdapMessageContainer.java
index 6b736c4..d37da83 100644
--- a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/LdapMessageContainer.java
+++ b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/LdapMessageContainer.java
@@ -406,8 +406,6 @@ public class LdapMessageContainer<E extends Message> extends AbstractContainer
* is considered as terminated either if :
* - it's a final element (ie an element which cannot contains a Filter)
* - its current length equals its expected length.
- *
- * @param container The container being decoded
*/
public void unstackFilters()
{
diff --git a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/OpaqueControlFactory.java
b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/OpaqueControlFactory.java
index 77d2720..c9b4c33 100644
--- a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/OpaqueControlFactory.java
+++ b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/OpaqueControlFactory.java
@@ -28,7 +28,7 @@ import org.apache.directory.api.ldap.model.message.Control;
import org.apache.directory.api.ldap.model.message.controls.OpaqueControl;
/**
- * A codec {@link ControlFactory} implementation for {@link Opaque} controls.
+ * A codec {@link ControlFactory} implementation for opaque controls.
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
* @version $Rev$, $Date$
@@ -39,7 +39,7 @@ public class OpaqueControlFactory extends AbstractControlFactory<Control>
* Creates a new instance of OpaqueControlFactory.
*
* @param codec The LDAP codec.
- * @param the control to create
+ * @param oid The Control's OID
*/
public OpaqueControlFactory( LdapApiService codec, String oid )
{
diff --git a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/search/persistentSearch/PersistentSearchContainer.java
b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/search/persistentSearch/PersistentSearchContainer.java
index c57826f..3109204 100644
--- a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/search/persistentSearch/PersistentSearchContainer.java
+++ b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/search/persistentSearch/PersistentSearchContainer.java
@@ -63,7 +63,7 @@ public class PersistentSearchContainer extends AbstractContainer implements
Cont
* Set a PSearchControl Object into the container. It will be completed by
* the ldapDecoder.
*
- * @param decorator the PSearchControl to set.
+ * @param control the PSearchControl to set.
*/
public void setControl( Control control )
{
diff --git a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/factory/SearchRequestFactory.java
b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/factory/SearchRequestFactory.java
index 0926152..cf93129 100644
--- a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/factory/SearchRequestFactory.java
+++ b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/factory/SearchRequestFactory.java
@@ -90,6 +90,7 @@ public final class SearchRequestFactory implements Messagefactory
*
* @param buffer The buffer where to put the PDU
* @param node The Branch filter to encode
+ * @param tag the ASN.1 type
*/
private void encodeFilter( Asn1Buffer buffer, BranchNode node, byte tag )
{
@@ -110,7 +111,7 @@ public final class SearchRequestFactory implements Messagefactory
/**
* Encode a SimpleNode.
- * <pre>
+ * <br>
* SimpleFilter :
* <pre>
* 0xA3/0xA5/0xA6/A8 LL
@@ -120,6 +121,7 @@ public final class SearchRequestFactory implements Messagefactory
*
* @param buffer The buffer where to put the PDU
* @param node The Simple filter to encode
+ * @param tag the ASN.1 type
*/
private void encodeFilter( Asn1Buffer buffer, SimpleNode<?> node, byte tag )
{
@@ -157,7 +159,7 @@ public final class SearchRequestFactory implements Messagefactory
/**
* Encode a SubstringNode.
- * <pre>
+ * <br>
* Substrings Filter :
* <pre>
* 0xA4 LL
@@ -218,7 +220,6 @@ public final class SearchRequestFactory implements Messagefactory
/**
* Encode an ExtensibleNode.
- * <pre>
* <br>
* ExtensibleMatch filter :
* <pre>
diff --git a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/factory/SearchResultEntryFactory.java
b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/factory/SearchResultEntryFactory.java
index 950a768..6afc4ee 100644
--- a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/factory/SearchResultEntryFactory.java
+++ b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/factory/SearchResultEntryFactory.java
@@ -56,7 +56,6 @@ public final class SearchResultEntryFactory extends ResponseFactory
* 0x04 LL attributeValue
* </pre>
*
- * @param codec The LdapApiService instance
* @param buffer The buffer where to put the PDU
* @param values The iterator on the values
*/
diff --git a/ldap/codec/standalone/src/main/java/org/apache/directory/api/ldap/codec/standalone/StandaloneLdapApiService.java
b/ldap/codec/standalone/src/main/java/org/apache/directory/api/ldap/codec/standalone/StandaloneLdapApiService.java
index 4b384cd..e3408f1 100644
--- a/ldap/codec/standalone/src/main/java/org/apache/directory/api/ldap/codec/standalone/StandaloneLdapApiService.java
+++ b/ldap/codec/standalone/src/main/java/org/apache/directory/api/ldap/codec/standalone/StandaloneLdapApiService.java
@@ -188,7 +188,8 @@ public class StandaloneLdapApiService extends DefaultLdapCodecService
/**
* Creates a new instance of StandaloneLdapApiService.
*
- * @param controls The list of controls to store
+ * @param requestControls The list of request controls to store
+ * @param responseControls The list of response controls to store
* @param extendedOperations The list of extended operations to store
* @param intermediateResponses The list of intermediate responsess to store
* @throws Exception If we had an issue with one of the two lists
@@ -242,6 +243,7 @@ public class StandaloneLdapApiService extends DefaultLdapCodecService
/**
* Parses the system properties to obtain the controls list.
*
+ * @param type The control's type
* @return A list of controls
*/
private static List<String> getControlsFromSystemProperties( ControlType type )
@@ -348,6 +350,7 @@ public class StandaloneLdapApiService extends DefaultLdapCodecService
* Loads a list of controls from their FQCN.
*
* @param controlsList The list of controls to load
+ * @param controlFactories The set of control factories already loaded
* @throws Exception if a control could not be loaded
*/
private void loadControls( List<String> controlsList, Map<String, ControlFactory<?
extends Control>> controlFactories )
@@ -368,6 +371,7 @@ public class StandaloneLdapApiService extends DefaultLdapCodecService
* Loads a control from its FQCN.
*
* @param controlFQCN The control FQCN
+ * @param controlFactories The set of control factories already loaded
* @throws Exception If the control could not be loaded
*/
private void loadControl( String controlFQCN, Map<String, ControlFactory<? extends
Control>> controlFactories )
diff --git a/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/pwdModify/PasswordModifyResponse.java
b/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/pwdModify/PasswordModifyResponse.java
index da480c5..8b11b30 100644
--- a/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/pwdModify/PasswordModifyResponse.java
+++ b/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/pwdModify/PasswordModifyResponse.java
@@ -50,7 +50,7 @@ public interface PasswordModifyResponse extends ExtendedResponse
/**
* Set the generated password
*
- * @param The generated password to set
+ * @param genPassword The generated password to set
*/
void setGenPassword( byte[] genPassword );
}
diff --git a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/ExtrasCodecFactoryUtil.java
b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/ExtrasCodecFactoryUtil.java
index c4d7723..770729b 100644
--- a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/ExtrasCodecFactoryUtil.java
+++ b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/ExtrasCodecFactoryUtil.java
@@ -90,8 +90,6 @@ public final class ExtrasCodecFactoryUtil
/**
* Loads the extras controls.
*
- * @param requestControlFactories The Request Control factories to use
- * @param responseControlFactories The Response Control factories to use
* @param apiService The LDAP Service instance to use
*/
public static void loadExtrasControls( LdapApiService apiService )
@@ -248,7 +246,6 @@ public final class ExtrasCodecFactoryUtil
* <li>startTransaction</li>
* </ul>
*
- * @param extendendOperationsFactories The map of extended operation factories
* @param apiService The LdapApiService to use
*/
public static void loadExtrasExtendedOperations( LdapApiService apiService )
@@ -362,7 +359,6 @@ public final class ExtrasCodecFactoryUtil
* <li>syncInfovalue</li>
* </ul>
*
- * @param intermediateResponseFactories The map of intermediate response factories
* @param apiService The LdapApiService to use
*/
public static void loadExtrasIntermediateResponses( LdapApiService apiService )
diff --git a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/cancel/CancelRequestContainer.java
b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/cancel/CancelRequestContainer.java
index 488dc85..e627abb 100644
--- a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/cancel/CancelRequestContainer.java
+++ b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/cancel/CancelRequestContainer.java
@@ -59,7 +59,7 @@ public class CancelRequestContainer extends AbstractContainer
* Set a Cancel Object into the container. It will be completed
* by the ldapDecoder.
*
- * @param cancel the Cancel to set.
+ * @param cancelRequest the Cancel to set.
*/
public void setCancelRequest( CancelRequest cancelRequest )
{
diff --git a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/endTransaction/EndTransactionRequestContainer.java
b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/endTransaction/EndTransactionRequestContainer.java
index 0459df4..961a00a 100644
--- a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/endTransaction/EndTransactionRequestContainer.java
+++ b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/endTransaction/EndTransactionRequestContainer.java
@@ -59,7 +59,7 @@ public class EndTransactionRequestContainer extends AbstractContainer
* Set a EndTransactionRequest Object into the container. It will be completed by
* the ldapDecoder.
*
- * @param endTransactionRequestDecorator the EndTransactionRequest to set.
+ * @param endTransactionRequest the EndTransactionRequest to set.
*/
public void setEndTransactionRequest( EndTransactionRequest endTransactionRequest )
{
diff --git a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/pwdModify/PasswordModifyRequestContainer.java
b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/pwdModify/PasswordModifyRequestContainer.java
index ab459b0..f17cc90 100644
--- a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/pwdModify/PasswordModifyRequestContainer.java
+++ b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/pwdModify/PasswordModifyRequestContainer.java
@@ -59,7 +59,7 @@ public class PasswordModifyRequestContainer extends AbstractContainer
* Set a PasswordModifyRequest Object into the container. It will be completed by
* the ldapDecoder.
*
- * @param passwordModifyRequestDecorator the PasswordModifyRequest to set.
+ * @param passwordModifyRequest the PasswordModifyRequest to set.
*/
public void setPasswordModifyRequest( PasswordModifyRequest passwordModifyRequest )
{
diff --git a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/intermediate/syncrepl_impl/SyncInfoValueFactory.java
b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/intermediate/syncrepl_impl/SyncInfoValueFactory.java
index c49aaf5..83ea2b2 100644
--- a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/intermediate/syncrepl_impl/SyncInfoValueFactory.java
+++ b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/intermediate/syncrepl_impl/SyncInfoValueFactory.java
@@ -43,8 +43,6 @@ public class SyncInfoValueFactory implements IntermediateOperationFactory
{
/**
* Creates a new instance of SyncInfoValueFactory.
- *
- * @param codec The codec for this factory.
*/
public SyncInfoValueFactory()
{
diff --git a/pom.xml b/pom.xml
index 7f02135..1ae0afd 100644
--- a/pom.xml
+++ b/pom.xml
@@ -313,10 +313,10 @@
<configuration>
<show>private</show>
<nohelp>true</nohelp>
- <additionalOptions>
+ <!-- additionalOptions>
<additionalOptions>-Xmaxwarns 1000</additionalOptions>
<additionalOptions>-Xmaxerrs 1000</additionalOptions>
- </additionalOptions>
+ </additionalOptions -->
</configuration>
</plugin>
|