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 2025/02/06 22:30:29 UTC
(directory-ldap-api) branch master updated (3d42e402b -> 0af0cd23b)
This is an automated email from the ASF dual-hosted git repository.
elecharny pushed a change to branch master
in repository https://gitbox.apache.org/repos/asf/directory-ldap-api.git
from 3d42e402b Merge pull request #178 from apache/dependabot/maven/org.apache.commons-commons-pool2-2.12.1
new 6fb23a44e Fixed many javadoc warnings
new 29be93bd2 Some more javadoc fixes. Maki-e it so the maven javadoc plugin don't show private members javadoc errors, and more than 100 warnings.errors
new dfd1546e8 Fixed the schema converter javadoc warnings
new 70e2e2c11 Fixed the codec-api javadoc warnings
new fecaed970 Fixed the last javadoc warnings
new 0af0cd23b Merge remote-tracking branch 'refs/remotes/origin/master'
The 6 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
.../directory/api/dsmlv2/engine/Dsmlv2Engine.java | 8 +
.../directory/api/dsmlv2/AbstractGrammar.java | 8 +
.../org/apache/directory/api/dsmlv2/Container.java | 2 +
.../apache/directory/api/dsmlv2/DsmlControl.java | 2 +
.../apache/directory/api/dsmlv2/DsmlLiterals.java | 203 +++++++++++++++++-
.../api/dsmlv2/request/AddRequestDsml.java | 2 +
.../directory/api/dsmlv2/request/AndFilter.java | 9 +
.../dsmlv2/request/AttributeValueAssertion.java | 12 +-
.../api/dsmlv2/request/BatchRequestDsml.java | 4 +-
.../api/dsmlv2/request/ConnectorFilter.java | 8 +
.../api/dsmlv2/request/Dsmlv2Grammar.java | 2 +
.../api/dsmlv2/request/ExtensibleMatchFilter.java | 8 +
.../directory/api/dsmlv2/request/Filter.java | 8 +
.../api/dsmlv2/request/ModifyRequestDsml.java | 2 +
.../directory/api/dsmlv2/request/NotFilter.java | 9 +
.../directory/api/dsmlv2/request/OrFilter.java | 9 +
.../api/dsmlv2/request/PresentFilter.java | 8 +
.../api/dsmlv2/request/SubstringFilter.java | 8 +
.../api/dsmlv2/response/ErrorResponse.java | 2 +
.../api/dsmlv2/response/SearchResultEntryDsml.java | 4 +-
.../ldap/client/api/AbstractLdapConnection.java | 6 +
.../api/AbstractPoolableLdapConnectionFactory.java | 7 +
.../client/api/DefaultLdapConnectionValidator.java | 9 +
.../ldap/client/api/DefaultSchemaLoader.java | 20 ++
.../client/api/LdapClientTrustStoreManager.java | 12 +-
.../directory/ldap/client/api/LdapConnection.java | 4 +
.../ldap/client/api/LdapConnectionConfig.java | 8 +
.../ldap/client/api/LdapNetworkConnection.java | 6 +
.../directory/ldap/client/api/LdifAnonymizer.java | 14 ++
.../client/api/LookupLdapConnectionValidator.java | 9 +
.../ldap/client/api/MonitoringLdapConnection.java | 8 +-
.../client/api/NoVerificationTrustManager.java | 9 +
.../ldap/client/api/PooledLdapConnection.java | 17 ++
.../ldap/client/api/future/ExtendedFuture.java | 4 +
.../ldap/client/api/future/ResponseFuture.java | 3 +
.../template/AbstractPasswordPolicyResponder.java | 6 +-
.../LdapRequestUnsuccessfulException.java | 2 +
.../template/exception/PasswordException.java | 5 +
.../api/ldap/codec/AttributeValueAssertion.java | 11 +
.../directory/api/ldap/codec/LdapStatesEnum.java | 234 ++++++++++++++++++++-
.../api/ldap/codec/api/LdapApiService.java | 12 +-
.../api/ldap/codec/api/LdapCodecConstants.java | 67 +++++-
.../api/ldap/codec/api/LdapMessageContainer.java | 59 +++++-
.../ldap/codec/api/MessageEncoderException.java | 2 +
.../directory/api/ldap/codec/api/SaslFilter.java | 29 +++
.../codec/api/SchemaBinaryAttributeDetector.java | 6 +
.../search/entryChange/EntryChangeContainer.java | 1 +
.../search/pagedSearch/PagedResultsContainer.java | 1 +
.../PersistentSearchContainer.java | 3 +-
.../search/subentries/SubentriesContainer.java | 2 +
.../codec/controls/sort/SortRequestContainer.java | 11 +-
.../codec/controls/sort/SortResponseContainer.java | 4 +
.../ldap/codec/factory/AbandonRequestFactory.java | 3 +
.../api/ldap/codec/factory/AddRequestFactory.java | 3 +
.../api/ldap/codec/factory/AddResponseFactory.java | 3 +
.../api/ldap/codec/factory/BindRequestFactory.java | 3 +
.../ldap/codec/factory/BindResponseFactory.java | 3 +
.../ldap/codec/factory/CompareRequestFactory.java | 3 +
.../ldap/codec/factory/CompareResponseFactory.java | 3 +
.../ldap/codec/factory/DeleteRequestFactory.java | 3 +
.../ldap/codec/factory/DeleteResponseFactory.java | 3 +
.../ldap/codec/factory/ExtendedRequestFactory.java | 3 +
.../codec/factory/ExtendedResponseFactory.java | 3 +
.../codec/factory/IntermediateResponseFactory.java | 3 +
.../ldap/codec/factory/ModifyDnRequestFactory.java | 3 +
.../codec/factory/ModifyDnResponseFactory.java | 3 +
.../ldap/codec/factory/ModifyRequestFactory.java | 3 +
.../ldap/codec/factory/ModifyResponseFactory.java | 3 +
.../ldap/codec/factory/SearchRequestFactory.java | 3 +
.../codec/factory/SearchResultDoneFactory.java | 3 +
.../codec/factory/SearchResultEntryFactory.java | 3 +
.../factory/SearchResultReferenceFactory.java | 3 +
.../ldap/codec/factory/UnbindRequestFactory.java | 3 +
.../ldap/codec/osgi/DefaultLdapCodecService.java | 17 ++
.../directory/api/ldap/codec/search/Filter.java | 2 +
.../api/ldap/codec/search/SubstringFilter.java | 3 +
.../api/ldap/aci/ACIItemSyntaxChecker.java | 9 +
.../AllUserAttributeTypesAndValuesItem.java | 9 +
.../protectedItem/AllUserAttributeTypesItem.java | 9 +
.../api/ldap/aci/protectedItem/EntryItem.java | 9 +
.../aci/src/test/resources/snippet/Snippet.java | 10 +
.../api/ldap/extras/controls/SyncModifyDnType.java | 3 +
.../extras/controls/SynchronizationModeEnum.java | 2 +
.../ldap/extras/controls/ad/AdDirSyncRequest.java | 10 +
.../ldap/extras/controls/ad/AdDirSyncResponse.java | 19 +-
.../extras/controls/ad/AdDirSyncResponseFlag.java | 4 +
.../api/ldap/extras/controls/ad/AdPolicyHints.java | 2 +
.../controls/ppolicy/PasswordPolicyErrorEnum.java | 4 +-
.../extras/controls/relax/RelaxControlImpl.java | 13 +-
.../controls/syncrepl/syncDone/SyncDoneValue.java | 10 +-
.../syncrepl/syncRequest/SyncRequestValue.java | 12 ++
.../syncrepl/syncState/SyncStateTypeEnum.java | 2 +
.../syncrepl/syncState/SyncStateValue.java | 18 +-
.../transaction/TransactionSpecification.java | 3 +
.../controls/vlv/VirtualListViewRequest.java | 39 +++-
.../controls/vlv/VirtualListViewResponse.java | 7 +
.../controls/vlv/VirtualListViewResultCode.java | 4 +
.../ldap/extras/extended/cancel/CancelRequest.java | 2 +
.../certGeneration/CertGenerationRequest.java | 7 +-
.../endTransaction/EndTransactionRequest.java | 5 +
.../endTransaction/EndTransactionResponse.java | 6 +
.../endTransaction/EndTransactionResponseImpl.java | 4 +-
.../extended/endTransaction/UpdateControls.java | 8 +
.../extended/pwdModify/PasswordModifyRequest.java | 6 +
.../startTransaction/StartTransactionResponse.java | 2 +
.../StartTransactionResponseImpl.java | 4 +-
.../storedProcedure/StoredProcedureParameter.java | 10 +-
.../storedProcedure/StoredProcedureRequest.java | 6 +
.../extras/extended/whoAmI/WhoAmIResponse.java | 6 +-
.../intermediate/syncrepl/SyncInfoValue.java | 18 ++
.../syncrepl/SynchronizationInfoEnum.java | 2 +
.../api/ldap/extras/ExtrasBundleActivator.java | 10 +-
.../ad_impl/AdDirSyncRequestContainer.java | 2 +
.../controls/ad_impl/AdDirSyncRequestGrammar.java | 2 +
.../ad_impl/AdDirSyncRequestStatesEnum.java | 2 +-
.../ad_impl/AdDirSyncResponseContainer.java | 4 +-
.../controls/ad_impl/AdDirSyncResponseGrammar.java | 6 +-
.../ad_impl/AdDirSyncResponseStatesEnum.java | 3 +-
.../controls/ad_impl/AdPolicyHintsContainer.java | 2 +
.../controls/ad_impl/AdPolicyHintsGrammar.java | 2 +
.../PasswordPolicyResponseContainer.java | 2 +
.../PasswordPolicyResponseGrammar.java | 2 +
.../controls/ppolicy_impl/PasswordPolicyTags.java | 2 +
.../controls/relax_impl/RelaxControlFactory.java | 3 +
.../syncrepl_impl/SyncDoneValueContainer.java | 2 +
.../syncrepl_impl/SyncDoneValueGrammar.java | 2 +
.../syncrepl_impl/SyncDoneValueStatesEnum.java | 2 +-
.../syncrepl_impl/SyncRequestValueContainer.java | 2 +
.../syncrepl_impl/SyncStateValueContainer.java | 2 +
.../vlv_impl/VirtualListViewRequestContainer.java | 2 +
.../vlv_impl/VirtualListViewRequestGrammar.java | 2 +
.../vlv_impl/VirtualListViewResponseContainer.java | 2 +
.../vlv_impl/VirtualListViewResponseGrammar.java | 2 +
.../controls/vlv_impl/VirtualListViewerTags.java | 1 +
.../ads_impl/cancel/CancelRequestContainer.java | 2 +
.../CertGenerationRequestContainer.java | 2 +
.../EndTransactionRequestContainer.java | 2 +
.../EndTransactionResponseContainer.java | 6 +
.../endTransaction/controls/ControlsContainer.java | 12 ++
.../GracefulDisconnectResponseContainer.java | 2 +
.../GracefulShutdownRequestContainer.java | 2 +
.../pwdModify/PasswordModifyRequestContainer.java | 1 +
.../pwdModify/PasswordModifyResponseContainer.java | 2 +
.../StoredProcedureRequestContainer.java | 6 +-
.../syncrepl_impl/SyncInfoValueContainer.java | 2 +
.../syncrepl_impl/SyncInfoValueTags.java | 2 +
ldap/extras/trigger/pom.xml | 10 +
.../directory/api/ldap/trigger/LdapOperation.java | 2 +
.../api/ldap/trigger/StoredProcedureParameter.java | 137 ++++++++++--
.../directory/api/ldap/util/tree/DnNode.java | 24 ++-
ldap/schema/converter/pom.xml | 10 +
.../converter/src/main/antlr/schemaConverter.g | 6 +-
.../ldap/schema/converter/ObjectClassHolder.java | 11 +
.../api/ldap/schema/converter/Schema.java | 18 +-
.../api/ldap/schema/converter/SchemaElement.java | 14 ++
.../ldap/schema/converter/SchemaElementImpl.java | 8 +
.../api/ldap/schema/converter/SchemaParser.java | 6 +-
.../api/ldap/schema/loader/EntityFactory.java | 2 +
.../schema/manager/impl/DefaultSchemaManager.java | 18 +-
pom.xml | 8 +-
160 files changed, 1567 insertions(+), 87 deletions(-)
create mode 100644 ldap/extras/aci/src/test/resources/snippet/Snippet.java
(directory-ldap-api) 06/06: Merge remote-tracking branch 'refs/remotes/origin/master'
Posted by el...@apache.org.
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
commit 0af0cd23b0ac69ed6f7e350b4b4c0d4fa609bfee
Merge: fecaed970 3d42e402b
Author: emmanuel lecharny <el...@apache.org>
AuthorDate: Thu Feb 6 23:27:26 2025 +0100
Merge remote-tracking branch 'refs/remotes/origin/master'
.github/workflows/codeql-analysis.yml | 6 +++---
.github/workflows/pull-request-build.yaml | 6 +++---
.github/workflows/scorecards.yml | 2 +-
pom.xml | 2 +-
4 files changed, 8 insertions(+), 8 deletions(-)
(directory-ldap-api) 01/06: Fixed many javadoc warnings
Posted by el...@apache.org.
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
commit 6fb23a44ef13a048b9dd970b529088b2c87d4286
Author: emmanuel lecharny <el...@apache.org>
AuthorDate: Mon Feb 3 13:55:24 2025 +0100
Fixed many javadoc warnings
---
.../ldap/client/api/AbstractLdapConnection.java | 6 +
.../api/AbstractPoolableLdapConnectionFactory.java | 7 +
.../client/api/DefaultLdapConnectionValidator.java | 9 +
.../ldap/client/api/DefaultSchemaLoader.java | 20 ++
.../client/api/LdapClientTrustStoreManager.java | 12 +-
.../directory/ldap/client/api/LdapConnection.java | 4 +
.../ldap/client/api/LdapConnectionConfig.java | 8 +
.../ldap/client/api/LdapNetworkConnection.java | 6 +
.../directory/ldap/client/api/LdifAnonymizer.java | 14 ++
.../client/api/LookupLdapConnectionValidator.java | 9 +
.../ldap/client/api/MonitoringLdapConnection.java | 8 +-
.../client/api/NoVerificationTrustManager.java | 9 +
.../ldap/client/api/PooledLdapConnection.java | 17 ++
.../ldap/client/api/future/ExtendedFuture.java | 4 +
.../ldap/client/api/future/ResponseFuture.java | 3 +
.../template/AbstractPasswordPolicyResponder.java | 6 +-
.../LdapRequestUnsuccessfulException.java | 2 +
.../template/exception/PasswordException.java | 5 +
.../api/ldap/codec/AttributeValueAssertion.java | 11 +
.../directory/api/ldap/codec/LdapStatesEnum.java | 234 ++++++++++++++++++++-
.../api/ldap/codec/api/LdapApiService.java | 10 +-
.../api/ldap/codec/api/LdapCodecConstants.java | 67 +++++-
.../api/ldap/codec/api/LdapMessageContainer.java | 59 +++++-
.../ldap/codec/api/MessageEncoderException.java | 2 +
.../directory/api/ldap/codec/api/SaslFilter.java | 29 +++
.../codec/api/SchemaBinaryAttributeDetector.java | 6 +
.../search/entryChange/EntryChangeContainer.java | 1 +
.../search/pagedSearch/PagedResultsContainer.java | 1 +
.../PersistentSearchContainer.java | 3 +-
.../search/subentries/SubentriesContainer.java | 2 +
.../codec/controls/sort/SortRequestContainer.java | 11 +-
.../codec/controls/sort/SortResponseContainer.java | 4 +
.../ldap/codec/factory/AbandonRequestFactory.java | 3 +
.../api/ldap/codec/factory/AddRequestFactory.java | 3 +
.../api/ldap/codec/factory/AddResponseFactory.java | 3 +
.../api/ldap/codec/factory/BindRequestFactory.java | 3 +
.../ldap/codec/factory/BindResponseFactory.java | 3 +
.../ldap/codec/factory/CompareRequestFactory.java | 3 +
.../ldap/codec/factory/CompareResponseFactory.java | 3 +
.../ldap/codec/factory/DeleteRequestFactory.java | 3 +
.../ldap/codec/factory/DeleteResponseFactory.java | 3 +
.../ldap/codec/factory/ExtendedRequestFactory.java | 3 +
.../codec/factory/ExtendedResponseFactory.java | 3 +
.../codec/factory/IntermediateResponseFactory.java | 3 +
.../ldap/codec/factory/ModifyDnRequestFactory.java | 3 +
.../codec/factory/ModifyDnResponseFactory.java | 3 +
.../ldap/codec/factory/ModifyRequestFactory.java | 3 +
.../ldap/codec/factory/ModifyResponseFactory.java | 3 +
.../ldap/codec/factory/SearchRequestFactory.java | 3 +
.../codec/factory/SearchResultDoneFactory.java | 3 +
.../codec/factory/SearchResultEntryFactory.java | 3 +
.../factory/SearchResultReferenceFactory.java | 3 +
.../ldap/codec/factory/UnbindRequestFactory.java | 3 +
.../ldap/codec/osgi/DefaultLdapCodecService.java | 17 ++
.../directory/api/ldap/codec/search/Filter.java | 2 +
.../api/ldap/codec/search/SubstringFilter.java | 3 +
.../api/ldap/aci/ACIItemSyntaxChecker.java | 9 +
.../AllUserAttributeTypesAndValuesItem.java | 9 +
.../protectedItem/AllUserAttributeTypesItem.java | 9 +
.../api/ldap/aci/protectedItem/EntryItem.java | 9 +
.../aci/src/test/resources/snippet/Snippet.java | 10 +
.../directory/api/ldap/util/tree/DnNode.java | 22 +-
62 files changed, 725 insertions(+), 17 deletions(-)
diff --git a/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/AbstractLdapConnection.java b/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/AbstractLdapConnection.java
index aefddd657..186e50a8d 100644
--- a/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/AbstractLdapConnection.java
+++ b/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/AbstractLdapConnection.java
@@ -69,6 +69,12 @@ public abstract class AbstractLdapConnection extends IoHandlerAdapter implements
this( LdapApiServiceFactory.getSingleton() );
}
+ /**
+ * Creates a new instance of and AbstractLdapConnection.java, with
+ * a LdapApiService instance/
+ *
+ * @param codec The LdapApiService instance to use
+ */
protected AbstractLdapConnection( LdapApiService codec )
{
messageId = new AtomicInteger( 0 );
diff --git a/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/AbstractPoolableLdapConnectionFactory.java b/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/AbstractPoolableLdapConnectionFactory.java
index 2ee8b735e..a7f19d89c 100644
--- a/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/AbstractPoolableLdapConnectionFactory.java
+++ b/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/AbstractPoolableLdapConnectionFactory.java
@@ -194,6 +194,13 @@ public abstract class AbstractPoolableLdapConnectionFactory implements PooledObj
}
+ /**
+ * Create a new LdapConnectionFactory instance
+ *
+ * @param config The connection configuration to use
+ * @param connectionFactoryClass The factory class to use
+ * @return An instance of LdapConnectionFactory
+ */
protected static LdapConnectionFactory newLdapConnectionFactory(
LdapConnectionConfig config,
Class<? extends LdapConnectionFactory> connectionFactoryClass )
diff --git a/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/DefaultLdapConnectionValidator.java b/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/DefaultLdapConnectionValidator.java
index 9ec638b0e..ea222589f 100755
--- a/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/DefaultLdapConnectionValidator.java
+++ b/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/DefaultLdapConnectionValidator.java
@@ -28,6 +28,15 @@ package org.apache.directory.ldap.client.api;
*/
public final class DefaultLdapConnectionValidator implements LdapConnectionValidator
{
+ /**
+ * A default constructor
+ */
+ public DefaultLdapConnectionValidator()
+ {
+ // Nothing to do
+ }
+
+
/**
* Returns true if <code>connection</code> is connected, and authenticated.
*
diff --git a/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/DefaultSchemaLoader.java b/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/DefaultSchemaLoader.java
index f2ddccbb7..7d3487ec1 100644
--- a/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/DefaultSchemaLoader.java
+++ b/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/DefaultSchemaLoader.java
@@ -104,6 +104,11 @@ public class DefaultSchemaLoader extends AbstractSchemaLoader
private static final NormalizerDescriptionSchemaParser N_DESCR_SCHEMA_PARSER = new NormalizerDescriptionSchemaParser();
private static final SyntaxCheckerDescriptionSchemaParser SC_DESCR_SCHEMA_PARSER = new SyntaxCheckerDescriptionSchemaParser();
+ /**
+ * A default constructor
+ *
+ * @throws LdapException If the instance creation failed
+ */
protected DefaultSchemaLoader() throws LdapException
{
// For use in subclasses
@@ -235,11 +240,21 @@ public class DefaultSchemaLoader extends AbstractSchemaLoader
loadSchemas();
}
+ /**
+ * Get the LdapConnecgion instance
+ *
+ * @return the LdapConnecgion instance
+ */
protected LdapConnection getConnection()
{
return connection;
}
+ /**
+ * Set the LdapConnection to use
+ *
+ * @param connection The LdapConnection to use
+ */
protected void setConnection( LdapConnection connection )
{
this.connection = connection;
@@ -617,6 +632,11 @@ public class DefaultSchemaLoader extends AbstractSchemaLoader
}
+ /**
+ * Update the schema with the provided schema object
+ *
+ * @param schemaObject The schema object to add to the current schema
+ */
protected void updateSchemas( SchemaObject schemaObject )
{
String schemaName = schemaObject.getSchemaName();
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 555003ff3..11369797d 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
@@ -56,18 +56,26 @@ public final class LdapClientTrustStoreManager implements X509TrustManager, Seri
/** Declares the Serial Version Uid */
private static final long serialVersionUID = 1L;
- // Logging
+ /** The class logger name */
private static final String CLS_NM = LdapClientTrustStoreManager.class.getName();
+
+ /** The class logger */
private static final Logger LOG = LoggerFactory.getLogger( CLS_NM );
- // Config variables
+ /** A flag tellling of the validity dates should be checked or not */
private boolean isExamineValidityDates;
+
+ /** The trust store password */
private char[] trustStorePw;
// This is found on the classpath if trust.store.onclasspath = true (default), otherwise must include exact location on filepath:
+ /** The trsut stre file path */
private String trustStoreFile;
+
+ /** The trust store format (one of jceks, jks or PKCS12) */
private String trustStoreFormat;
+ /** The list of TrustManagers */
private X509TrustManager[] x509TrustManagers;
diff --git a/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/LdapConnection.java b/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/LdapConnection.java
index a4f7c9867..96d8c1f07 100644
--- a/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/LdapConnection.java
+++ b/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/LdapConnection.java
@@ -829,6 +829,8 @@ public interface LdapConnection extends Closeable
/**
+ * Get the SchemaManager instance
+ *
* @return The SchemaManager associated with this LdapConection if any
*/
SchemaManager getSchemaManager();
@@ -864,6 +866,8 @@ public interface LdapConnection extends Closeable
/**
+ * Get the BinaryAttribute dectore instance
+ *
* @return the object responsible for the detection of binary attributes
*/
BinaryAttributeDetector getBinaryAttributeDetector();
diff --git a/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/LdapConnectionConfig.java b/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/LdapConnectionConfig.java
index a83dbfb51..cc9ee6978 100644
--- a/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/LdapConnectionConfig.java
+++ b/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/LdapConnectionConfig.java
@@ -667,6 +667,8 @@ public class LdapConnectionConfig
/**
+ * Get the BinaryAttribute detector instance
+ *
* @return the binaryAttributeDetector
*/
public BinaryAttributeDetector getBinaryAttributeDetector()
@@ -676,6 +678,8 @@ public class LdapConnectionConfig
/**
+ * Set the BinaryAttribute detector instance
+ *
* @param binaryAttributeDetector the binaryAttributeDetector to set
*/
public void setBinaryAttributeDetector( BinaryAttributeDetector binaryAttributeDetector )
@@ -707,6 +711,8 @@ public class LdapConnectionConfig
/**
+ * Get the the LdapApiService instance
+ *
* @return the ldapApiService
*/
public LdapApiService getLdapApiService()
@@ -716,6 +722,8 @@ public class LdapConnectionConfig
/**
+ * Set the LdapApiService instance
+ *
* @param ldapApiService the ldapApiService to set
*/
public void setLdapApiService( LdapApiService ldapApiService )
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 b723ed170..1f88fecaf 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
@@ -4687,6 +4687,8 @@ public class LdapNetworkConnection extends AbstractLdapConnection implements Lda
/**
+ * Add a Schema
+ *
* @see #addSchema(File)
* @param schemaFileName The schema file name to add
* @throws LdapException If the schema addition failed
@@ -5448,6 +5450,8 @@ public class LdapNetworkConnection extends AbstractLdapConnection implements Lda
/**
+ * Get the SockectSession configuration
+ *
* @return the socketSessionConfig
*/
public SocketSessionConfig getSocketSessionConfig()
@@ -5457,6 +5461,8 @@ public class LdapNetworkConnection extends AbstractLdapConnection implements Lda
/**
+ * Set the SockectSession configuration
+ *
* @param socketSessionConfig the socketSessionConfig to set
*/
public void setSocketSessionConfig( SocketSessionConfig socketSessionConfig )
diff --git a/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/LdifAnonymizer.java b/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/LdifAnonymizer.java
index 0676579d1..41cdfddf7 100644
--- a/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/LdifAnonymizer.java
+++ b/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/LdifAnonymizer.java
@@ -373,6 +373,8 @@ public class LdifAnonymizer
/**
+ * Get the list of configured anonymizers
+ *
* @return The list of configured anonymizers
*/
public Map<String, Anonymizer> getAttributeAnonymizers()
@@ -1021,6 +1023,8 @@ public class LdifAnonymizer
/**
+ * Get the map of stored values
+ *
* @return the valueMap
*/
public Map<Value, Value> getValueMap()
@@ -1030,6 +1034,8 @@ public class LdifAnonymizer
/**
+ * Set the map of stored values
+ *
* @param valueMap the valueMap to set
*/
public void setValueMap( Map<Value, Value> valueMap )
@@ -1039,6 +1045,8 @@ public class LdifAnonymizer
/**
+ * Get the map containing the latest anonymised Strings
+ *
* @return the latest String Value Map
*/
public Map<Integer, String> getLatestStringMap()
@@ -1048,6 +1056,8 @@ public class LdifAnonymizer
/**
+ * Set the map containing the latest anonymised Strings
+ *
* @param latestStringMap the latest String Value Map to set
*/
public void setLatestStringMap( Map<Integer, String> latestStringMap )
@@ -1057,6 +1067,8 @@ public class LdifAnonymizer
/**
+ * Get the map containing the latest anonymised bytes
+ *
* @return the latest byte[] Value Map
*/
public Map<Integer, byte[]> getLatestBytesMap()
@@ -1066,6 +1078,8 @@ public class LdifAnonymizer
/**
+ * Set the map containing the latest anonymised bytes
+ *
* @param latestBytesMap the latest byte[] Value Map to set
*/
public void setLatestBytesMap( Map<Integer, byte[]> latestBytesMap )
diff --git a/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/LookupLdapConnectionValidator.java b/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/LookupLdapConnectionValidator.java
index fd098870e..715bfac48 100755
--- a/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/LookupLdapConnectionValidator.java
+++ b/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/LookupLdapConnectionValidator.java
@@ -33,6 +33,15 @@ import org.apache.directory.api.ldap.model.name.Dn;
*/
public final class LookupLdapConnectionValidator implements LdapConnectionValidator
{
+ /**
+ * Default constructor
+ */
+ public LookupLdapConnectionValidator()
+ {
+ // nothing to do
+ }
+
+
/**
* Returns true if <code>connection</code> is connected, authenticated, and
* a lookup on the rootDSE returns a non-null response.
diff --git a/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/MonitoringLdapConnection.java b/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/MonitoringLdapConnection.java
index 6cfc7178f..e45011009 100755
--- a/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/MonitoringLdapConnection.java
+++ b/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/MonitoringLdapConnection.java
@@ -64,7 +64,9 @@ public final class MonitoringLdapConnection extends LdapConnectionWrapper
/**
- * @return tells if a Bind has been issued
+ * Tells if a Bind has been issued
+ *
+ * @return <code>true</code> if a Bind has been issued
*/
public boolean bindCalled()
{
@@ -83,7 +85,9 @@ public final class MonitoringLdapConnection extends LdapConnectionWrapper
/**
- * @return tells if the StarTLS extended operation has been called
+ * Tells if the StarTLS extended operation has been called
+ *
+ * @return <code>true</code> if the StarTLS extended operation has been called
*/
public boolean startTlsCalled()
{
diff --git a/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/NoVerificationTrustManager.java b/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/NoVerificationTrustManager.java
index 18eab6389..676525c9f 100644
--- a/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/NoVerificationTrustManager.java
+++ b/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/NoVerificationTrustManager.java
@@ -45,6 +45,15 @@ public class NoVerificationTrustManager extends X509ExtendedTrustManager
private static final Logger LOG = LoggerFactory.getLogger( NoVerificationTrustManager.class );
+ /**
+ * A public constructor
+ */
+ public NoVerificationTrustManager()
+ {
+ super();
+ }
+
+
/**
* {@inheritDoc}
*/
diff --git a/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/PooledLdapConnection.java b/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/PooledLdapConnection.java
index 1345b0cd1..5f8dcc12a 100644
--- a/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/PooledLdapConnection.java
+++ b/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/PooledLdapConnection.java
@@ -28,13 +28,25 @@ import org.apache.directory.api.ldap.model.exception.LdapException;
*/
public class PooledLdapConnection extends LdapConnectionWrapper
{
+ /** The connection pool */
private LdapConnectionPool pool;
+ /**
+ * A PooledLdapConnection instance that delegates the LdapConnection creation
+ *
+ * @param delegate The instance that will create the connection under the hood
+ */
PooledLdapConnection( LdapConnection delegate )
{
super( delegate );
}
+ /**
+ * A PooledLdapConnection instance that delegates the LdapConnection creation
+ *
+ * @param delegate The instance that will create the connection under the hood
+ * @param pool The underlying pool to use
+ */
PooledLdapConnection( LdapConnection delegate, LdapConnectionPool pool )
{
super( delegate );
@@ -54,6 +66,11 @@ public class PooledLdapConnection extends LdapConnectionWrapper
}
}
+ /**
+ * Set the connection pool to use
+ *
+ * @param pool The connection pool to use
+ */
public void setConnectionPool( LdapConnectionPool pool )
{
this.pool = pool;
diff --git a/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/future/ExtendedFuture.java b/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/future/ExtendedFuture.java
index 1c009a492..eb5abd746 100644
--- a/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/future/ExtendedFuture.java
+++ b/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/future/ExtendedFuture.java
@@ -51,6 +51,8 @@ public class ExtendedFuture extends MultipleResponseFuture<Response>
/**
+ * Get the extended request instance
+ *
* @return the extendedRequest
*/
public ExtendedRequest getExtendedRequest()
@@ -60,6 +62,8 @@ public class ExtendedFuture extends MultipleResponseFuture<Response>
/**
+ * Set the ExtendedRequest
+ *
* @param extendedRequest the extendedRequest to set
*/
public void setExtendedRequest( ExtendedRequest extendedRequest )
diff --git a/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/future/ResponseFuture.java b/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/future/ResponseFuture.java
index 63b740066..dc212f826 100644
--- a/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/future/ResponseFuture.java
+++ b/ldap/client/api/src/main/java/org/apache/directory/ldap/client/api/future/ResponseFuture.java
@@ -43,6 +43,8 @@ public interface ResponseFuture<R extends Response> extends Future<R>
/**
+ * Get the associated cause
+ *
* @return the cause
*/
Throwable getCause();
@@ -50,6 +52,7 @@ public interface ResponseFuture<R extends Response> extends Future<R>
/**
* Associate a cause to the ResponseFuture
+ *
* @param cause the cause to set
*/
void setCause( Throwable cause );
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 295ed7246..d7f96b1ae 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
@@ -44,7 +44,11 @@ public abstract class AbstractPasswordPolicyResponder implements PasswordPolicyR
{
private final PasswordPolicyResponse passwordPolicyResponseControl;
-
+ /**
+ * Creates a AbstractPasswordPolicyResponder instance
+ *
+ * @param ldapApiService The LdapApiServoce to use
+ */
protected AbstractPasswordPolicyResponder( LdapApiService ldapApiService )
{
this.passwordPolicyResponseControl = new PasswordPolicyResponseImpl();
diff --git a/ldap/client/api/src/main/java/org/apache/directory/ldap/client/template/exception/LdapRequestUnsuccessfulException.java b/ldap/client/api/src/main/java/org/apache/directory/ldap/client/template/exception/LdapRequestUnsuccessfulException.java
index e5a0356ab..03db65eb9 100755
--- a/ldap/client/api/src/main/java/org/apache/directory/ldap/client/template/exception/LdapRequestUnsuccessfulException.java
+++ b/ldap/client/api/src/main/java/org/apache/directory/ldap/client/template/exception/LdapRequestUnsuccessfulException.java
@@ -50,6 +50,8 @@ public class LdapRequestUnsuccessfulException extends RuntimeException
/**
+ * Get the associate LDAP Response
+ *
* @return the associate LDAP Response
*/
public ResultResponse getResponse()
diff --git a/ldap/client/api/src/main/java/org/apache/directory/ldap/client/template/exception/PasswordException.java b/ldap/client/api/src/main/java/org/apache/directory/ldap/client/template/exception/PasswordException.java
index 29f6c0933..c1b5e73ba 100644
--- a/ldap/client/api/src/main/java/org/apache/directory/ldap/client/template/exception/PasswordException.java
+++ b/ldap/client/api/src/main/java/org/apache/directory/ldap/client/template/exception/PasswordException.java
@@ -36,8 +36,13 @@ public class PasswordException extends Exception
/** Declares the Serial Version Uid */
private static final long serialVersionUID = -1185823188085178776L;
+ /** The wrapped exception */
private LdapException ldapException;
+
+ /** The associated result code */
private ResultCodeEnum resultCode;
+
+ /** The PasswordPolicy error code */
private PasswordPolicyErrorEnum passwordPolicyError;
diff --git a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/AttributeValueAssertion.java b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/AttributeValueAssertion.java
index 7d71104db..c2a38e5c5 100644
--- a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/AttributeValueAssertion.java
+++ b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/AttributeValueAssertion.java
@@ -48,6 +48,13 @@ public class AttributeValueAssertion
/** The assertion as we received it */
private byte[] assertion;
+ /**
+ * Default constructor
+ */
+ public AttributeValueAssertion()
+ {
+ // Nothing to do
+ }
/**
* Helper method to render an object which can be a String or a byte[]
@@ -167,6 +174,8 @@ public class AttributeValueAssertion
/**
+ * Get the Assertion
+ *
* @return the assertion
*/
public byte[] getAssertion()
@@ -176,6 +185,8 @@ public class AttributeValueAssertion
/**
+ * Set the Assertion
+ *
* @param assertion the assertion to set
*/
public void setAssertion( byte[] assertion )
diff --git a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/LdapStatesEnum.java b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/LdapStatesEnum.java
index b5b01681c..9268b4afb 100644
--- a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/LdapStatesEnum.java
+++ b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/LdapStatesEnum.java
@@ -31,125 +31,357 @@ import org.apache.directory.api.asn1.ber.grammar.States;
*/
public enum LdapStatesEnum implements States
{
- /** The END_STATE */
+ /** The various states */
+ /** AbandonRequest state */
ABANDON_REQUEST_STATE,
+
+ /** AddRequest state */
ADD_REQUEST_STATE,
+
+ /** AddResponse state */
ADD_RESPONSE_STATE,
+
+ /** And State */
AND_STATE,
+
+ /** Any State */
ANY_STATE,
+
+ /** ApproxMatch State */
APPROX_MATCH_STATE,
+
+ /** Assertion Value State */
ASSERTION_VALUE_FILTER_STATE,
+
+ /** Assertion Value Compare State */
ASSERTION_VALUE_COMP_STATE,
+
+ /** Attributes SearchRequest State */
ATTRIBUTES_SR_STATE,
+
+ /** Attributes State */
ATTRIBUTES_STATE,
+
+ /** Attribute Selection State */
ATTRIBUTE_SELECTION_STATE,
+
+ /** Attribute Description State */
ATTRIBUTE_DESC_COMP_STATE,
+
+ /** Attribute Description Filter State */
ATTRIBUTE_DESC_FILTER_STATE,
+
+ /** Attribute State */
ATTRIBUTE_STATE,
+
+ /** Attribute Value State */
ATTRIBUTE_VALUE_STATE,
+
+ /** AVA Compare State */
AVA_COMP_STATE,
+
+ /** Base Object State */
BASE_OBJECT_STATE,
+
+ /** BindRequest state */
BIND_REQUEST_STATE,
+
+ /** BindResponse state */
BIND_RESPONSE_STATE,
+
+ /** Changes State */
CHANGES_STATE,
+
+ /** Change State */
CHANGE_STATE,
+
+ /** CompareRequest state */
COMPARE_REQUEST_STATE,
+
+ /** CompareResponse state */
COMPARE_RESPONSE_STATE,
+
+ /** Controls State */
CONTROLS_STATE,
+
+ /** Control State */
CONTROL_STATE,
+
+ /** Control Type State */
CONTROL_TYPE_STATE,
+
+ /** Control Value State */
CONTROL_VALUE_STATE,
+
+ /** Credentials State */
CREDENTIALS_STATE,
+
+ /** Criticality State */
CRITICALITY_STATE,
+
+ /** Delete Old RDN State */
DELETE_OLD_RDN_STATE,
+
+ /** DelRequest state */
DEL_REQUEST_STATE,
+
+ /** DelResponse state */
DEL_RESPONSE_STATE,
+
+ /** Deref Alias State */
DEREF_ALIAS_STATE,
+
+ /** Diagnostic Message Bind Response State */
DIAGNOSTIC_MESSAGE_BR_STATE,
+
+ /** Diagnostic Message Extended Response State */
DIAGNOSTIC_MESSAGE_ER_STATE,
+
+ /** Diagnostic Message State */
DIAGNOSTIC_MESSAGE_STATE,
+
+ /** End State */
END_STATE,
+
+ /** Entry Compare State */
ENTRY_COMP_STATE,
+
+ /** Entry ModDN State */
ENTRY_MOD_DN_STATE,
+
+ /** Entry State */
ENTRY_STATE,
+
+ /** Equality Match State */
EQUALITY_MATCH_STATE,
+
+ /** ExtendedRequest state */
EXTENDED_REQUEST_STATE,
+
+ /** ExtendedResponse state */
EXTENDED_RESPONSE_STATE,
+
+ /** Extensible Match State */
EXTENSIBLE_MATCH_STATE,
+
+ /** Final State */
FINAL_STATE,
+
+ /** Freater or Equal State */
GREATER_OR_EQUAL_STATE,
+
+ /** Initial State */
INITIAL_STATE,
+
+ /** IntermediateResponse Name State */
INTERMEDIATE_RESPONSE_NAME_STATE,
+
+ /** IntermediateResponse State */
INTERMEDIATE_RESPONSE_STATE,
+
+ /** IntermediateResponse Value State */
INTERMEDIATE_RESPONSE_VALUE_STATE,
+
+ /** Ldap Message State */
LDAP_MESSAGE_STATE,
+
+ /** Less or Equal State */
LESS_OR_EQUAL_STATE,
+
+ /** Matched DN BindRequest State */
MATCHED_DN_BR_STATE,
+
+ /** Matched DN ExtendedRequest State */
MATCHED_DN_ER_STATE,
+
+ /** Matched DN State */
MATCHED_DN_STATE,
+
+ /** Mechanism State */
MECHANISM_STATE,
+
+ /** Message ID State */
MESSAGE_ID_STATE,
+
+ /** Modification State */
MODIFICATION_STATE,
+
+ /** ModifyDnRequest state */
MODIFY_DN_REQUEST_STATE,
+
+ /** ModifyDnResponse state */
MODIFY_DN_RESPONSE_STATE,
+
+ /** ModifyRequest state */
MODIFY_REQUEST_STATE,
+
+ /** ModifyResponse state */
MODIFY_RESPONSE_STATE,
+
+ /** Matching Rule Assertion DN Attributes State */
MRA_DN_ATTRIBUTES_STATE,
+
+ /** Matching Rule Assertion Matching Rule State */
MRA_MATCHING_RULE_STATE,
+
+ /** Matching Rule Assertion Type State */
MRA_TYPE_STATE,
+
+ /** Matching Rule Assertion Match Value State */
MRA_MATCH_VALUE_STATE,
+
+ /** Name State */
NAME_STATE,
+
+ /** New RDN State */
NEW_RDN_STATE,
+
+ /** New Superior State */
NEW_SUPERIOR_STATE,
+
+ /** Not State */
NOT_STATE,
+
+ /** Object NameState */
OBJECT_NAME_STATE,
+
+ /** Object State */
OBJECT_STATE,
+
+ /** Operation State */
OPERATION_STATE,
+
+ /** Or State */
OR_STATE,
+
+ /** Partial Attributes List State */
PARTIAL_ATTRIBUTES_LIST_STATE,
+
+ /** Present State */
PRESENT_STATE,
+
+ /** Reference State */
REFERENCE_STATE,
+
+ /** Referral Bind Response State */
REFERRAL_BR_STATE,
+
+ /** Referral Extended ResponseState */
REFERRAL_ER_STATE,
+
+ /** Referral State */
REFERRAL_STATE,
+
+ /** Request Name State */
REQUEST_NAME_STATE,
+
+ /** Request Value State */
REQUEST_VALUE_STATE,
+
+ /** Respobse Name State */
RESPONSE_NAME_STATE,
+
+ /** Response Value State */
RESPONSE_VALUE_STATE,
+
+ /** Result Code BindResponse State */
RESULT_CODE_BR_STATE,
+
+ /** Result Code ExtendedResponse State */
RESULT_CODE_ER_STATE,
+
+ /** Result Code State */
RESULT_CODE_STATE,
+
+ /** SASL State */
SASL_STATE,
+
+ /** Scope State */
SCOPE_STATE,
+
+ /** SearchRequest state */
SEARCH_REQUEST_STATE,
+
+ /** SearchResultDone state */
SEARCH_RESULT_DONE_STATE,
+
+ /** SearchResultEntry state */
SEARCH_RESULT_ENTRY_STATE,
+
+ /** SearchResultReference state */
SEARCH_RESULT_REFERENCE_STATE,
+
+ /** Selector State */
SELECTOR_STATE,
+
+ /** Sasl Credentials State */
SERVER_SASL_CREDENTIALS_STATE,
+
+ /** Simple State */
SIMPLE_STATE,
+
+ /** Size Limit State */
SIZE_LIMIT_STATE,
+
+ /** Starting State */
START_STATE,
+
+ /** Substrings State */
SUBSTRINGS_STATE,
+
+ /** Substrings Filter State */
SUBSTRINGS_FILTER_STATE,
+
+ /** State */
TIME_LIMIT_STATE,
+
+ /** TypesOnly State */
TYPES_ONLY_STATE,
+
+ /** Type Modification State */
TYPE_MOD_STATE,
+
+ /** Type SearchRequest State */
TYPE_SR_STATE,
+
+ /** Type State */
TYPE_STATE,
+
+ /** Typ Substring State */
TYPE_SUBSTRING_STATE,
+
+ /** UnbindRequest state */
UNBIND_REQUEST_STATE,
+
+ /** URI BindRequest State */
URI_BR_STATE,
+
+ /** URI_ER State */
URI_ER_STATE,
+
+ /** URI State */
URI_STATE,
+
+ /** Vals SearchRequest State */
VALS_SR_STATE,
+
+ /** Vals State */
VALS_STATE,
+
+ /** Values State */
VALUES_STATE,
+
+ /** Value State */
VALUE_STATE,
+
+ /** Value SearchRequest State */
VALUE_SR_STATE,
+
+ /** Version state */
VERSION_STATE,
// Keep it here it is used to create the grammar table, using its ordinal
+ /** The last state */
LAST_LDAP_STATE;
/**
diff --git a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/LdapApiService.java b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/LdapApiService.java
index 42d55802b..57a64fac0 100644
--- a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/LdapApiService.java
+++ b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/LdapApiService.java
@@ -148,6 +148,8 @@ public interface LdapApiService
/**
+ * Get the response controlFactories
+ *
* @return the response controlFactories
*/
Map<String, ControlFactory<? extends Control>> getResponseControlFactories();
@@ -233,12 +235,16 @@ public interface LdapApiService
/**
- * @return the extendedRequestFactories
+ * Get the extendedResponseFactories
+ *
+ * @return the extendedResponseFactories
*/
Map<String, ExtendedOperationFactory> getExtendedRequestFactories();
/**
+ * Get the extendedResponseFactories
+ *
* @return the extendedResponseFactories
*/
Map<String, ExtendedOperationFactory> getExtendedResponseFactories();
@@ -286,6 +292,8 @@ public interface LdapApiService
/**
+ * Get the intermediateResponseFactories
+ *
* @return the intermediateResponseFactories
*/
Map<String, IntermediateOperationFactory> getIntermediateResponseFactories();
diff --git a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/LdapCodecConstants.java b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/LdapCodecConstants.java
index f318bfae3..d2b399563 100644
--- a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/LdapCodecConstants.java
+++ b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/LdapCodecConstants.java
@@ -27,141 +27,202 @@ package org.apache.directory.api.ldap.codec.api;
*/
public final class LdapCodecConstants
{
- /** The scope constants */
+ /** The Base Object scope constants */
public static final int SCOPE_BASE_OBJECT = 0;
+ /** The Single Level scope constants */
public static final int SCOPE_SINGLE_LEVEL = 1;
+ /** The Whole Subtree scope constants */
public static final int SCOPE_WHOLE_SUBTREE = 2;
/** The DerefAlias constants */
public static final int NEVER_DEREF_ALIASES = 0;
+ /** The Deref In Searching constants */
public static final int DEREF_IN_SEARCHING = 1;
+ /** The Deref Finding Base constants */
public static final int DEREF_FINDING_BASE_OBJ = 2;
+ /** The Deref Always constants */
public static final int DEREF_ALWAYS = 3;
- /** The operations */
+ /** The Add operation */
public static final int OPERATION_ADD = 0;
+ /** The Delete operation */
public static final int OPERATION_DELETE = 1;
+ /** The Replace operation */
public static final int OPERATION_REPLACE = 2;
+ /** The Increment operation */
public static final int OPERATION_INCREMENT = 3;
- /** The filters */
+ /** The Equality Match filter */
public static final int EQUALITY_MATCH_FILTER = 0;
+ /** The Greater or Equal filter */
public static final int GREATER_OR_EQUAL_FILTER = 1;
+ /** The Less or Equal filter */
public static final int LESS_OR_EQUAL_FILTER = 2;
+ /** The Approx Match filter */
public static final int APPROX_MATCH_FILTER = 3;
/** LDAP contextual tags */
+ /** Unbind Request tag */
public static final byte UNBIND_REQUEST_TAG = 0x42;
+ /** UnbDelind Request tag */
public static final byte DEL_REQUEST_TAG = 0x4A;
+ /** Abandon Request tag */
public static final byte ABANDON_REQUEST_TAG = 0x50;
+ /** Bind Request tag */
public static final byte BIND_REQUEST_TAG = 0x60;
+ /** Bind Response tag */
public static final byte BIND_RESPONSE_TAG = 0x61;
+ /** Unbind Request tag */
public static final byte SEARCH_REQUEST_TAG = 0x63;
+ /** Search Result Entry Response tag */
public static final byte SEARCH_RESULT_ENTRY_TAG = 0x64;
+ /** Search Result Done Response tag */
public static final byte SEARCH_RESULT_DONE_TAG = 0x65;
+ /** Modify Request tag */
public static final byte MODIFY_REQUEST_TAG = 0x66;
+ /** Modify Response tag */
public static final byte MODIFY_RESPONSE_TAG = 0x67;
+ /** Add Request tag */
public static final byte ADD_REQUEST_TAG = 0x68;
+ /** Add Response tag */
public static final byte ADD_RESPONSE_TAG = 0x69;
+ /** Del Response tag */
public static final byte DEL_RESPONSE_TAG = 0x6B;
+ /** ModifyDN Request tag */
public static final byte MODIFY_DN_REQUEST_TAG = 0x6C;
+ /** ModifyDN Response tag */
public static final byte MODIFY_DN_RESPONSE_TAG = 0x6D;
+ /** Compare Request tag */
public static final byte COMPARE_REQUEST_TAG = 0x6E;
+ /** Compare Response tag */
public static final byte COMPARE_RESPONSE_TAG = 0x6F;
+ /** Search Result Reference Response tag */
public static final byte SEARCH_RESULT_REFERENCE_TAG = 0x73;
+ /** Extended Request tag */
public static final byte EXTENDED_REQUEST_TAG = 0x77;
+ /** Extended Response tag */
public static final byte EXTENDED_RESPONSE_TAG = 0x78;
+ /** Intermediate Response tag */
public static final byte INTERMEDIATE_RESPONSE_TAG = 0x79;
// The following tags are ints, because bytes above 127 are negative
// numbers, and we can't use them as array indexes.
+ /** Bind Request Simple tag */
public static final int BIND_REQUEST_SIMPLE_TAG = 0x80;
+ /** Extended Request Name tag */
public static final int EXTENDED_REQUEST_NAME_TAG = 0x80;
+ /** ModifyDN Request New Superior tag */
public static final int MODIFY_DN_REQUEST_NEW_SUPERIOR_TAG = 0x80;
+ /** Substrings Filter Initial tag */
public static final int SUBSTRINGS_FILTER_INITIAL_TAG = 0x80;
+ /** Extended Request Value tag */
public static final int EXTENDED_REQUEST_VALUE_TAG = 0x81;
+ /** Matching Rule ID tag */
public static final int MATCHING_RULE_ID_TAG = 0x81;
+ /** Substrings Filter Any tag */
public static final int SUBSTRINGS_FILTER_ANY_TAG = 0x81;
+ /** Matching Rule Type tag */
public static final int MATCHING_RULE_TYPE_TAG = 0x82;
+ /** Substrinngs Filter Final tag */
public static final int SUBSTRINGS_FILTER_FINAL_TAG = 0x82;
+ /** Match Value tag */
public static final int MATCH_VALUE_TAG = 0x83;
+ /** DN Attributes Filter tag */
public static final int DN_ATTRIBUTES_FILTER_TAG = 0x84;
+ /** Server SASL Credentials tag */
public static final int SERVER_SASL_CREDENTIAL_TAG = 0x87;
+ /** Present Filter tag */
public static final int PRESENT_FILTER_TAG = 0x87;
+ /** Extended Response Name tag */
public static final int EXTENDED_RESPONSE_NAME_TAG = 0x8A;
+ /** Extended Response Value tag */
public static final int EXTENDED_RESPONSE_VALUE_TAG = 0x8B;
+ /** Controls tag */
public static final int CONTROLS_TAG = 0xA0;
+ /** And Filter tag */
public static final int AND_FILTER_TAG = 0xA0;
+ /** Intermediate Response Name tag */
public static final int INTERMEDIATE_RESPONSE_NAME_TAG = 0x80;
+ /** Intermediate Response Value tag */
public static final int INTERMEDIATE_RESPONSE_VALUE_TAG = 0x81;
+ /** Or Filter tag */
public static final int OR_FILTER_TAG = 0xA1;
+ /** Not Filter tag */
public static final int NOT_FILTER_TAG = 0xA2;
+ /** Bind Request SASL tag */
public static final int BIND_REQUEST_SASL_TAG = 0xA3;
+ /** LDAP Result Refrral Sequence Tag */
public static final int LDAP_RESULT_REFERRAL_SEQUENCE_TAG = 0xA3;
+ /** Equality Match Filter tag */
public static final int EQUALITY_MATCH_FILTER_TAG = 0xA3;
+ /** Substrings Filter tag */
public static final int SUBSTRINGS_FILTER_TAG = 0xA4;
+ /** Greater Or Equal Filter tag */
public static final int GREATER_OR_EQUAL_FILTER_TAG = 0xA5;
+ /** Ledss or Equal Filter tag */
public static final int LESS_OR_EQUAL_FILTER_TAG = 0xA6;
+ /** Approox Match Filter tag */
public static final int APPROX_MATCH_FILTER_TAG = 0xA8;
+ /** Extensible Match Filter tag */
public static final int EXTENSIBLE_MATCH_FILTER_TAG = 0xA9;
/**
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 c8e7f38d6..6da3063dc 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
@@ -138,6 +138,8 @@ public class LdapMessageContainer<E extends Message> extends AbstractContainer
/**
+ * Get the currrent message
+ *
* @return Returns the ldapMessage.
*/
public E getMessage()
@@ -183,8 +185,10 @@ public class LdapMessageContainer<E extends Message> extends AbstractContainer
/**
- * @return Returns true if the attribute is binary.
- * @param id checks if an attribute id is binary
+ * Tells if a specific attribute is binary
+ *
+ * @param id The attribute id to check
+ * @return Returns <code>true</code> if the attribute is binary.
*/
public boolean isBinary( String id )
{
@@ -193,6 +197,8 @@ public class LdapMessageContainer<E extends Message> extends AbstractContainer
/**
+ * Get the message ID
+ *
* @return The message ID
*/
public int getMessageId()
@@ -203,6 +209,7 @@ public class LdapMessageContainer<E extends Message> extends AbstractContainer
/**
* Set the message ID
+ *
* @param messageId the id of the message
*/
public void setMessageId( int messageId )
@@ -212,6 +219,8 @@ public class LdapMessageContainer<E extends Message> extends AbstractContainer
/**
+ * Get the current control
+ *
* @return the current control being created
*/
public Control getCurrentControl()
@@ -222,6 +231,7 @@ public class LdapMessageContainer<E extends Message> extends AbstractContainer
/**
* Store a newly created control
+ *
* @param currentControl The control to store
*/
public void setCurrentControl( Control currentControl )
@@ -231,7 +241,7 @@ public class LdapMessageContainer<E extends Message> extends AbstractContainer
/**
- * Sets the binary attribute detector
+ * Set the binary attribute detector
*
* @param binaryAttributeDetector the binary attribute detector
*/
@@ -242,6 +252,8 @@ public class LdapMessageContainer<E extends Message> extends AbstractContainer
/**
+ * Get the BinaryAttributeDetector instance
+ *
* @return the binary attribute detector
*/
public BinaryAttributeDetector getBinaryAttributeDetector()
@@ -251,6 +263,8 @@ public class LdapMessageContainer<E extends Message> extends AbstractContainer
/**
+ * Get the LdapResult
+ *
* @return the ldapResult
*/
public LdapResult getLdapResult()
@@ -260,6 +274,8 @@ public class LdapMessageContainer<E extends Message> extends AbstractContainer
/**
+ * Set the LdapResult
+ *
* @param ldapResult the ldapResult to set
*/
public void setLdapResult( LdapResult ldapResult )
@@ -269,6 +285,8 @@ public class LdapMessageContainer<E extends Message> extends AbstractContainer
/**
+ * Get the Control factory
+ *
* @return the controlFactory
*/
public ControlFactory<?> getControlFactory()
@@ -278,6 +296,8 @@ public class LdapMessageContainer<E extends Message> extends AbstractContainer
/**
+ * Set the Control factory
+ *
* @param controlFactory the controlFactory to set
*/
public void setControlFactory( ControlFactory<?> controlFactory )
@@ -287,6 +307,8 @@ public class LdapMessageContainer<E extends Message> extends AbstractContainer
/**
+ * Get the current attribute
+ *
* @return the currentAttribute
*/
public Attribute getCurrentAttribute()
@@ -296,6 +318,8 @@ public class LdapMessageContainer<E extends Message> extends AbstractContainer
/**
+ * Set the current attribute
+ *
* @param currentAttribute the currentAttribute to set
*/
public void setCurrentAttribute( Attribute currentAttribute )
@@ -305,6 +329,8 @@ public class LdapMessageContainer<E extends Message> extends AbstractContainer
/**
+ * Get the currrent modification
+ *
* @return the currentModification
*/
public Modification getCurrentModification()
@@ -314,6 +340,8 @@ public class LdapMessageContainer<E extends Message> extends AbstractContainer
/**
+ * Set the currrent modification
+ *
* @param currentModification the currentModification to set
*/
public void setCurrentModification( Modification currentModification )
@@ -324,6 +352,7 @@ public class LdapMessageContainer<E extends Message> extends AbstractContainer
/**
* Set the SearchRequest PDU TLV's Id
+ *
* @param tlvId The TLV id
*/
public void setTlvId( int tlvId )
@@ -333,6 +362,8 @@ public class LdapMessageContainer<E extends Message> extends AbstractContainer
/**
+ * Get the terminal Filter
+ *
* @return the terminalFilter
*/
public Filter getTerminalFilter()
@@ -342,6 +373,8 @@ public class LdapMessageContainer<E extends Message> extends AbstractContainer
/**
+ * Set the terminal Filter
+ *
* @param terminalFilter the terminalFilter to set
*/
public void setTerminalFilter( Filter terminalFilter )
@@ -351,6 +384,7 @@ public class LdapMessageContainer<E extends Message> extends AbstractContainer
/**
+ * Get the current Filter
* @return the currentFilter
*/
public Filter getCurrentFilter()
@@ -360,6 +394,8 @@ public class LdapMessageContainer<E extends Message> extends AbstractContainer
/**
+ * Set the current Filter
+ *
* @param currentFilter the currentFilter to set
*/
public void setCurrentFilter( Filter currentFilter )
@@ -490,6 +526,8 @@ public class LdapMessageContainer<E extends Message> extends AbstractContainer
/**
+ * Get the TopFilter element
+ *
* @return the topFilter
*/
public Filter getTopFilter()
@@ -499,6 +537,8 @@ public class LdapMessageContainer<E extends Message> extends AbstractContainer
/**
+ * Set the TopFilter element
+ *
* @param topFilter the topFilter to set
*/
public void setTopFilter( Filter topFilter )
@@ -508,6 +548,8 @@ public class LdapMessageContainer<E extends Message> extends AbstractContainer
/**
+ * Get the TLV ID
+ *
* @return the tlvId
*/
public int getTlvId()
@@ -517,6 +559,8 @@ public class LdapMessageContainer<E extends Message> extends AbstractContainer
/**
+ * Get the IntermediateMessage factory instance
+ *
* @return the intermediateFactory
*/
public IntermediateOperationFactory getIntermediateFactory()
@@ -526,6 +570,8 @@ public class LdapMessageContainer<E extends Message> extends AbstractContainer
/**
+ * Set the IntermediateMessage factory instance
+ *
* @param intermediateFactory the intermediateFactory to set
*/
public void setIntermediateFactory( IntermediateOperationFactory intermediateFactory )
@@ -535,6 +581,8 @@ public class LdapMessageContainer<E extends Message> extends AbstractContainer
/**
+ * Get the ExtendedRequest factory
+ *
* @return the extendedFactory
*/
public ExtendedOperationFactory getExtendedFactory()
@@ -544,6 +592,8 @@ public class LdapMessageContainer<E extends Message> extends AbstractContainer
/**
+ * Set the ExtendedRequest factory
+ *
* @param extendedFactory the extendedFactory to set
*/
public void setExtendedFactory( ExtendedOperationFactory extendedFactory )
@@ -553,6 +603,7 @@ public class LdapMessageContainer<E extends Message> extends AbstractContainer
/**
+ * Get the DnFactory instance
* @return the dnFactory
*/
public DnFactory getDnFactory()
@@ -562,6 +613,8 @@ public class LdapMessageContainer<E extends Message> extends AbstractContainer
/**
+ * Set the DnFactory instance
+ *
* @param dnFactory the dnFactory to set
*/
public void setDnFactory( DnFactory dnFactory )
diff --git a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/MessageEncoderException.java b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/MessageEncoderException.java
index 6449a00e0..1ab5fb20b 100644
--- a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/MessageEncoderException.java
+++ b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/MessageEncoderException.java
@@ -66,6 +66,8 @@ public class MessageEncoderException extends EncoderException
/**
+ * Get the message ID
+ *
* @return the messageId
*/
public int getMessageId()
diff --git a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/SaslFilter.java b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/SaslFilter.java
index 3e6450829..2f3c40db6 100644
--- a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/SaslFilter.java
+++ b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/SaslFilter.java
@@ -47,6 +47,7 @@ import org.slf4j.LoggerFactory;
*/
public class SaslFilter extends IoFilterAdapter
{
+ /** The class logger */
private static final Logger LOG = LoggerFactory.getLogger( SaslFilter.class );
/**
@@ -128,6 +129,11 @@ public class SaslFilter extends IoFilterAdapter
}
+ /**
+ * Initialize the QoP flag
+ *
+ * @param qop Contain the desire QoP. If 'auth-int' or ''auth-conf', will be set to <code>true</code>
+ */
private void initHasSecurityLayer( String qop )
{
this.hasSecurityLayer = ( qop != null && ( qop.equals( SaslQoP.AUTH_INT.getValue() ) || qop
@@ -135,6 +141,11 @@ public class SaslFilter extends IoFilterAdapter
}
+ /**
+ * Initialize the maximum buffer size
+ *
+ * @param maxBuffer The maximum buffer size. Default to 65536 if the provided value is null
+ */
private void initMaxBuffer( String maxBuffer )
{
this.maxBufferSize = maxBuffer != null ? Integer.parseInt( maxBuffer ) : 65536;
@@ -277,6 +288,15 @@ public class SaslFilter extends IoFilterAdapter
}
+ /**
+ * Wrap a message into the SaslClient or SaslServer
+ *
+ * @param buffer The buffer containing the message to send
+ * @param offset The starting position in the buffer to use
+ * @param length The length of the message
+ * @return The resulting non null message
+ * @throws SaslException If the message cannot be wrapped
+ */
private byte[] wrap( byte[] buffer, int offset, int length ) throws SaslException
{
if ( saslClient != null )
@@ -290,6 +310,15 @@ public class SaslFilter extends IoFilterAdapter
}
+ /**
+ * Unrap a received message from the SaslClient or SaslServer
+ *
+ * @param buffer The buffer containing the received message
+ * @param offset The starting position in the received buffer
+ * @param length The length of the received message
+ * @return The resulting non null message
+ * @throws SaslException If the message cannot be unwrapped
+ */
private byte[] unwrap( byte[] buffer, int offset, int length ) throws SaslException
{
if ( saslClient != null )
diff --git a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/SchemaBinaryAttributeDetector.java b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/SchemaBinaryAttributeDetector.java
index f5744d0b3..a548bc035 100644
--- a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/SchemaBinaryAttributeDetector.java
+++ b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/SchemaBinaryAttributeDetector.java
@@ -36,8 +36,12 @@ public class SchemaBinaryAttributeDetector implements BinaryAttributeDetector
private SchemaManager schemaManager;
+ /**
+ * A default constructor
+ */
protected SchemaBinaryAttributeDetector()
{
+ // Nothing to do
}
@@ -52,6 +56,8 @@ public class SchemaBinaryAttributeDetector implements BinaryAttributeDetector
}
/**
+ * Set the SchemaManager
+ *
* @param schemaManager the schemaManager to set
*/
public void setSchemaManager( SchemaManager schemaManager )
diff --git a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/search/entryChange/EntryChangeContainer.java b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/search/entryChange/EntryChangeContainer.java
index 3e5fa0ce7..e7a3f6e1f 100644
--- a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/search/entryChange/EntryChangeContainer.java
+++ b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/search/entryChange/EntryChangeContainer.java
@@ -51,6 +51,7 @@ public class EntryChangeContainer extends AbstractContainer implements ControlCo
/**
+ * Get the EntryChange control
* @return Returns the EntryChangeControl.
*/
public EntryChange getEntryChange()
diff --git a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/search/pagedSearch/PagedResultsContainer.java b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/search/pagedSearch/PagedResultsContainer.java
index 73038f0ac..0d9301b3c 100644
--- a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/search/pagedSearch/PagedResultsContainer.java
+++ b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/search/pagedSearch/PagedResultsContainer.java
@@ -65,6 +65,7 @@ public class PagedResultsContainer extends AbstractContainer implements ControlC
/**
+ * Get the PagedResults control
* @return the control
*/
public PagedResults getPagedResults()
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 2afc368b2..f7dcaac14 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
@@ -52,11 +52,12 @@ public class PersistentSearchContainer extends AbstractContainer implements Cont
/**
+ * Get the PërsistentSearch decorator
+ *
* @return Returns the persistent search decorator.
*/
public PersistentSearch getPersistentSearch()
{
-
return ( PersistentSearch ) control;
}
diff --git a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/search/subentries/SubentriesContainer.java b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/search/subentries/SubentriesContainer.java
index 5cbe3949b..410199a1d 100644
--- a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/search/subentries/SubentriesContainer.java
+++ b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/search/subentries/SubentriesContainer.java
@@ -52,6 +52,8 @@ public class SubentriesContainer extends AbstractContainer implements ControlCon
/**
+ * Get the Subentries control
+ *
* @return Returns the persistent search control.
*/
public Subentries getSubentriesControl()
diff --git a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/sort/SortRequestContainer.java b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/sort/SortRequestContainer.java
index 39e05413e..a7d24d516 100644
--- a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/sort/SortRequestContainer.java
+++ b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/sort/SortRequestContainer.java
@@ -55,6 +55,8 @@ public class SortRequestContainer extends AbstractContainer implements ControlCo
/**
+ * Get the SortRequest control
+ *
* @return the control
*/
public SortRequest getControl()
@@ -64,10 +66,11 @@ public class SortRequestContainer extends AbstractContainer implements ControlCo
/**
+ * Set the control
+ *
* @param control the control to set
*/
- public void setControl( Control
- control )
+ public void setControl( Control control )
{
this.control = control;
}
@@ -85,6 +88,8 @@ public class SortRequestContainer extends AbstractContainer implements ControlCo
/**
+ * Get the current key
+ *
* @return the currentKey
*/
public SortKey getCurrentKey()
@@ -94,6 +99,8 @@ public class SortRequestContainer extends AbstractContainer implements ControlCo
/**
+ * Set the current key
+ *
* @param currentKey the currentKey to set
*/
public void setCurrentKey( SortKey currentKey )
diff --git a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/sort/SortResponseContainer.java b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/sort/SortResponseContainer.java
index 5775906ee..475dd1af4 100644
--- a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/sort/SortResponseContainer.java
+++ b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/sort/SortResponseContainer.java
@@ -51,6 +51,8 @@ public class SortResponseContainer extends AbstractContainer implements ControlC
/**
+ * Get the SoreResponse control
+ *
* @return the control
*/
public SortResponse getControl()
@@ -60,6 +62,8 @@ public class SortResponseContainer extends AbstractContainer implements ControlC
/**
+ * Set the control
+ *
* @param control the control to set
*/
public void setControl( Control control )
diff --git a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/factory/AbandonRequestFactory.java b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/factory/AbandonRequestFactory.java
index 7c40ecf6b..b427bc51d 100644
--- a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/factory/AbandonRequestFactory.java
+++ b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/factory/AbandonRequestFactory.java
@@ -36,6 +36,9 @@ public final class AbandonRequestFactory implements Messagefactory
/** The static instance */
public static final AbandonRequestFactory INSTANCE = new AbandonRequestFactory();
+ /**
+ * A default private constructor
+ */
private AbandonRequestFactory()
{
// Nothing to do
diff --git a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/factory/AddRequestFactory.java b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/factory/AddRequestFactory.java
index 276be2712..49b868d1f 100644
--- a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/factory/AddRequestFactory.java
+++ b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/factory/AddRequestFactory.java
@@ -43,6 +43,9 @@ public final class AddRequestFactory implements Messagefactory
/** The static instance */
public static final AddRequestFactory INSTANCE = new AddRequestFactory();
+ /**
+ * A default private constructor
+ */
private AddRequestFactory()
{
// Nothing to do
diff --git a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/factory/AddResponseFactory.java b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/factory/AddResponseFactory.java
index 5198d9799..48798f288 100644
--- a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/factory/AddResponseFactory.java
+++ b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/factory/AddResponseFactory.java
@@ -34,6 +34,9 @@ public final class AddResponseFactory extends ResponseFactory
/** The static instance */
public static final AddResponseFactory INSTANCE = new AddResponseFactory();
+ /**
+ * A default private constructor
+ */
private AddResponseFactory()
{
super();
diff --git a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/factory/BindRequestFactory.java b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/factory/BindRequestFactory.java
index 55f7a05ce..aa2791e08 100644
--- a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/factory/BindRequestFactory.java
+++ b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/factory/BindRequestFactory.java
@@ -38,6 +38,9 @@ public final class BindRequestFactory implements Messagefactory
/** The static instance */
public static final BindRequestFactory INSTANCE = new BindRequestFactory();
+ /**
+ * A default private constructor
+ */
private BindRequestFactory()
{
// Nothing to do
diff --git a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/factory/BindResponseFactory.java b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/factory/BindResponseFactory.java
index 9231b7a43..53e349864 100644
--- a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/factory/BindResponseFactory.java
+++ b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/factory/BindResponseFactory.java
@@ -36,6 +36,9 @@ public final class BindResponseFactory extends ResponseFactory
/** The static instance */
public static final BindResponseFactory INSTANCE = new BindResponseFactory();
+ /**
+ * A default private constructor
+ */
private BindResponseFactory()
{
super();
diff --git a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/factory/CompareRequestFactory.java b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/factory/CompareRequestFactory.java
index bb778c0ba..81518eaeb 100644
--- a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/factory/CompareRequestFactory.java
+++ b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/factory/CompareRequestFactory.java
@@ -36,6 +36,9 @@ public final class CompareRequestFactory implements Messagefactory
/** The static instance */
public static final CompareRequestFactory INSTANCE = new CompareRequestFactory();
+ /**
+ * A default private constructor
+ */
private CompareRequestFactory()
{
// Nothing to do
diff --git a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/factory/CompareResponseFactory.java b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/factory/CompareResponseFactory.java
index 3d82661a2..17dc16e4a 100644
--- a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/factory/CompareResponseFactory.java
+++ b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/factory/CompareResponseFactory.java
@@ -34,6 +34,9 @@ public final class CompareResponseFactory extends ResponseFactory
/** The static instance */
public static final CompareResponseFactory INSTANCE = new CompareResponseFactory();
+ /**
+ * A default private constructor
+ */
private CompareResponseFactory()
{
super();
diff --git a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/factory/DeleteRequestFactory.java b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/factory/DeleteRequestFactory.java
index c1bbd9fe0..a3dea0ad0 100644
--- a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/factory/DeleteRequestFactory.java
+++ b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/factory/DeleteRequestFactory.java
@@ -37,6 +37,9 @@ public final class DeleteRequestFactory implements Messagefactory
/** The static instance */
public static final DeleteRequestFactory INSTANCE = new DeleteRequestFactory();
+ /**
+ * A default private constructor
+ */
private DeleteRequestFactory()
{
// Nothing to do
diff --git a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/factory/DeleteResponseFactory.java b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/factory/DeleteResponseFactory.java
index e29968d7d..ff0b9803a 100644
--- a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/factory/DeleteResponseFactory.java
+++ b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/factory/DeleteResponseFactory.java
@@ -34,6 +34,9 @@ public final class DeleteResponseFactory extends ResponseFactory
/** The static instance */
public static final DeleteResponseFactory INSTANCE = new DeleteResponseFactory();
+ /**
+ * A default private constructor
+ */
private DeleteResponseFactory()
{
super();
diff --git a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/factory/ExtendedRequestFactory.java b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/factory/ExtendedRequestFactory.java
index f5771218a..27e5bf089 100644
--- a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/factory/ExtendedRequestFactory.java
+++ b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/factory/ExtendedRequestFactory.java
@@ -38,6 +38,9 @@ public final class ExtendedRequestFactory implements Messagefactory
/** The static instance */
public static final ExtendedRequestFactory INSTANCE = new ExtendedRequestFactory();
+ /**
+ * A default private constructor
+ */
private ExtendedRequestFactory()
{
super();
diff --git a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/factory/ExtendedResponseFactory.java b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/factory/ExtendedResponseFactory.java
index b31901c0f..45f86bb33 100644
--- a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/factory/ExtendedResponseFactory.java
+++ b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/factory/ExtendedResponseFactory.java
@@ -39,6 +39,9 @@ public final class ExtendedResponseFactory extends ResponseFactory
/** The static instance */
public static final ExtendedResponseFactory INSTANCE = new ExtendedResponseFactory();
+ /**
+ * A default private constructor
+ */
private ExtendedResponseFactory()
{
super();
diff --git a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/factory/IntermediateResponseFactory.java b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/factory/IntermediateResponseFactory.java
index c05306d26..5eaeda8a3 100644
--- a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/factory/IntermediateResponseFactory.java
+++ b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/factory/IntermediateResponseFactory.java
@@ -38,6 +38,9 @@ public final class IntermediateResponseFactory extends ResponseFactory
/** The static instance */
public static final IntermediateResponseFactory INSTANCE = new IntermediateResponseFactory();
+ /**
+ * A default private constructor
+ */
private IntermediateResponseFactory()
{
super();
diff --git a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/factory/ModifyDnRequestFactory.java b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/factory/ModifyDnRequestFactory.java
index 8069e4961..5fcbb8a52 100644
--- a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/factory/ModifyDnRequestFactory.java
+++ b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/factory/ModifyDnRequestFactory.java
@@ -41,6 +41,9 @@ public final class ModifyDnRequestFactory implements Messagefactory
/** The static instance */
public static final ModifyDnRequestFactory INSTANCE = new ModifyDnRequestFactory();
+ /**
+ * A default private constructor
+ */
private ModifyDnRequestFactory()
{
// Nothing to do
diff --git a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/factory/ModifyDnResponseFactory.java b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/factory/ModifyDnResponseFactory.java
index 717e6dc6c..1f0d101d7 100644
--- a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/factory/ModifyDnResponseFactory.java
+++ b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/factory/ModifyDnResponseFactory.java
@@ -34,6 +34,9 @@ public final class ModifyDnResponseFactory extends ResponseFactory
/** The static instance */
public static final ModifyDnResponseFactory INSTANCE = new ModifyDnResponseFactory();
+ /**
+ * A default private constructor
+ */
private ModifyDnResponseFactory()
{
super();
diff --git a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/factory/ModifyRequestFactory.java b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/factory/ModifyRequestFactory.java
index 77f380c6c..3f33e2e5c 100644
--- a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/factory/ModifyRequestFactory.java
+++ b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/factory/ModifyRequestFactory.java
@@ -44,6 +44,9 @@ public final class ModifyRequestFactory implements Messagefactory
/** The static instance */
public static final ModifyRequestFactory INSTANCE = new ModifyRequestFactory();
+ /**
+ * A default private constructor
+ */
private ModifyRequestFactory()
{
// Nothing to do
diff --git a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/factory/ModifyResponseFactory.java b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/factory/ModifyResponseFactory.java
index a887418ab..fe88ab9c4 100644
--- a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/factory/ModifyResponseFactory.java
+++ b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/factory/ModifyResponseFactory.java
@@ -34,6 +34,9 @@ public final class ModifyResponseFactory extends ResponseFactory
/** The static instance */
public static final ModifyResponseFactory INSTANCE = new ModifyResponseFactory();
+ /**
+ * A default private constructor
+ */
private ModifyResponseFactory()
{
super();
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 5252cf07a..8561cad44 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
@@ -53,6 +53,9 @@ public final class SearchRequestFactory implements Messagefactory
/** The static instance */
public static final SearchRequestFactory INSTANCE = new SearchRequestFactory();
+ /**
+ * A default private constructor
+ */
private SearchRequestFactory()
{
// Nothing to do
diff --git a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/factory/SearchResultDoneFactory.java b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/factory/SearchResultDoneFactory.java
index d3a77278d..caede2ee0 100644
--- a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/factory/SearchResultDoneFactory.java
+++ b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/factory/SearchResultDoneFactory.java
@@ -34,6 +34,9 @@ public final class SearchResultDoneFactory extends ResponseFactory
/** The static instance */
public static final SearchResultDoneFactory INSTANCE = new SearchResultDoneFactory();
+ /**
+ * A default private constructor
+ */
private SearchResultDoneFactory()
{
super();
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 33816c858..227212267 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
@@ -42,6 +42,9 @@ public final class SearchResultEntryFactory extends ResponseFactory
/** The static instance */
public static final SearchResultEntryFactory INSTANCE = new SearchResultEntryFactory();
+ /**
+ * A default private constructor
+ */
private SearchResultEntryFactory()
{
super();
diff --git a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/factory/SearchResultReferenceFactory.java b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/factory/SearchResultReferenceFactory.java
index dabbb42c7..e70ab1343 100644
--- a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/factory/SearchResultReferenceFactory.java
+++ b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/factory/SearchResultReferenceFactory.java
@@ -37,6 +37,9 @@ public final class SearchResultReferenceFactory extends ResponseFactory
/** The static instance */
public static final SearchResultReferenceFactory INSTANCE = new SearchResultReferenceFactory();
+ /**
+ * A default private constructor
+ */
private SearchResultReferenceFactory()
{
super();
diff --git a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/factory/UnbindRequestFactory.java b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/factory/UnbindRequestFactory.java
index 7aad2e45b..20293bccf 100644
--- a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/factory/UnbindRequestFactory.java
+++ b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/factory/UnbindRequestFactory.java
@@ -35,6 +35,9 @@ public final class UnbindRequestFactory implements Messagefactory
/** The static instance */
public static final UnbindRequestFactory INSTANCE = new UnbindRequestFactory();
+ /**
+ * A default private constructor
+ */
private UnbindRequestFactory()
{
// Nothing to do
diff --git a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/osgi/DefaultLdapCodecService.java b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/osgi/DefaultLdapCodecService.java
index 24b93145a..323989d8b 100644
--- a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/osgi/DefaultLdapCodecService.java
+++ b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/osgi/DefaultLdapCodecService.java
@@ -633,6 +633,8 @@ public class DefaultLdapCodecService implements LdapApiService
/**
+ * Set the request controlFactories
+ *
* @param requestControlFactories the request controlFactories to set
*/
public void setRequestControlFactories( Map<String, ControlFactory<? extends Control>> requestControlFactories )
@@ -642,6 +644,8 @@ public class DefaultLdapCodecService implements LdapApiService
/**
+ * Set the response controlFactories
+ *
* @param responseControlFactories the response controlFactories to set
*/
public void setResponseControlFactories( Map<String, ControlFactory<? extends Control>> responseControlFactories )
@@ -651,6 +655,8 @@ public class DefaultLdapCodecService implements LdapApiService
/**
+ * Get the extendedRequestFactories
+ *
* @return the extendedRequestFactories
*/
public Map<String, ExtendedOperationFactory> getExtendedRequestFactories()
@@ -660,6 +666,7 @@ public class DefaultLdapCodecService implements LdapApiService
/**
+ * Get the extendedResponsetFactories
* @return the extendedResponseFactories
*/
@Override
@@ -670,6 +677,8 @@ public class DefaultLdapCodecService implements LdapApiService
/**
+ * Get the intermediateResponseFactories
+ *
* @return the intermediateResponseFactories
*/
public Map<String, IntermediateOperationFactory> getIntermediateResponseFactories()
@@ -679,6 +688,8 @@ public class DefaultLdapCodecService implements LdapApiService
/**
+ * Set the extendedRequestFactories
+ *
* @param extendedOperationFactories the extendedOperationFactories to set
*/
public void setExtendedRequestFactories( Map<String, ExtendedOperationFactory> extendedOperationFactories )
@@ -688,6 +699,8 @@ public class DefaultLdapCodecService implements LdapApiService
/**
+ * Set the extendedOperationFactories
+ *
* @param extendedOperationFactories the extendedOperationFactories to set
*/
public void setExtendedResponseFactories( Map<String, ExtendedOperationFactory> extendedOperationFactories )
@@ -697,6 +710,8 @@ public class DefaultLdapCodecService implements LdapApiService
/**
+ * Set the intermediateResponseFactories
+ *
* @param intermediateResponseFactories the intermediateResponseFactories to set
*/
public void setIntermediateResponseFactories( Map<String, IntermediateOperationFactory> intermediateResponseFactories )
@@ -706,6 +721,8 @@ public class DefaultLdapCodecService implements LdapApiService
/**
+ * Set the protocolCodecFactory
+ *
* @param protocolCodecFactory the protocolCodecFactory to set
*/
public void setProtocolCodecFactory( ProtocolCodecFactory protocolCodecFactory )
diff --git a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/search/Filter.java b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/search/Filter.java
index 1f098209c..becf788f5 100644
--- a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/search/Filter.java
+++ b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/search/Filter.java
@@ -99,6 +99,8 @@ public abstract class Filter
/**
+ * Get the TLV ID
+ *
* @return The TLV identifier
*/
public int getTlvId()
diff --git a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/search/SubstringFilter.java b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/search/SubstringFilter.java
index 455d541ba..a990f6ab1 100644
--- a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/search/SubstringFilter.java
+++ b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/search/SubstringFilter.java
@@ -188,6 +188,7 @@ public class SubstringFilter extends Filter
/**
+ * Get the Substrings length
* @return Returns the substringsLength.
*/
public int getSubstringsLength()
@@ -197,6 +198,8 @@ public class SubstringFilter extends Filter
/**
+ * Set the Substrings length
+ *
* @param substringsLength The substringsLength to set.
*/
public void setSubstringsLength( int substringsLength )
diff --git a/ldap/extras/aci/src/main/java/org/apache/directory/api/ldap/aci/ACIItemSyntaxChecker.java b/ldap/extras/aci/src/main/java/org/apache/directory/api/ldap/aci/ACIItemSyntaxChecker.java
index 8bc815201..e0dcff202 100644
--- a/ldap/extras/aci/src/main/java/org/apache/directory/api/ldap/aci/ACIItemSyntaxChecker.java
+++ b/ldap/extras/aci/src/main/java/org/apache/directory/api/ldap/aci/ACIItemSyntaxChecker.java
@@ -64,6 +64,12 @@ public final class ACIItemSyntaxChecker extends SyntaxChecker
}
+ /**
+ * Set the SchemaManager instance
+ *
+ * @param schemaManager The SchemaManager instance
+ * @return A reference to the Builder instance
+ */
public Builder setSchemaManager( SchemaManager schemaManager )
{
this.schemaManager = schemaManager;
@@ -73,6 +79,7 @@ public final class ACIItemSyntaxChecker extends SyntaxChecker
/**
* Create a new instance of ACIItemSyntaxChecker
+ *
* @return A new instance of ACIItemSyntaxChecker
*/
@Override
@@ -97,6 +104,8 @@ public final class ACIItemSyntaxChecker extends SyntaxChecker
/**
+ * Get the SyntaxChecker instance
+ *
* @return An instance of the Builder for this class
*/
public static Builder builder()
diff --git a/ldap/extras/aci/src/main/java/org/apache/directory/api/ldap/aci/protectedItem/AllUserAttributeTypesAndValuesItem.java b/ldap/extras/aci/src/main/java/org/apache/directory/api/ldap/aci/protectedItem/AllUserAttributeTypesAndValuesItem.java
index fc446fbd2..27e2ee1aa 100644
--- a/ldap/extras/aci/src/main/java/org/apache/directory/api/ldap/aci/protectedItem/AllUserAttributeTypesAndValuesItem.java
+++ b/ldap/extras/aci/src/main/java/org/apache/directory/api/ldap/aci/protectedItem/AllUserAttributeTypesAndValuesItem.java
@@ -31,6 +31,15 @@ import org.apache.directory.api.ldap.aci.ProtectedItem;
*/
public class AllUserAttributeTypesAndValuesItem extends ProtectedItem
{
+ /**
+ * A default constructor
+ */
+ public AllUserAttributeTypesAndValuesItem()
+ {
+ super();
+ }
+
+
/**
* {@inheritDoc}
*/
diff --git a/ldap/extras/aci/src/main/java/org/apache/directory/api/ldap/aci/protectedItem/AllUserAttributeTypesItem.java b/ldap/extras/aci/src/main/java/org/apache/directory/api/ldap/aci/protectedItem/AllUserAttributeTypesItem.java
index e0b834626..f4a8f6faf 100644
--- a/ldap/extras/aci/src/main/java/org/apache/directory/api/ldap/aci/protectedItem/AllUserAttributeTypesItem.java
+++ b/ldap/extras/aci/src/main/java/org/apache/directory/api/ldap/aci/protectedItem/AllUserAttributeTypesItem.java
@@ -31,6 +31,15 @@ import org.apache.directory.api.ldap.aci.ProtectedItem;
*/
public class AllUserAttributeTypesItem extends ProtectedItem
{
+ /**
+ * Default constructor
+ */
+ public AllUserAttributeTypesItem
+ {
+ super();
+ }
+
+
/**
* {@inheritDoc}
*/
diff --git a/ldap/extras/aci/src/main/java/org/apache/directory/api/ldap/aci/protectedItem/EntryItem.java b/ldap/extras/aci/src/main/java/org/apache/directory/api/ldap/aci/protectedItem/EntryItem.java
index c5fe7a583..39868b414 100644
--- a/ldap/extras/aci/src/main/java/org/apache/directory/api/ldap/aci/protectedItem/EntryItem.java
+++ b/ldap/extras/aci/src/main/java/org/apache/directory/api/ldap/aci/protectedItem/EntryItem.java
@@ -35,6 +35,15 @@ import org.apache.directory.api.ldap.aci.ProtectedItem;
*/
public class EntryItem extends ProtectedItem
{
+ /**
+ * A default constructor
+ */
+ public EntryItem()
+ {
+ super();
+ }
+
+
/**
* {@inheritDoc}
*/
diff --git a/ldap/extras/aci/src/test/resources/snippet/Snippet.java b/ldap/extras/aci/src/test/resources/snippet/Snippet.java
new file mode 100644
index 000000000..c36be0204
--- /dev/null
+++ b/ldap/extras/aci/src/test/resources/snippet/Snippet.java
@@ -0,0 +1,10 @@
+package snippet;
+
+public class Snippet
+{
+ public static void main( String[] args )
+ {
+ StoredProcedureParameter.java
+ }
+}
+
diff --git a/ldap/extras/util/src/main/java/org/apache/directory/api/ldap/util/tree/DnNode.java b/ldap/extras/util/src/main/java/org/apache/directory/api/ldap/util/tree/DnNode.java
index a37434808..7ccc66407 100644
--- a/ldap/extras/util/src/main/java/org/apache/directory/api/ldap/util/tree/DnNode.java
+++ b/ldap/extras/util/src/main/java/org/apache/directory/api/ldap/util/tree/DnNode.java
@@ -274,6 +274,8 @@ public class DnNode<N>
/**
+ * Get the stored element
+ *
* @return Return the stored element, if any
*/
public synchronized N getElement()
@@ -283,6 +285,8 @@ public class DnNode<N>
/**
+ * Get the stored element associated to a DN
+ *
* @return Return the stored element, if any
* @param dn The Dn we want to get the element for
*/
@@ -300,6 +304,8 @@ public class DnNode<N>
/**
+ * Tells if there is an element
+ *
* @return True if the Node stores an element. BranchNode may not hold any
* element.
*/
@@ -310,6 +316,8 @@ public class DnNode<N>
/**
+ * tells if there is an element for a given Dn
+ *
* @return True if the Node stores an element. BranchNode may not hold any
* element.
* @param dn The Dn we want to get the element for
@@ -359,6 +367,8 @@ public class DnNode<N>
/**
+ * tells if tehre are some descendant elemnts for a given Dn
+ *
* @return True if one of the node below the current node has one element,
* False otherwise
* @param dn The Dn we want to get the element for
@@ -422,6 +432,8 @@ public class DnNode<N>
/**
+ * Get the descendant of an element at a given Dn position
+ *
* @return True if one of the node below the current node has one element,
* False otherwise
* @param dn The Dn we want to get the element for
@@ -484,6 +496,8 @@ public class DnNode<N>
/**
+ * Get the chidren for the current node
+ *
* @return The list of DnNode
*/
public synchronized Map<String, DnNode<N>> getChildren()
@@ -493,6 +507,8 @@ public class DnNode<N>
/**
+ * Get the parent's node
+ *
* @return The parent DnNode, if any
*/
public synchronized DnNode<N> getParent()
@@ -502,7 +518,9 @@ public class DnNode<N>
/**
- * @return True if the current DnNode has a parent
+ * Tells if the current noe has a parent
+ *
+ * @return <code>true</code> if the current DnNode has a parent
*/
public synchronized boolean hasParent()
{
@@ -713,6 +731,8 @@ public class DnNode<N>
/**
+ * Get a node's Rdn
+ *
* @return The Node's Rdn
*/
public synchronized Rdn getRdn()
(directory-ldap-api) 05/06: Fixed the last javadoc warnings
Posted by el...@apache.org.
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
commit fecaed970801701c0997a50cbc326ed1c613213a
Author: emmanuel lecharny <el...@apache.org>
AuthorDate: Thu Feb 6 23:25:06 2025 +0100
Fixed the last javadoc warnings
---
.../extended/storedProcedure/StoredProcedureParameter.java | 10 +++++++++-
.../directory/api/ldap/extras/ExtrasBundleActivator.java | 10 +++++++++-
.../extras/controls/ad_impl/AdDirSyncRequestContainer.java | 2 ++
.../extras/controls/ad_impl/AdDirSyncRequestGrammar.java | 2 ++
.../extras/controls/ad_impl/AdDirSyncRequestStatesEnum.java | 2 +-
.../extras/controls/ad_impl/AdDirSyncResponseContainer.java | 4 +++-
.../extras/controls/ad_impl/AdDirSyncResponseGrammar.java | 6 +++---
.../extras/controls/ad_impl/AdDirSyncResponseStatesEnum.java | 3 +--
.../ldap/extras/controls/ad_impl/AdPolicyHintsContainer.java | 2 ++
.../ldap/extras/controls/ad_impl/AdPolicyHintsGrammar.java | 2 ++
.../ppolicy_impl/PasswordPolicyResponseContainer.java | 2 ++
.../controls/ppolicy_impl/PasswordPolicyResponseGrammar.java | 2 ++
.../extras/controls/ppolicy_impl/PasswordPolicyTags.java | 2 ++
.../ldap/extras/controls/relax_impl/RelaxControlFactory.java | 3 +++
.../controls/syncrepl_impl/SyncDoneValueContainer.java | 2 ++
.../extras/controls/syncrepl_impl/SyncDoneValueGrammar.java | 2 ++
.../controls/syncrepl_impl/SyncDoneValueStatesEnum.java | 2 +-
.../controls/syncrepl_impl/SyncRequestValueContainer.java | 2 ++
.../controls/syncrepl_impl/SyncStateValueContainer.java | 2 ++
.../controls/vlv_impl/VirtualListViewRequestContainer.java | 2 ++
.../controls/vlv_impl/VirtualListViewRequestGrammar.java | 2 ++
.../controls/vlv_impl/VirtualListViewResponseContainer.java | 2 ++
.../controls/vlv_impl/VirtualListViewResponseGrammar.java | 2 ++
.../ldap/extras/controls/vlv_impl/VirtualListViewerTags.java | 1 +
.../extended/ads_impl/cancel/CancelRequestContainer.java | 2 ++
.../certGeneration/CertGenerationRequestContainer.java | 2 ++
.../endTransaction/EndTransactionRequestContainer.java | 2 ++
.../endTransaction/EndTransactionResponseContainer.java | 6 ++++++
.../ads_impl/endTransaction/controls/ControlsContainer.java | 12 ++++++++++++
.../GracefulDisconnectResponseContainer.java | 2 ++
.../gracefulShutdown/GracefulShutdownRequestContainer.java | 2 ++
.../ads_impl/pwdModify/PasswordModifyRequestContainer.java | 1 +
.../ads_impl/pwdModify/PasswordModifyResponseContainer.java | 2 ++
.../storedProcedure/StoredProcedureRequestContainer.java | 6 +++++-
.../intermediate/syncrepl_impl/SyncInfoValueContainer.java | 2 ++
.../extras/intermediate/syncrepl_impl/SyncInfoValueTags.java | 2 ++
36 files changed, 101 insertions(+), 11 deletions(-)
diff --git a/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/storedProcedure/StoredProcedureParameter.java b/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/storedProcedure/StoredProcedureParameter.java
index 3a146b282..0541a1307 100644
--- a/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/storedProcedure/StoredProcedureParameter.java
+++ b/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/storedProcedure/StoredProcedureParameter.java
@@ -36,9 +36,17 @@ public class StoredProcedureParameter
/** the value of the parameter */
private byte[] value;
+ /**
+ * Default constructor
+ */
+ public StoredProcedureParameter()
+ {
+ // Nothing to do
+ }
+
/**
- * Gets the type as a UTF8 String.
+ * Get the type as a UTF8 String.
*
* @return The type as a UTF8 String.
*/
diff --git a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/ExtrasBundleActivator.java b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/ExtrasBundleActivator.java
index a68d02686..3f8ed4d95 100644
--- a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/ExtrasBundleActivator.java
+++ b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/ExtrasBundleActivator.java
@@ -41,10 +41,18 @@ public class ExtrasBundleActivator implements BundleActivator
{
private ServiceTracker<LdapApiService, LdapApiService> serviceTracker;
+
+ /**
+ * default constructor
+ */
+ public ExtrasBundleActivator()
+ {
+ // Nothing to do
+ }
+
class LdapApiServiceTracker implements ServiceTrackerCustomizer<LdapApiService, LdapApiService>
{
-
private BundleContext context;
diff --git a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/ad_impl/AdDirSyncRequestContainer.java b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/ad_impl/AdDirSyncRequestContainer.java
index aef7e2c84..857609f7c 100644
--- a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/ad_impl/AdDirSyncRequestContainer.java
+++ b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/ad_impl/AdDirSyncRequestContainer.java
@@ -53,6 +53,8 @@ public class AdDirSyncRequestContainer extends AbstractContainer implements Cont
/**
+ * Get the AdDirSyncRequestControlCodec object
+ *
* @return the AdDirSyncRequestControlCodec object
*/
public AdDirSyncRequest getAdDirSyncRequest()
diff --git a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/ad_impl/AdDirSyncRequestGrammar.java b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/ad_impl/AdDirSyncRequestGrammar.java
index 951ac4cdb..56d1c4833 100644
--- a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/ad_impl/AdDirSyncRequestGrammar.java
+++ b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/ad_impl/AdDirSyncRequestGrammar.java
@@ -210,6 +210,8 @@ public final class AdDirSyncRequestGrammar extends AbstractGrammar<AdDirSyncRequ
/**
+ * Get the grammar instance
+ *
* @return the singleton instance of the AdDirSyncControlGrammar
*/
public static Grammar<AdDirSyncRequestContainer> getInstance()
diff --git a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/ad_impl/AdDirSyncRequestStatesEnum.java b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/ad_impl/AdDirSyncRequestStatesEnum.java
index de80c4e82..850664ca1 100644
--- a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/ad_impl/AdDirSyncRequestStatesEnum.java
+++ b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/ad_impl/AdDirSyncRequestStatesEnum.java
@@ -34,7 +34,7 @@ public enum AdDirSyncRequestStatesEnum implements States
/** The END_STATE */
END_STATE,
- /***/
+ /** Start state */
START_STATE,
/** sequence start state */
diff --git a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/ad_impl/AdDirSyncResponseContainer.java b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/ad_impl/AdDirSyncResponseContainer.java
index 998655ec3..a93a1c507 100644
--- a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/ad_impl/AdDirSyncResponseContainer.java
+++ b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/ad_impl/AdDirSyncResponseContainer.java
@@ -52,7 +52,9 @@ public class AdDirSyncResponseContainer extends AbstractContainer implements Con
/**
- * @return the AdDirSyncResponseControlCodec object
+ * Get the AdDirSyncResponseControlCodec object
+ *
+ * @return The AdDirSyncResponseControlCodec object
*/
public AdDirSyncResponse getAdDirSyncResponseControl()
{
diff --git a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/ad_impl/AdDirSyncResponseGrammar.java b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/ad_impl/AdDirSyncResponseGrammar.java
index fc5115dba..d42af8ee5 100644
--- a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/ad_impl/AdDirSyncResponseGrammar.java
+++ b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/ad_impl/AdDirSyncResponseGrammar.java
@@ -65,9 +65,7 @@ public final class AdDirSyncResponseGrammar extends AbstractGrammar<AdDirSyncRes
/**
- *
* Creates a new instance of AdDirSyncResponseControlGrammar.
- *
*/
@SuppressWarnings("unchecked")
private AdDirSyncResponseGrammar()
@@ -222,7 +220,9 @@ public final class AdDirSyncResponseGrammar extends AbstractGrammar<AdDirSyncRes
/**
- * @return the singleton instance of the AdDirSyncControlGrammar
+ * Get the singleton instance of the AdDirSyncControlGrammar
+ *
+ * @return The singleton instance of the AdDirSyncControlGrammar
*/
public static Grammar<AdDirSyncResponseContainer> getInstance()
{
diff --git a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/ad_impl/AdDirSyncResponseStatesEnum.java b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/ad_impl/AdDirSyncResponseStatesEnum.java
index 190960509..668ab4115 100644
--- a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/ad_impl/AdDirSyncResponseStatesEnum.java
+++ b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/ad_impl/AdDirSyncResponseStatesEnum.java
@@ -30,11 +30,10 @@ import org.apache.directory.api.asn1.ber.grammar.States;
*/
public enum AdDirSyncResponseStatesEnum implements States
{
-
/** The END_STATE */
END_STATE,
- /***/
+ /** The start state */
START_STATE,
/** sequence start state */
diff --git a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/ad_impl/AdPolicyHintsContainer.java b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/ad_impl/AdPolicyHintsContainer.java
index 030a714d8..8c743018c 100644
--- a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/ad_impl/AdPolicyHintsContainer.java
+++ b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/ad_impl/AdPolicyHintsContainer.java
@@ -51,6 +51,8 @@ public class AdPolicyHintsContainer extends AbstractContainer implements Control
/**
+ * Get the AdPolicyHints control
+ *
* @return The AdPolicyHints control
*/
public AdPolicyHints getAdPolicyHints()
diff --git a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/ad_impl/AdPolicyHintsGrammar.java b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/ad_impl/AdPolicyHintsGrammar.java
index 058161750..5417e0abc 100644
--- a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/ad_impl/AdPolicyHintsGrammar.java
+++ b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/ad_impl/AdPolicyHintsGrammar.java
@@ -62,6 +62,8 @@ public final class AdPolicyHintsGrammar extends AbstractGrammar<AdPolicyHintsCon
/**
+ * Get the grammar instance
+ *
* @return the singleton instance of the AdPolicyHintsGrammar
*/
public static Grammar<?> getInstance()
diff --git a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/ppolicy_impl/PasswordPolicyResponseContainer.java b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/ppolicy_impl/PasswordPolicyResponseContainer.java
index e877a470b..d1ac39e1d 100644
--- a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/ppolicy_impl/PasswordPolicyResponseContainer.java
+++ b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/ppolicy_impl/PasswordPolicyResponseContainer.java
@@ -52,6 +52,8 @@ public class PasswordPolicyResponseContainer extends AbstractContainer implement
/**
+ * Get the PasswordPolicyResponseControlCodec object
+ *
* @return the PasswordPolicyResponseControlCodec object
*/
public PasswordPolicyResponse getPasswordPolicyResponse()
diff --git a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/ppolicy_impl/PasswordPolicyResponseGrammar.java b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/ppolicy_impl/PasswordPolicyResponseGrammar.java
index c6819e243..d5f9b3659 100644
--- a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/ppolicy_impl/PasswordPolicyResponseGrammar.java
+++ b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/ppolicy_impl/PasswordPolicyResponseGrammar.java
@@ -149,6 +149,8 @@ public final class PasswordPolicyResponseGrammar extends AbstractGrammar<Passwor
/**
+ * Get the grammar instance
+ *
* @return the singleton instance of the PasswordPolicyResponseGrammar
*/
public static Grammar<PasswordPolicyResponseContainer> getInstance()
diff --git a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/ppolicy_impl/PasswordPolicyTags.java b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/ppolicy_impl/PasswordPolicyTags.java
index 8f3df0e19..a52629648 100644
--- a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/ppolicy_impl/PasswordPolicyTags.java
+++ b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/ppolicy_impl/PasswordPolicyTags.java
@@ -51,6 +51,8 @@ public enum PasswordPolicyTags
/**
+ * Get the numeric value associated with the PasswordPolicy tag
+ *
* @return The numeric value associated with the PasswordPolicy tag
*/
public int getValue()
diff --git a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/relax_impl/RelaxControlFactory.java b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/relax_impl/RelaxControlFactory.java
index 529fd58bd..69226c459 100644
--- a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/relax_impl/RelaxControlFactory.java
+++ b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/relax_impl/RelaxControlFactory.java
@@ -26,6 +26,9 @@ import org.apache.directory.api.ldap.extras.controls.relax.RelaxControl;
import org.apache.directory.api.ldap.extras.controls.relax.RelaxControlImpl;
+/**
+ * A factory to create relaxed controls
+ */
public class RelaxControlFactory extends AbstractControlFactory<RelaxControl>
{
/**
diff --git a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl_impl/SyncDoneValueContainer.java b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl_impl/SyncDoneValueContainer.java
index 055ca69d5..b63283aa0 100644
--- a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl_impl/SyncDoneValueContainer.java
+++ b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl_impl/SyncDoneValueContainer.java
@@ -52,6 +52,8 @@ public class SyncDoneValueContainer extends AbstractContainer implements Control
/**
+ * Get the SyncDoneValue
+ *
* @return the SyncDoneValueControlCodec object
*/
public SyncDoneValue getSyncDoneValue()
diff --git a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl_impl/SyncDoneValueGrammar.java b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl_impl/SyncDoneValueGrammar.java
index 641ccda36..f4dd0aaf9 100644
--- a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl_impl/SyncDoneValueGrammar.java
+++ b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl_impl/SyncDoneValueGrammar.java
@@ -190,6 +190,8 @@ public final class SyncDoneValueGrammar extends AbstractGrammar<SyncDoneValueCon
/**
+ * Get the grammar instance
+ *
* @return the singleton instance of the SyncDoneValueControlGrammar
*/
public static Grammar<SyncDoneValueContainer> getInstance()
diff --git a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl_impl/SyncDoneValueStatesEnum.java b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl_impl/SyncDoneValueStatesEnum.java
index 9678881bb..fc7eb9f94 100644
--- a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl_impl/SyncDoneValueStatesEnum.java
+++ b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl_impl/SyncDoneValueStatesEnum.java
@@ -34,7 +34,7 @@ public enum SyncDoneValueStatesEnum implements States
/** The END_STATE */
END_STATE,
- /***/
+ /** Start state */
START_STATE,
/** sequence start state */
diff --git a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl_impl/SyncRequestValueContainer.java b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl_impl/SyncRequestValueContainer.java
index ff494915a..cd3acc535 100644
--- a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl_impl/SyncRequestValueContainer.java
+++ b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl_impl/SyncRequestValueContainer.java
@@ -51,6 +51,8 @@ public class SyncRequestValueContainer extends AbstractContainer implements Cont
/**
+ * Get the syncRequestValue control.
+ *
* @return Returns the syncRequestValue control.
*/
public SyncRequestValue getSyncRequestValue()
diff --git a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl_impl/SyncStateValueContainer.java b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl_impl/SyncStateValueContainer.java
index 159594ee7..a471dfed6 100644
--- a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl_impl/SyncStateValueContainer.java
+++ b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl_impl/SyncStateValueContainer.java
@@ -51,6 +51,8 @@ public class SyncStateValueContainer extends AbstractContainer implements Contro
/**
+ * Get the syncStateValue control.
+ *
* @return Returns the syncStateValue control.
*/
public SyncStateValue getSyncStateValue()
diff --git a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/vlv_impl/VirtualListViewRequestContainer.java b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/vlv_impl/VirtualListViewRequestContainer.java
index 64bca6a11..ef6c34910 100644
--- a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/vlv_impl/VirtualListViewRequestContainer.java
+++ b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/vlv_impl/VirtualListViewRequestContainer.java
@@ -52,6 +52,8 @@ public class VirtualListViewRequestContainer extends AbstractContainer implement
/**
+ * Get the VLV control
+ *
* @return The VLV control
*/
public VirtualListViewRequest getVirtualListViewRequest()
diff --git a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/vlv_impl/VirtualListViewRequestGrammar.java b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/vlv_impl/VirtualListViewRequestGrammar.java
index 8add8edce..e70e323ca 100644
--- a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/vlv_impl/VirtualListViewRequestGrammar.java
+++ b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/vlv_impl/VirtualListViewRequestGrammar.java
@@ -129,6 +129,8 @@ public final class VirtualListViewRequestGrammar extends AbstractGrammar<Virtual
/**
+ * Get the grammar instance
+ *
* @return the singleton instance of the VirtualListViewRequestGrammar
*/
public static Grammar<?> getInstance()
diff --git a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/vlv_impl/VirtualListViewResponseContainer.java b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/vlv_impl/VirtualListViewResponseContainer.java
index 4b6b091c7..77036121c 100644
--- a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/vlv_impl/VirtualListViewResponseContainer.java
+++ b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/vlv_impl/VirtualListViewResponseContainer.java
@@ -52,6 +52,8 @@ public class VirtualListViewResponseContainer extends AbstractContainer implemen
/**
+ * Get the decorated VLV control
+ *
* @return The decorated VLV control
*/
public VirtualListViewResponse getVirtualListViewResponse()
diff --git a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/vlv_impl/VirtualListViewResponseGrammar.java b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/vlv_impl/VirtualListViewResponseGrammar.java
index cba971ab9..c7d0eba74 100644
--- a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/vlv_impl/VirtualListViewResponseGrammar.java
+++ b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/vlv_impl/VirtualListViewResponseGrammar.java
@@ -117,6 +117,8 @@ public final class VirtualListViewResponseGrammar extends AbstractGrammar<Virtua
/**
+ * Get the grammar instance
+ *
* @return the singleton instance of the VirtualListViewResponseGrammar
*/
public static Grammar<?> getInstance()
diff --git a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/vlv_impl/VirtualListViewerTags.java b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/vlv_impl/VirtualListViewerTags.java
index 9ef3aff2a..fe7071879 100644
--- a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/vlv_impl/VirtualListViewerTags.java
+++ b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/controls/vlv_impl/VirtualListViewerTags.java
@@ -45,6 +45,7 @@ public enum VirtualListViewerTags
/**
+ * Get the value
* @return The interned value
*/
public int getValue()
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 d89566b4a..a0bc2d4f2 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
@@ -47,6 +47,8 @@ public class CancelRequestContainer extends AbstractContainer
/**
+ * Get the cancel request
+ *
* @return Returns the Cancel object.
*/
public CancelRequest getCancelRequest()
diff --git a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/certGeneration/CertGenerationRequestContainer.java b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/certGeneration/CertGenerationRequestContainer.java
index c65d8b467..39c1279dd 100644
--- a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/certGeneration/CertGenerationRequestContainer.java
+++ b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/certGeneration/CertGenerationRequestContainer.java
@@ -47,6 +47,8 @@ public class CertGenerationRequestContainer extends AbstractContainer
/**
+ * Get the CertGenerationRequest instance.
+ *
* @return Returns the CertGenerationRequest instance.
*/
public CertGenerationRequest getCertGenerationRequest()
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 dcb08a406..cb60eb171 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
@@ -47,6 +47,8 @@ public class EndTransactionRequestContainer extends AbstractContainer
/**
+ * Get the EndTransactionRequest instance
+ *
* @return Returns the EndTransactionRequest instance.
*/
public EndTransactionRequest getEndTransactionRequest()
diff --git a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/endTransaction/EndTransactionResponseContainer.java b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/endTransaction/EndTransactionResponseContainer.java
index d91cf5e12..bc4238c1d 100644
--- a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/endTransaction/EndTransactionResponseContainer.java
+++ b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/endTransaction/EndTransactionResponseContainer.java
@@ -60,6 +60,8 @@ public class EndTransactionResponseContainer extends AbstractContainer
/**
+ * Get the EndTransactionResponse instance
+ *
* @return Returns the EndTransactionResponse instance.
*/
public EndTransactionResponse getEndTransactionResponse()
@@ -81,6 +83,8 @@ public class EndTransactionResponseContainer extends AbstractContainer
/**
+ * Get the currentUpdateControls
+ *
* @return the currentUpdateControls
*/
public UpdateControls getCurrentUpdateControls()
@@ -90,6 +94,8 @@ public class EndTransactionResponseContainer extends AbstractContainer
/**
+ * set the currentUpdateControls
+ *
* @param currentUpdateControls the currentUpdateControls to set
*/
public void setCurrentControls( UpdateControls currentUpdateControls )
diff --git a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/endTransaction/controls/ControlsContainer.java b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/endTransaction/controls/ControlsContainer.java
index 34d6b65b5..31ffa511f 100644
--- a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/endTransaction/controls/ControlsContainer.java
+++ b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/endTransaction/controls/ControlsContainer.java
@@ -71,6 +71,8 @@ public class ControlsContainer extends AbstractContainer
/**
+ * Get the current control
+ *
* @return the currentControl
*/
public Control getCurrentControl()
@@ -80,6 +82,8 @@ public class ControlsContainer extends AbstractContainer
/**
+ * Set the current control
+ *
* @param currentControl the currentControl to set
*/
public void setCurrentControl( Control currentControl )
@@ -89,6 +93,8 @@ public class ControlsContainer extends AbstractContainer
/**
+ * Get the controls list
+ *
* @return the controls
*/
public List<Control> getControls()
@@ -98,6 +104,8 @@ public class ControlsContainer extends AbstractContainer
/**
+ * Add a control
+ *
* @param control the controls to add to the list of controls
*/
public void addControl( Control control )
@@ -107,6 +115,8 @@ public class ControlsContainer extends AbstractContainer
/**
+ * Get the control factory
+ *
* @return the factory
*/
public ControlFactory<?> getFactory()
@@ -116,6 +126,8 @@ public class ControlsContainer extends AbstractContainer
/**
+ * Set the control factory
+ *
* @param factory the factory to set
*/
public void setFactory( ControlFactory<?> factory )
diff --git a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/gracefulDisconnect/GracefulDisconnectResponseContainer.java b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/gracefulDisconnect/GracefulDisconnectResponseContainer.java
index be5408b74..0e2c0870d 100644
--- a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/gracefulDisconnect/GracefulDisconnectResponseContainer.java
+++ b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/gracefulDisconnect/GracefulDisconnectResponseContainer.java
@@ -48,6 +48,8 @@ public class GracefulDisconnectResponseContainer extends AbstractContainer
/**
+ * Get the GracefulDisconnectResponse object.
+ *
* @return Returns the GracefulDisconnectResponse object.
*/
public GracefulDisconnectResponse getGracefulDisconnectResponse()
diff --git a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/gracefulShutdown/GracefulShutdownRequestContainer.java b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/gracefulShutdown/GracefulShutdownRequestContainer.java
index 270977601..e0c1e2b7b 100644
--- a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/gracefulShutdown/GracefulShutdownRequestContainer.java
+++ b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/gracefulShutdown/GracefulShutdownRequestContainer.java
@@ -47,6 +47,8 @@ public class GracefulShutdownRequestContainer extends AbstractContainer
/**
+ * Get the Graceful Shutdown object.
+ *
* @return Returns the Graceful Shutdown object.
*/
public GracefulShutdownRequest getGracefulShutdownRequest()
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 39da682ff..b289b3bbe 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
@@ -47,6 +47,7 @@ public class PasswordModifyRequestContainer extends AbstractContainer
/**
+ * Get the PwdModifyRequest instance.
* @return Returns the PwdModifyRequest instance.
*/
public PasswordModifyRequest getPwdModifyRequest()
diff --git a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/pwdModify/PasswordModifyResponseContainer.java b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/pwdModify/PasswordModifyResponseContainer.java
index 1d64591a3..b4f6ce901 100644
--- a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/pwdModify/PasswordModifyResponseContainer.java
+++ b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/pwdModify/PasswordModifyResponseContainer.java
@@ -47,6 +47,8 @@ public class PasswordModifyResponseContainer extends AbstractContainer
/**
+ * Get the PwdModifyResponset instance.
+ *
* @return Returns the PwdModifyResponset instance.
*/
public PasswordModifyResponse getPwdModifyResponse()
diff --git a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/storedProcedure/StoredProcedureRequestContainer.java b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/storedProcedure/StoredProcedureRequestContainer.java
index 5d83ffdc3..0d5a36c04 100644
--- a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/storedProcedure/StoredProcedureRequestContainer.java
+++ b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/extended/ads_impl/storedProcedure/StoredProcedureRequestContainer.java
@@ -52,7 +52,9 @@ public class StoredProcedureRequestContainer extends AbstractContainer
/**
- * @return Returns the ldapMessage.
+ * Get the StoredProcedureRequest
+ *
+ * @return Returns the StoredProcedureRequest.
*/
public StoredProcedureRequest getStoredProcedure()
{
@@ -73,6 +75,8 @@ public class StoredProcedureRequestContainer extends AbstractContainer
/**
+ * Get the current parameter
+ *
* @return The current parameter
*/
public StoredProcedureParameter getCurrentParameter()
diff --git a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/intermediate/syncrepl_impl/SyncInfoValueContainer.java b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/intermediate/syncrepl_impl/SyncInfoValueContainer.java
index 389599ad6..b218c9b29 100644
--- a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/intermediate/syncrepl_impl/SyncInfoValueContainer.java
+++ b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/intermediate/syncrepl_impl/SyncInfoValueContainer.java
@@ -50,6 +50,8 @@ public class SyncInfoValueContainer extends AbstractContainer
/**
+ * Get the syncInfoValue instance
+ *
* @return Returns the syncInfoValue instance.
*/
public SyncInfoValue getSyncInfoValue()
diff --git a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/intermediate/syncrepl_impl/SyncInfoValueTags.java b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/intermediate/syncrepl_impl/SyncInfoValueTags.java
index 7da9503a1..770f53f9c 100644
--- a/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/intermediate/syncrepl_impl/SyncInfoValueTags.java
+++ b/ldap/extras/codec/src/main/java/org/apache/directory/api/ldap/extras/intermediate/syncrepl_impl/SyncInfoValueTags.java
@@ -54,6 +54,8 @@ public enum SyncInfoValueTags
/**
+ * Get the ASN 1 value
+ *
* @return The ASN.1 BER value for this tag.
*/
public int getValue()
(directory-ldap-api) 04/06: Fixed the codec-api javadoc warnings
Posted by el...@apache.org.
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
commit 70e2e2c116146b64220389529d8c58915fc7cc00
Author: emmanuel lecharny <el...@apache.org>
AuthorDate: Thu Feb 6 14:23:56 2025 +0100
Fixed the codec-api javadoc warnings
---
.../api/ldap/extras/controls/SyncModifyDnType.java | 3 ++
.../extras/controls/SynchronizationModeEnum.java | 2 ++
.../ldap/extras/controls/ad/AdDirSyncRequest.java | 10 ++++++
.../ldap/extras/controls/ad/AdDirSyncResponse.java | 19 +++++++++--
.../extras/controls/ad/AdDirSyncResponseFlag.java | 4 +++
.../api/ldap/extras/controls/ad/AdPolicyHints.java | 2 ++
.../controls/ppolicy/PasswordPolicyErrorEnum.java | 4 ++-
.../extras/controls/relax/RelaxControlImpl.java | 13 +++++---
.../controls/syncrepl/syncDone/SyncDoneValue.java | 10 ++++--
.../syncrepl/syncRequest/SyncRequestValue.java | 12 +++++++
.../syncrepl/syncState/SyncStateTypeEnum.java | 2 ++
.../syncrepl/syncState/SyncStateValue.java | 18 +++++++---
.../transaction/TransactionSpecification.java | 3 ++
.../controls/vlv/VirtualListViewRequest.java | 39 ++++++++++++++++++----
.../controls/vlv/VirtualListViewResponse.java | 7 ++++
.../controls/vlv/VirtualListViewResultCode.java | 4 +++
.../ldap/extras/extended/cancel/CancelRequest.java | 2 ++
.../certGeneration/CertGenerationRequest.java | 7 +++-
.../endTransaction/EndTransactionRequest.java | 5 +++
.../endTransaction/EndTransactionResponse.java | 6 ++++
.../endTransaction/EndTransactionResponseImpl.java | 4 ++-
.../extended/endTransaction/UpdateControls.java | 8 +++++
.../extended/pwdModify/PasswordModifyRequest.java | 6 ++++
.../startTransaction/StartTransactionResponse.java | 2 ++
.../StartTransactionResponseImpl.java | 4 ++-
.../storedProcedure/StoredProcedureRequest.java | 6 ++++
.../extras/extended/whoAmI/WhoAmIResponse.java | 6 +++-
.../intermediate/syncrepl/SyncInfoValue.java | 18 ++++++++++
.../syncrepl/SynchronizationInfoEnum.java | 2 ++
29 files changed, 203 insertions(+), 25 deletions(-)
diff --git a/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/SyncModifyDnType.java b/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/SyncModifyDnType.java
index cb53f204f..23b917cbd 100644
--- a/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/SyncModifyDnType.java
+++ b/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/SyncModifyDnType.java
@@ -54,6 +54,8 @@ public enum SyncModifyDnType
/**
+ * Get the value associated with the current element.
+ *
* @return The value associated with the current element.
*/
public int getValue()
@@ -64,6 +66,7 @@ public enum SyncModifyDnType
/**
* Get the instance from it's interger value
+ *
* @param value The value we are looking for
* @return The associated value
*/
diff --git a/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/SynchronizationModeEnum.java b/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/SynchronizationModeEnum.java
index 43866b3b0..769bdc7c0 100644
--- a/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/SynchronizationModeEnum.java
+++ b/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/SynchronizationModeEnum.java
@@ -69,6 +69,8 @@ public enum SynchronizationModeEnum
/**
+ * Get the value associated with the current element.
+ *
* @return The value associated with the current element.
*/
public int getValue()
diff --git a/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/ad/AdDirSyncRequest.java b/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/ad/AdDirSyncRequest.java
index dbf84ced4..c658d3f0a 100644
--- a/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/ad/AdDirSyncRequest.java
+++ b/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/ad/AdDirSyncRequest.java
@@ -54,6 +54,8 @@ public interface AdDirSyncRequest extends Control
String OID = "1.2.840.113556.1.4.841";
/**
+ * Tells if the parents should be returned first
+ *
* @return 1 if the parents of the children comes before their children
*/
int getParentsFirst();
@@ -70,24 +72,32 @@ public interface AdDirSyncRequest extends Control
/**
+ * Get the maximum attribute count
+ *
* @return The maximum attribute count to be returned
*/
int getMaxAttributeCount();
/**
+ * Set the maximum attribute count
+ *
* @param maxAttributeCount The maximum attribute count to be returned
*/
void setMaxAttributeCount( int maxAttributeCount );
/**
+ * Get the dialogue cookie
+ *
* @return The cookie used while processing the successive DirSync operations
*/
byte[] getCookie();
/**
+ * Set the dialogue cookie
+ *
* @param cookie The cookie to send to the server. It's the value found in the response control. Should be null
* for the first control.
*/
diff --git a/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/ad/AdDirSyncResponse.java b/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/ad/AdDirSyncResponse.java
index 57880674f..b170ba287 100644
--- a/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/ad/AdDirSyncResponse.java
+++ b/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/ad/AdDirSyncResponse.java
@@ -54,26 +54,33 @@ public interface AdDirSyncResponse extends Control
/** This control OID */
String OID = "1.2.840.113556.1.4.841";
-
/**
+ * Get the maximum length of attributes
+ *
* @return The maximum length of attributes to be returned
*/
int getMaxReturnLength();
/**
+ * Set the maximum length of attributes
+ *
* @param maxReturnLength The maximum length of attributes to be returned
*/
void setMaxReturnLength( int maxReturnLength );
/**
+ * Get the cookie
+ *
* @return The cookie used while processing the successive DirSync operations
*/
byte[] getCookie();
/**
+ * Set the cookie
+ *
* @param cookie The cookie to send to the server. It's the value found in the response control. Should be null
* for the first control.
*/
@@ -81,30 +88,38 @@ public interface AdDirSyncResponse extends Control
/**
- * @return The flags returned by the server. Zero or more of :
+ * Get the flags returned by the server. Zero or more of :
* <ul>
* <li>LDAP_DIRSYNC_OBJECT_SECURITY (0x0001)</li>
* <li>LDAP_DIRSYNC_ANCESTORS_FIRST_ORDER (0x0800)</li>
* <li>LDAP_DIRSYNC_PUBLIC_DATA_ONLY (0x2000)(</li>
* <li>LDAP_DIRSYNC_INCREMENTAL_VALUES (0x7FFFFFFF)</li>
* </ul>
+ *
+ * @return The flags
*/
Set<AdDirSyncResponseFlag> getFlags();
/**
+ * Set the flags
+ *
* @param flags The flags to be set. See {@link EnumSet} for how to generate EnumSets.
*/
void setFlags( Set<AdDirSyncResponseFlag> flags );
/**
+ * Add a flag to the collection of flags
+ *
* @param flag The flag to be added to the current collection of flags.
*/
void addFlag( AdDirSyncResponseFlag flag );
/**
+ * Remove a given flag from the collection of flags
+ *
* @param flag The flag to be removed from the current collection of flags.
*/
void removeFlag( AdDirSyncResponseFlag flag );
diff --git a/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/ad/AdDirSyncResponseFlag.java b/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/ad/AdDirSyncResponseFlag.java
index 290c989a7..d27951d4a 100644
--- a/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/ad/AdDirSyncResponseFlag.java
+++ b/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/ad/AdDirSyncResponseFlag.java
@@ -61,6 +61,8 @@ public enum AdDirSyncResponseFlag
/**
+ * Get the value
+ *
* @return The associated value of a given flag
*/
public int getValue()
@@ -81,6 +83,7 @@ public enum AdDirSyncResponseFlag
/**
* Get back the combination of flags associated with a given value
+ *
* @param value The integer value
* @return a set of all flags associated with the integer value
*/
@@ -100,6 +103,7 @@ public enum AdDirSyncResponseFlag
/**
* Get back the bitmask (as an integer) associated with the given flags
+ *
* @param flags The AdDirSync flags
* @return a bitmask in integer form associated with the set of flags
*/
diff --git a/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/ad/AdPolicyHints.java b/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/ad/AdPolicyHints.java
index d6da47de4..682b6c1ec 100644
--- a/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/ad/AdPolicyHints.java
+++ b/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/ad/AdPolicyHints.java
@@ -40,6 +40,8 @@ public interface AdPolicyHints extends Control
String OID = "1.2.840.113556.1.4.2239";
/**
+ * Get the set flags
+ *
* @return The flags
*/
int getFlags();
diff --git a/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/ppolicy/PasswordPolicyErrorEnum.java b/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/ppolicy/PasswordPolicyErrorEnum.java
index c8eb7de4e..a08c5f1a9 100644
--- a/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/ppolicy/PasswordPolicyErrorEnum.java
+++ b/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/ppolicy/PasswordPolicyErrorEnum.java
@@ -35,7 +35,7 @@ public enum PasswordPolicyErrorEnum
/** The account is locked */
ACCOUNT_LOCKED(1),
- /** */
+ /** A change is requested after a password reset*/
CHANGE_AFTER_RESET(2),
/** the password modification is not allowed */
@@ -116,6 +116,8 @@ public enum PasswordPolicyErrorEnum
/**
+ * Get the PasswordPolicyError interned value
+ *
* @return the PasswordPolicyError interned value
*/
public int getValue()
diff --git a/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/relax/RelaxControlImpl.java b/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/relax/RelaxControlImpl.java
index 52d260d30..6f3f476cf 100644
--- a/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/relax/RelaxControlImpl.java
+++ b/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/relax/RelaxControlImpl.java
@@ -29,19 +29,22 @@ import org.apache.directory.api.ldap.model.message.controls.AbstractControl;
*/
public class RelaxControlImpl extends AbstractControl implements RelaxControl
{
+ /**
+ * The RelaxControlImpl default constructor
+ */
public RelaxControlImpl()
{
super( OID );
}
+ /**
+ * The RelaxControlImpl default constructor
+ *
+ * @param isCritical If the control is critical
+ */
public RelaxControlImpl( boolean isCritical )
{
super( OID );
this.setCritical( isCritical );
}
-
- public String getOID()
- {
- return OID;
- }
}
diff --git a/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl/syncDone/SyncDoneValue.java b/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl/syncDone/SyncDoneValue.java
index 2d324640b..b78048ddd 100644
--- a/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl/syncDone/SyncDoneValue.java
+++ b/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl/syncDone/SyncDoneValue.java
@@ -52,26 +52,32 @@ public interface SyncDoneValue extends Control
/**
+ * get the cookie
+ *
* @return the cookie
*/
byte[] getCookie();
/**
+ * Set the cookie
+ *
* @param cookie cookie to be set
*/
void setCookie( byte[] cookie );
/**
- * @return true, if refreshDeletes flag is set, false otherwise
+ * Tells if the refreshDeletes flag is set to <code>true</code>
+ * @return <code>true</code>, if refreshDeletes flag is set, <code>false</code> otherwise
*/
boolean isRefreshDeletes();
/**
+ * Set the refreshDeletes flag
+ *
* @param refreshDeletes set the refreshDeletes flag
*/
void setRefreshDeletes( boolean refreshDeletes );
-
}
diff --git a/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl/syncRequest/SyncRequestValue.java b/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl/syncRequest/SyncRequestValue.java
index c036148e1..49c796747 100644
--- a/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl/syncRequest/SyncRequestValue.java
+++ b/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl/syncRequest/SyncRequestValue.java
@@ -36,36 +36,48 @@ public interface SyncRequestValue extends Control
/**
+ * Get the mode
+ *
* @return the mode
*/
SynchronizationModeEnum getMode();
/**
+ * Set the mode
+ *
* @param mode the syncMode to set
*/
void setMode( SynchronizationModeEnum mode );
/**
+ * Get the cookie
+ *
* @return the cookie
*/
byte[] getCookie();
/**
+ * Set the cookie
+ *
* @param cookie the cookie to set
*/
void setCookie( byte[] cookie );
/**
+ * Get the reloadHint flag
+ *
* @return the reloadHint
*/
boolean isReloadHint();
/**
+ * Set the reloadHint flag
+ *
* @param reloadHint the reloadHint to set
*/
void setReloadHint( boolean reloadHint );
diff --git a/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl/syncState/SyncStateTypeEnum.java b/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl/syncState/SyncStateTypeEnum.java
index ee20120ad..550c68251 100644
--- a/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl/syncState/SyncStateTypeEnum.java
+++ b/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl/syncState/SyncStateTypeEnum.java
@@ -73,6 +73,8 @@ public enum SyncStateTypeEnum
/**
+ * Get the value
+ *
* @return The value associated with the current element.
*/
public int getValue()
diff --git a/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl/syncState/SyncStateValue.java b/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl/syncState/SyncStateValue.java
index ca4d6d072..3b3342447 100644
--- a/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl/syncState/SyncStateValue.java
+++ b/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/syncrepl/syncState/SyncStateValue.java
@@ -57,19 +57,25 @@ public interface SyncStateValue extends Control
/**
- * @return the cookie
+ * get the cookie
+ *
+ * @return The cookie
*/
byte[] getCookie();
/**
- * @param cookie the cookie to set
+ * Set the cookie
+ *
+ * @param cookie The cookie to set
*/
void setCookie( byte[] cookie );
/**
- * @return the syncState's type
+ * Get the the syncState's type
+ *
+ * @return The syncState's type
*/
SyncStateTypeEnum getSyncStateType();
@@ -83,15 +89,17 @@ public interface SyncStateValue extends Control
/**
+ * Get the entryUUID
+ *
* @return the entryUUID
*/
byte[] getEntryUUID();
/**
- * set the entryUUID
+ * Set the entryUUID
*
- * @param entryUUID the entryUUID
+ * @param entryUUID The entryUUID
*/
void setEntryUUID( byte[] entryUUID );
}
diff --git a/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/transaction/TransactionSpecification.java b/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/transaction/TransactionSpecification.java
index 75f24183e..eb3c7daaf 100644
--- a/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/transaction/TransactionSpecification.java
+++ b/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/transaction/TransactionSpecification.java
@@ -33,6 +33,8 @@ public interface TransactionSpecification extends Control
String OID = "1.3.6.1.1.21.2";
/**
+ * Get the transaction identifier
+ *
* @return The transaction identifier
*/
byte[] getIdentifier();
@@ -40,6 +42,7 @@ public interface TransactionSpecification extends Control
/**
* Set the transaction ID
+ *
* @param identifier The transaction identifier, an opaque byte array
*/
void setIdentifier( byte[] identifier );
diff --git a/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/vlv/VirtualListViewRequest.java b/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/vlv/VirtualListViewRequest.java
index 185cd2537..0328af781 100644
--- a/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/vlv/VirtualListViewRequest.java
+++ b/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/vlv/VirtualListViewRequest.java
@@ -48,85 +48,112 @@ public interface VirtualListViewRequest extends Control
/**
+ * Get the number of entries before the target entry that are going to be sent
+ *
* @return The number of entries before the target entry that are going to be sent
*/
int getBeforeCount();
/**
- * @param beforeCount Set the number of entries to be returned before the target entry
+ * Set the number of entries to be returned before the target entry
+ *
+ * @param beforeCount The number of entries to be returned before the target entry
*/
void setBeforeCount( int beforeCount );
/**
+ * Get the number of entries after the target entry that are going to be sent
+ *
* @return The number of entries after the target entry that are going to be sent
*/
int getAfterCount();
/**
- * @param afterCount Set the number of entries to be returned after the target entry
+ * Set the number of entries to be returned after the target entry
+ *
+ * @param afterCount The number of entries to be returned after the target entry
*/
void setAfterCount( int afterCount );
/**
+ * Get the position of the target entry
+ *
* @return The position of the target entry
*/
int getOffset();
/**
+ * Set the position of the target entry
+ *
* @param offset the position of the target entry
*/
void setOffset( int offset );
/**
+ * Get the number of expected entries
+ *
* @return The number of expected entries
*/
int getContentCount();
/**
+ * Set the number of entries
+ *
* @param contentCount The number of entries
*/
void setContentCount( int contentCount );
/**
+ * Get the AssertionValue
+ *
* @return The AssertionValue
*/
byte[] getAssertionValue();
/**
- * @param assertionValue Set the AssertionValue
+ * Set the AssertionValue
+ *
+ * @param assertionValue The AssertionValue
*/
void setAssertionValue( byte[] assertionValue );
/**
+ * Get the ID used for this request
+ *
* @return The ID used for this request
*/
byte[] getContextId();
/**
- * @param contextId Set the context ID
+ * Set the context ID
+ *
+ * @param contextId The context ID
*/
void setContextId( byte[] contextId );
/**
- * @return <code>true</code> if the VLV target is an offset, false otherwise
+ * Tells if the VLV target is an offset
+ * @return <code>true</code> if the VLV target is an offset, <code>false</code> otherwise
*/
boolean hasOffset();
/**
- * @return <code>true</code> if the VLV target is an assertionValue, false otherwise
+ * Tells if the VLV target is an assertionValue
+ *
+ * @return <code>true</code> if the VLV target is an assertionValue, <code>false</code> otherwise
*/
boolean hasAssertionValue();
}
diff --git a/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/vlv/VirtualListViewResponse.java b/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/vlv/VirtualListViewResponse.java
index 003631973..910ab0904 100644
--- a/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/vlv/VirtualListViewResponse.java
+++ b/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/vlv/VirtualListViewResponse.java
@@ -57,6 +57,8 @@ public interface VirtualListViewResponse extends Control
/**
+ * Get the position in the list of entries
+ *
* @return the position in the list of entries
*/
int getTargetPosition();
@@ -71,6 +73,7 @@ public interface VirtualListViewResponse extends Control
/**
+ * Get the number of returned entries
* @return The number of returned entries
*/
int getContentCount();
@@ -85,6 +88,8 @@ public interface VirtualListViewResponse extends Control
/**
+ * Get the VLV result
+ *
* @return The VLV result
*/
VirtualListViewResultCode getVirtualListViewResult();
@@ -99,6 +104,8 @@ public interface VirtualListViewResponse extends Control
/**
+ * Get the context ID
+ *
* @return The context ID
*/
byte[] getContextId();
diff --git a/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/vlv/VirtualListViewResultCode.java b/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/vlv/VirtualListViewResultCode.java
index 3b085399c..7edf28cab 100644
--- a/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/vlv/VirtualListViewResultCode.java
+++ b/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/controls/vlv/VirtualListViewResultCode.java
@@ -80,6 +80,8 @@ public enum VirtualListViewResultCode
/**
+ * Get the value
+ *
* @return The associated integer value
*/
public int getValue()
@@ -89,6 +91,8 @@ public enum VirtualListViewResultCode
/**
+ * Get the associated description
+ *
* @return The associated description
*/
public String getDesc()
diff --git a/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/cancel/CancelRequest.java b/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/cancel/CancelRequest.java
index 095efe68a..e31f38efd 100644
--- a/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/cancel/CancelRequest.java
+++ b/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/cancel/CancelRequest.java
@@ -41,6 +41,8 @@ public interface CancelRequest extends ExtendedRequest
/**
+ * Get the cancel ID
+ *
* @return The id of the Message to cancel.
*/
int getCancelId();
diff --git a/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/certGeneration/CertGenerationRequest.java b/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/certGeneration/CertGenerationRequest.java
index 6c3ef1522..379c7d261 100644
--- a/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/certGeneration/CertGenerationRequest.java
+++ b/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/certGeneration/CertGenerationRequest.java
@@ -42,7 +42,6 @@ public interface CertGenerationRequest extends ExtendedRequest
/** The OID for the Certificate Generation extended operation request. */
String EXTENSION_OID = "1.3.6.1.4.1.18060.0.1.8";
-
/**
* Get the Target DN for the certificate storage
*
@@ -60,6 +59,8 @@ public interface CertGenerationRequest extends ExtendedRequest
/**
+ * Get the Issuer's DN
+ *
* @return The issuer's DN
*/
String getIssuerDN();
@@ -74,6 +75,7 @@ public interface CertGenerationRequest extends ExtendedRequest
/**
+ * Get the Subect's DN
* @return The subect's DN
*/
String getSubjectDN();
@@ -88,6 +90,8 @@ public interface CertGenerationRequest extends ExtendedRequest
/**
+ * Get the Key algorithm
+ *
* @return The Key algorithm
*/
String getKeyAlgorithm();
@@ -95,6 +99,7 @@ public interface CertGenerationRequest extends ExtendedRequest
/**
* Sets the Key algorithm
+ *
* @param keyAlgorithm The Key algorithm
*/
void setKeyAlgorithm( String keyAlgorithm );
diff --git a/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/endTransaction/EndTransactionRequest.java b/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/endTransaction/EndTransactionRequest.java
index 20fcf9d00..49c5ee339 100644
--- a/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/endTransaction/EndTransactionRequest.java
+++ b/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/endTransaction/EndTransactionRequest.java
@@ -49,6 +49,8 @@ public interface EndTransactionRequest extends ExtendedRequest
String EXTENSION_OID = "1.3.6.1.1.21.3";
/**
+ * Tells if the operation should be committed
+ *
* @return <code>true</code> if the operation should be committed, <code>false</code> otherwise
*/
boolean getCommit();
@@ -64,9 +66,12 @@ public interface EndTransactionRequest extends ExtendedRequest
/**
+ * Get the transaction ID
+ *
* @return The transaction ID
*/
byte[] getTransactionId();
+
/**
* Set the transaction ID to commit or rollback
diff --git a/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/endTransaction/EndTransactionResponse.java b/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/endTransaction/EndTransactionResponse.java
index 94008f80e..390f4f9d8 100644
--- a/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/endTransaction/EndTransactionResponse.java
+++ b/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/endTransaction/EndTransactionResponse.java
@@ -59,18 +59,24 @@ public interface EndTransactionResponse extends ExtendedResponse
/**
+ * Get the failed message ID
+ *
* @return The Message ID if failure
*/
int getFailedMessageId();
/**
+ * Set the failed message ID
+ *
* @param failedMessageId The messageId that causes the failure
*/
void setFailedMessageId( int failedMessageId );
/**
+ * Get the list of update controls
+ *
* @return the list of <messageId, Controls> processed within the transaction
*/
List<UpdateControls> getUpdateControls();
diff --git a/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/endTransaction/EndTransactionResponseImpl.java b/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/endTransaction/EndTransactionResponseImpl.java
index 6765e0dbc..2f25b2081 100644
--- a/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/endTransaction/EndTransactionResponseImpl.java
+++ b/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/endTransaction/EndTransactionResponseImpl.java
@@ -130,7 +130,7 @@ public class EndTransactionResponseImpl extends AbstractExtendedResponse impleme
}
/**
- * @return the updateControls
+ * {@inheritDoc}
*/
@Override
public List<UpdateControls> getUpdateControls()
@@ -140,6 +140,8 @@ public class EndTransactionResponseImpl extends AbstractExtendedResponse impleme
/**
+ * Set the update controls
+ *
* @param updateControls the updateControls to set
*/
public void setUpdateControls( List<UpdateControls> updateControls )
diff --git a/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/endTransaction/UpdateControls.java b/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/endTransaction/UpdateControls.java
index 9c17b592f..f5ecd09ff 100644
--- a/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/endTransaction/UpdateControls.java
+++ b/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/endTransaction/UpdateControls.java
@@ -55,6 +55,8 @@ public class UpdateControls
/**
+ * Get the message ID
+ *
* @return The messageID
*/
public int getMessageId()
@@ -64,6 +66,8 @@ public class UpdateControls
/**
+ * Set the message ID
+ *
* @param messageId the messageId to set
*/
public void setMessageId( int messageId )
@@ -73,6 +77,8 @@ public class UpdateControls
/**
+ * Get the set of controls associated with the messageID
+ *
* @return The set of controls associated with the messageID
*/
public List<Control> getControls()
@@ -82,6 +88,8 @@ public class UpdateControls
/**
+ * Set controls
+ *
* @param controls the controls to set
*/
public void setControls( List<Control> controls )
diff --git a/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/pwdModify/PasswordModifyRequest.java b/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/pwdModify/PasswordModifyRequest.java
index ae594a641..b29cca612 100644
--- a/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/pwdModify/PasswordModifyRequest.java
+++ b/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/pwdModify/PasswordModifyRequest.java
@@ -42,6 +42,8 @@ public interface PasswordModifyRequest extends ExtendedRequest
/**
+ * Get the user identioty
+ *
* @return the userIdentity
*/
byte[] getUserIdentity();
@@ -56,6 +58,8 @@ public interface PasswordModifyRequest extends ExtendedRequest
/**
+ * Get the previous password
+ *
* @return the oldPassword
*/
byte[] getOldPassword();
@@ -70,6 +74,8 @@ public interface PasswordModifyRequest extends ExtendedRequest
/**
+ * Get the new password
+ *
* @return the newPassword
*/
byte[] getNewPassword();
diff --git a/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/startTransaction/StartTransactionResponse.java b/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/startTransaction/StartTransactionResponse.java
index 624d9c9b2..9430793d5 100644
--- a/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/startTransaction/StartTransactionResponse.java
+++ b/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/startTransaction/StartTransactionResponse.java
@@ -40,6 +40,8 @@ import org.apache.directory.api.ldap.model.message.ExtendedResponse;
public interface StartTransactionResponse extends ExtendedResponse
{
/**
+ * Get the transaction ID
+ *
* @return The transaction ID if success
*/
byte[] getTransactionId();
diff --git a/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/startTransaction/StartTransactionResponseImpl.java b/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/startTransaction/StartTransactionResponseImpl.java
index 672d553be..2cd65151c 100644
--- a/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/startTransaction/StartTransactionResponseImpl.java
+++ b/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/startTransaction/StartTransactionResponseImpl.java
@@ -174,7 +174,9 @@ public class StartTransactionResponseImpl extends AbstractExtendedResponse imple
/**
- * {@inheritDoc}
+ * Set the transaction ID
+ *
+ * @param transactionId The transaction ID to set
*/
public void setTransactionId( byte[] transactionId )
{
diff --git a/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/storedProcedure/StoredProcedureRequest.java b/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/storedProcedure/StoredProcedureRequest.java
index 182dac707..070ef05d0 100644
--- a/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/storedProcedure/StoredProcedureRequest.java
+++ b/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/storedProcedure/StoredProcedureRequest.java
@@ -53,12 +53,16 @@ public interface StoredProcedureRequest extends ExtendedRequest
/**
+ * Get the procedure bytecode
+ *
* @return The byte[] containing the procedure's bytecode
*/
byte[] getProcedure();
/**
+ * Set the procedure bytecode
+ *
* @param procedure The procedure's bytecode
*/
void setProcedure( byte[] procedure );
@@ -134,6 +138,8 @@ public interface StoredProcedureRequest extends ExtendedRequest
/**
+ * Get the list of parameters for this stored procedure
+ *
* @return The list of parameters for this stored procedure
*/
List<StoredProcedureParameter> getParameters();
diff --git a/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/whoAmI/WhoAmIResponse.java b/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/whoAmI/WhoAmIResponse.java
index fd3d8212e..86e30e7be 100644
--- a/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/whoAmI/WhoAmIResponse.java
+++ b/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/extended/whoAmI/WhoAmIResponse.java
@@ -40,13 +40,17 @@ public interface WhoAmIResponse extends ExtendedResponse
/**
+ * Tells if the response contains a DN authz (dn:XXX)
+ *
* @return true if the response contains a DN authz (dn:XXX)
*/
boolean isDnAuthzId();
/**
- * @return true if the response contains a userID authz (u:XXX)
+ * Tells if the response contains a userID authz (u:XXX)
+ *
+ * @return <code>true</code> if the response contains a userID authz (u:XXX)
*/
boolean isUserAuthzId();
diff --git a/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/intermediate/syncrepl/SyncInfoValue.java b/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/intermediate/syncrepl/SyncInfoValue.java
index 565f00f66..d3a6ae181 100644
--- a/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/intermediate/syncrepl/SyncInfoValue.java
+++ b/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/intermediate/syncrepl/SyncInfoValue.java
@@ -70,60 +70,78 @@ public interface SyncInfoValue extends IntermediateResponse
/**
+ * Set the the synchronization type
+ *
* @param type the synchronization type to set
*/
void setSyncInfoValueType( SynchronizationInfoEnum type );
/**
+ * Get the cookie
+ *
* @return the cookie
*/
byte[] getCookie();
/**
+ * Set the cookie
+ *
* @param cookie the cookie to set
*/
void setCookie( byte[] cookie );
/**
+ * Tells if the refreshDone flag is set to <code>true</code>
+ *
* @return the refreshDone
*/
boolean isRefreshDone();
/**
+ * Set the refreshDone flag
+ *
* @param refreshDone the refreshDone to set
*/
void setRefreshDone( boolean refreshDone );
/**
+ * Tells if the refreshDeletes flag is set to <code>true</code>
+ *
* @return the refreshDeletes
*/
boolean isRefreshDeletes();
/**
+ * Set the refreshDeletes flag
+ *
* @param refreshDeletes the refreshDeletes to set
*/
void setRefreshDeletes( boolean refreshDeletes );
/**
+ * Get the syncUUIDs
* @return the syncUUIDs
*/
List<byte[]> getSyncUUIDs();
/**
+ * Set the syncUUIDs
* @param syncUUIDs the syncUUIDs to set
*/
void setSyncUUIDs( List<byte[]> syncUUIDs );
/**
+ * Set the syncUUID
+ *
* @param syncUUID the syncUUIDs to set
*/
void addSyncUUID( byte[] syncUUID );
diff --git a/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/intermediate/syncrepl/SynchronizationInfoEnum.java b/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/intermediate/syncrepl/SynchronizationInfoEnum.java
index b85d2120f..758860202 100644
--- a/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/intermediate/syncrepl/SynchronizationInfoEnum.java
+++ b/ldap/extras/codec-api/src/main/java/org/apache/directory/api/ldap/extras/intermediate/syncrepl/SynchronizationInfoEnum.java
@@ -64,6 +64,8 @@ public enum SynchronizationInfoEnum
/**
+ * Get the value associated with the current element.
+ *
* @return The value associated with the current element.
*/
public int getValue()
(directory-ldap-api) 02/06: Some more javadoc fixes. Maki-e it so the maven javadoc plugin don't show private members javadoc errors, and more than 100 warnings.errors
Posted by el...@apache.org.
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
commit 29be93bd23a21fbcfd5db144da728d0ecff3443c
Author: emmanuel lecharny <el...@apache.org>
AuthorDate: Thu Feb 6 05:32:23 2025 +0100
Some more javadoc fixes. Maki-e it so the maven javadoc plugin don't show private members javadoc errors, and more than 100 warnings.errors
---
.../directory/api/dsmlv2/engine/Dsmlv2Engine.java | 8 +
.../directory/api/dsmlv2/AbstractGrammar.java | 8 +
.../org/apache/directory/api/dsmlv2/Container.java | 2 +
.../apache/directory/api/dsmlv2/DsmlControl.java | 2 +
.../apache/directory/api/dsmlv2/DsmlLiterals.java | 203 ++++++++++++++++++++-
.../api/dsmlv2/request/AddRequestDsml.java | 2 +
.../directory/api/dsmlv2/request/AndFilter.java | 9 +
.../dsmlv2/request/AttributeValueAssertion.java | 12 +-
.../api/dsmlv2/request/BatchRequestDsml.java | 4 +-
.../api/dsmlv2/request/ConnectorFilter.java | 8 +
.../api/dsmlv2/request/Dsmlv2Grammar.java | 2 +
.../api/dsmlv2/request/ExtensibleMatchFilter.java | 8 +
.../directory/api/dsmlv2/request/Filter.java | 8 +
.../api/dsmlv2/request/ModifyRequestDsml.java | 2 +
.../directory/api/dsmlv2/request/NotFilter.java | 9 +
.../directory/api/dsmlv2/request/OrFilter.java | 9 +
.../api/dsmlv2/request/PresentFilter.java | 8 +
.../api/dsmlv2/request/SubstringFilter.java | 8 +
.../api/dsmlv2/response/ErrorResponse.java | 2 +
.../api/dsmlv2/response/SearchResultEntryDsml.java | 4 +-
.../api/ldap/codec/api/LdapApiService.java | 2 +
.../protectedItem/AllUserAttributeTypesItem.java | 2 +-
ldap/extras/trigger/pom.xml | 10 +
.../directory/api/ldap/trigger/LdapOperation.java | 2 +
.../api/ldap/trigger/StoredProcedureParameter.java | 137 ++++++++++++--
.../api/ldap/schema/loader/EntityFactory.java | 2 +
.../schema/manager/impl/DefaultSchemaManager.java | 18 +-
pom.xml | 8 +-
28 files changed, 471 insertions(+), 28 deletions(-)
diff --git a/dsml/engine/src/main/java/org/apache/directory/api/dsmlv2/engine/Dsmlv2Engine.java b/dsml/engine/src/main/java/org/apache/directory/api/dsmlv2/engine/Dsmlv2Engine.java
index dfd4da34e..72d0a2497 100644
--- a/dsml/engine/src/main/java/org/apache/directory/api/dsmlv2/engine/Dsmlv2Engine.java
+++ b/dsml/engine/src/main/java/org/apache/directory/api/dsmlv2/engine/Dsmlv2Engine.java
@@ -122,6 +122,7 @@ public class Dsmlv2Engine
/** The batch response. */
protected BatchResponseDsml batchResponse = new BatchResponseDsml();
+ /** The DSML v2 grammar */
protected Dsmlv2Grammar grammar = new Dsmlv2Grammar();
/** flag to indicate to generate the response in a SOAP envelope */
@@ -130,6 +131,7 @@ public class Dsmlv2Engine
/** A logger for this class */
private static final Logger LOG = LoggerFactory.getLogger( Dsmlv2Engine.class );
+ /** The body envelope */
private static final String BODY_ENVELOPE = "</Body></Envelope>";
@@ -546,6 +548,7 @@ public class Dsmlv2Engine
/**
+ * Get the generate Soap Response
* @return the generateSoapResp
*/
public boolean isGenerateSoapResp()
@@ -555,6 +558,7 @@ public class Dsmlv2Engine
/**
+ * Set the generate Soa pResponse
* @param generateSoapResp the generateSoapResp to set
*/
public void setGenerateSoapResp( boolean generateSoapResp )
@@ -564,6 +568,8 @@ public class Dsmlv2Engine
/**
+ * Get the BatchResponse
+ *
* @return the batchResponse
*/
public BatchResponseDsml getBatchResponse()
@@ -573,6 +579,8 @@ public class Dsmlv2Engine
/**
+ * Get the LdapConnection
+ *
* @return the connection
*/
public LdapConnection getConnection()
diff --git a/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/AbstractGrammar.java b/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/AbstractGrammar.java
index b0a306a95..2b03637f6 100644
--- a/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/AbstractGrammar.java
+++ b/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/AbstractGrammar.java
@@ -47,6 +47,14 @@ public abstract class AbstractGrammar implements Grammar
/** The grammar name */
protected String name;
+ /**
+ * Default constructor
+ */
+ public AbstractGrammar()
+ {
+ // Nothing to do
+ }
+
/**
* Returns the grammar's name
diff --git a/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/Container.java b/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/Container.java
index bda5548dc..3ddf861ba 100644
--- a/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/Container.java
+++ b/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/Container.java
@@ -60,6 +60,8 @@ public interface Container
/**
+ * Get the states
+ *
* @return Returns the states.
*/
Enum<Dsmlv2StatesEnum>[] getStates();
diff --git a/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/DsmlControl.java b/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/DsmlControl.java
index 3c6dfc5c6..2290faafe 100644
--- a/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/DsmlControl.java
+++ b/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/DsmlControl.java
@@ -57,6 +57,8 @@ public class DsmlControl<C extends Control> implements Control, DsmlDecorator<C>
/**
+ * Get the LdapApiService instance
+ *
* @return The LDAP codec service.
*/
public LdapApiService getCodecService()
diff --git a/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/DsmlLiterals.java b/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/DsmlLiterals.java
index c32c1ca14..286fd769a 100644
--- a/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/DsmlLiterals.java
+++ b/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/DsmlLiterals.java
@@ -26,107 +26,308 @@ package org.apache.directory.api.dsmlv2;
*/
public final class DsmlLiterals
{
- /** Some literal */
+ // Some literal
+ /** Abandon ID */
public static final String ABANDON_ID = "abandonID";
+
+ /** AbandonRequest */
public static final String ABANDON_REQUEST = "abandonRequest";
+
+ /** Add */
public static final String ADD = "add";
+
+ /** AddRequest */
public static final String ADD_REQUEST = "addRequest";
+
+ /** AddResponse */
public static final String ADD_RESPONSE = "addResponse";
+
+ /** And */
public static final String AND = "and";
+
+ /** Any */
public static final String ANY = "any";
+
+ /** ApproxMatch */
public static final String APPROX_MATCH = "approxMatch";
+
+ /** Assertion */
public static final String ASSERTION = "assertion";
+
+ /** Attr */
public static final String ATTR = "attr";
+
+ /** Attribute */
public static final String ATTRIBUTE = "attribute";
+
+ /** Attributes */
public static final String ATTRIBUTES = "attributes";
+
+ /** AuthRequest */
public static final String AUTH_REQUEST = "authRequest";
+
+ /** AuthResponse */
public static final String AUTH_RESPONSE = "authResponse";
+
+ /** BaseObject */
public static final String BASE_OBJECT = "baseObject";
+
+ /** BatchRequest */
public static final String BATCH_REQUEST = "batchRequest";
+
+ /** BatchResponse */
public static final String BATCH_RESPONSE = "batchResponse";
+
+ /** Body */
public static final String BODY = "body";
+
+ /** code */
public static final String CODE = "code";
+
+ /** CompareRequest */
public static final String COMPARE_REQUEST = "compareRequest";
+
+ /** CompareResponse */
public static final String COMPARE_RESPONSE = "compareResponse";
+
+ /** Control */
public static final String CONTROL = "control";
+
+ /** ControlValue */
public static final String CONTROL_VALUE = "controlValue";
+
+ /** Citicality */
public static final String CRITICALITY = "criticality";
+
+ /** DelRequest */
public static final String DEL_REQUEST = "delRequest";
+
+ /** DelResponse */
public static final String DEL_RESPONSE = "delResponse";
+
+ /** Delete */
public static final String DELETE = "delete";
+
+ /** Deleteoldrdn */
public static final String DELETE_OLD_RDN = "deleteoldrdn";
+
+ /** DerefAliases */
public static final String DEREF_ALIASES = "derefAliases";
+
+ /** DerefAlways */
public static final String DEREF_ALWAYS = "derefAlways";
+
+ /** DerefFindingBaseObj */
public static final String DEREF_FINDING_BASE_OBJ = "derefFindingBaseObj";
+
+ /** DerefInSearching */
public static final String DEREF_IN_SEARCHING = "derefInSearching";
+
+ /** Descr */
public static final String DESCR = "descr";
+
+ /** Detail */
public static final String DETAIL = "detail";
+
+ /** Dn */
public static final String DN = "dn";
+
+ /** DnAttributes */
public static final String DN_ATTRIBUTES = "dnAttributes";
+
+ /** Envelope */
public static final String ENVELOPE = "envelope";
+
+ /** EqualityMatch */
public static final String EQUALITY_MATCH = "equalityMatch";
+
+ /** Error */
public static final String ERROR = "error";
+
+ /** ErrorMessage */
public static final String ERROR_MESSAGE = "errorMessage";
+
+ /** ErrorResponse */
public static final String ERROR_RESPONSE = "errorResponse";
+
+ /** exit */
public static final String EXIT = "exit";
+
+ /** ExtendedRequest */
public static final String EXTENDED_REQUEST = "extendedRequest";
+
+ /** ExtendedResponse */
public static final String EXTENDED_RESPONSE = "extendedResponse";
+
+ /** ExtensibleMatch */
public static final String EXTENSIBLE_MATCH = "extensibleMatch";
+
+ /** False */
public static final String FALSE = "false";
+
+ /** Filter */
public static final String FILTER = "filter";
+
+ /** Final */
public static final String FINAL = "final";
+
+ /** GreaterOrEqual */
public static final String GREATER_OR_EQUAL = "greaterOrEqual";
+
+ /** Header */
public static final String HEADER = "header";
+
+ /** Increment */
public static final String INCREMENT = "increment";
+
+ /** Initial */
public static final String INITIAL = "initial";
+
+ /** LessOrEqual */
public static final String LESS_OR_EQUAL = "lessOrEqual";
+
+ /** MatchedDN */
public static final String MATCHED_DN = "matchedDN";
+
+ /** MatchingRule */
public static final String MATCHING_RULE = "matchingRule";
+
+ /** Message */
public static final String MESSAGE = "message";
+
+ /** ModDNRequest */
public static final String MOD_DN_REQUEST = "modDNRequest";
+
+ /** ModDNResponse */
public static final String MOD_DN_RESPONSE = "modDNResponse";
+
+ /** Modification*/
public static final String MODIFICATION = "modification";
+
+ /** ModifyRequest */
public static final String MODIFY_REQUEST = "modifyRequest";
+
+ /** ModifyResponse */
public static final String MODIFY_RESPONSE = "modifyResponse";
+
+ /** Name */
public static final String NAME = "name";
+
+ /** NeverDerefAliases */
public static final String NEVER_DEREF_ALIASES = "neverDerefAliases";
+
+ /** NewRdn*/
public static final String NEW_RDN = "newrdn";
+
+ /** NewSuperior */
public static final String NEW_SUPERIOR = "newSuperior";
+
+ /** Not */
public static final String NOT = "not";
+
+ /** OnError */
public static final String ON_ERROR = "onError";
+
+ /** Operation */
public static final String OPERATION = "operation";
+
+ /** Or */
public static final String OR = "or";
+
+ /** Parallel */
public static final String PARALLEL = "parallel";
+
+ /** Present */
public static final String PRESENT = "present";
+
+ /** Principal */
public static final String PRINCIPAL = "principal";
+
+ /** Processing*/
public static final String PROCESSING = "processing";
+
+ /** Ref */
public static final String REF = "ref";
+
+ /** Referral */
public static final String REFERRAL = "referral";
+
+ /** Replace */
public static final String REPLACE = "replace";
+
+ /** RequestID */
public static final String REQUEST_ID = "requestID";
+
+ /** RequestName */
public static final String REQUEST_NAME = "requestName";
+
+ /** RequestValue */
public static final String REQUEST_VALUE = "requestValue";
+
+ /** Response */
public static final String RESPONSE = "response";
+
+ /** ResponseName */
public static final String RESPONSE_NAME = "responseName";
+
+ /** ResponseOrder */
public static final String RESPONSE_ORDER = "responseOrder";
+
+ /** ResultCode */
public static final String RESULT_CODE = "resultCode";
+
+ /** Resume */
public static final String RESUME = "resume";
+
+ /** Scope */
public static final String SCOPE = "scope";
+
+ /** SearchRequest */
public static final String SEARCH_REQUEST = "searchRequest";
+
+ /** SearchResponse */
public static final String SEARCH_RESPONSE = "searchResponse";
+
+ /** SearchResultDone */
public static final String SEARCH_RESULT_DONE = "searchResultDone";
+
+ /** SearchResultEntry */
public static final String SEARCH_RESULT_ENTRY = "searchResultEntry";
+
+ /** SearchResultReference */
public static final String SEARCH_RESULT_REFERENCE = "searchResultReference";
+
+ /** Sequential */
public static final String SEQUENTIAL = "sequential";
+
+ /** SingleLevel */
public static final String SINGLE_LEVEL = "singleLevel";
+
+ /** SizeLimit */
public static final String SIZE_LIMIT = "sizeLimit";
+
+ /**Substrings */
public static final String SUBSTRINGS = "substrings";
+
+ /** TimeLimit */
public static final String TIME_LIMIT = "timeLimit";
+
+ /** True */
public static final String TRUE = "true";
+
+ /** Type */
public static final String TYPE = "type";
+
+ /** TypesOnly */
public static final String TYPES_ONLY = "typesOnly";
+
+ /** Unordered */
public static final String UNORDERED = "unordered";
+
+ /**Value */
public static final String VALUE = "value";
+
+ /** WholeSubtree */
public static final String WHOLE_SUBTREE = "wholeSubtree";
private DsmlLiterals()
diff --git a/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/AddRequestDsml.java b/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/AddRequestDsml.java
index 759508056..3eb9c40ca 100644
--- a/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/AddRequestDsml.java
+++ b/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/AddRequestDsml.java
@@ -99,6 +99,8 @@ public class AddRequestDsml
/**
+ * Get the current attributeType
+ *
* @return Returns the currentAttribute type.
*/
public String getCurrentAttributeType()
diff --git a/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/AndFilter.java b/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/AndFilter.java
index 3a697db43..b9881c0e8 100644
--- a/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/AndFilter.java
+++ b/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/AndFilter.java
@@ -30,6 +30,15 @@ import java.util.List;
*/
public class AndFilter extends ConnectorFilter
{
+ /**
+ * Default constructor
+ */
+ public AndFilter()
+ {
+ super();
+ }
+
+
/**
* Get the AndFilter.
*
diff --git a/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/AttributeValueAssertion.java b/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/AttributeValueAssertion.java
index d622781ce..4427ae600 100644
--- a/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/AttributeValueAssertion.java
+++ b/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/AttributeValueAssertion.java
@@ -42,18 +42,22 @@ import org.apache.directory.api.util.Strings;
*/
public class AttributeValueAssertion
{
- // ~ Instance fields
- // ----------------------------------------------------------------------------
-
/** The attribute description */
private String attributeDesc;
/** The assertion value */
private Value assertionValue;
+ /**
+ * Default constructor
+ */
+ public AttributeValueAssertion()
+ {
+ // Nothing to do
+ }
+
/**
- *
* Helper method to render an object which can be a String or a byte[]
*
* @param object The Value to dump
diff --git a/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/BatchRequestDsml.java b/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/BatchRequestDsml.java
index 23ce4c518..ad0bcfcfb 100644
--- a/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/BatchRequestDsml.java
+++ b/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/BatchRequestDsml.java
@@ -315,7 +315,9 @@ public class BatchRequestDsml
/**
- * @return true if the request objects are stored, false otherwise
+ * Tells if the request objects are stored
+ *
+ * @return <code>true</code> if the request objects are stored, <code>false</code> otherwise
*/
public boolean isStoringRequests()
{
diff --git a/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/ConnectorFilter.java b/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/ConnectorFilter.java
index 35aec4791..5d97ea2a0 100644
--- a/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/ConnectorFilter.java
+++ b/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/ConnectorFilter.java
@@ -37,6 +37,14 @@ public abstract class ConnectorFilter extends Filter
/** The set of filters used by And/Or filters */
protected List<Filter> filterSet;
+ /**
+ * Default constructor
+ */
+ public ConnectorFilter()
+ {
+ super();
+ }
+
/**
* Add a new Filter to the list.
diff --git a/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/Dsmlv2Grammar.java b/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/Dsmlv2Grammar.java
index 691f06f8a..5243b8255 100644
--- a/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/Dsmlv2Grammar.java
+++ b/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/Dsmlv2Grammar.java
@@ -3176,6 +3176,8 @@ public final class Dsmlv2Grammar extends AbstractGrammar implements Grammar
/**
+ * Get the LdapApiService instance
+ *
* @return The LDAP codec service.
*/
public LdapApiService getLdapCodecService()
diff --git a/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/ExtensibleMatchFilter.java b/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/ExtensibleMatchFilter.java
index a6ac54e5c..1f2eec962 100644
--- a/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/ExtensibleMatchFilter.java
+++ b/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/ExtensibleMatchFilter.java
@@ -40,6 +40,14 @@ public class ExtensibleMatchFilter extends Filter
/** The dnAttributes flag */
private boolean dnAttributes = false;
+ /**
+ * Default constructor
+ */
+ public ExtensibleMatchFilter()
+ {
+ super();
+ }
+
/**
* Get the dnAttributes flag
diff --git a/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/Filter.java b/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/Filter.java
index 0ba91301a..57276260b 100644
--- a/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/Filter.java
+++ b/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/Filter.java
@@ -32,6 +32,14 @@ public class Filter
/** The parent Filter */
protected Filter parent;
+ /**
+ * Default constructor
+ */
+ public Filter()
+ {
+ // Nothing to do
+ }
+
/**
* Get the parent
diff --git a/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/ModifyRequestDsml.java b/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/ModifyRequestDsml.java
index 306eec688..942cd45f5 100644
--- a/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/ModifyRequestDsml.java
+++ b/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/ModifyRequestDsml.java
@@ -85,6 +85,8 @@ public class ModifyRequestDsml
/**
+ * Get the cirrent attribute's type
+ *
* @return the current attribute's type
*/
public String getCurrentAttributeType()
diff --git a/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/NotFilter.java b/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/NotFilter.java
index 4a6740e8c..e991d7232 100644
--- a/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/NotFilter.java
+++ b/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/NotFilter.java
@@ -31,6 +31,15 @@ import org.apache.directory.api.i18n.I18n;
*/
public class NotFilter extends ConnectorFilter
{
+ /**
+ * Default constructor
+ */
+ public NotFilter()
+ {
+ super();
+ }
+
+
/**
* Subclass the addFilterMethod, as this is specific for a NotFilter (we
* cannot have more than one elements).
diff --git a/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/OrFilter.java b/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/OrFilter.java
index 195dd0fe9..c1b932c4d 100644
--- a/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/OrFilter.java
+++ b/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/OrFilter.java
@@ -30,6 +30,15 @@ import java.util.List;
*/
public class OrFilter extends ConnectorFilter
{
+ /**
+ * Default constructor
+ */
+ public OrFilter()
+ {
+ super();
+ }
+
+
/**
* Get the OrFilter
*
diff --git a/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/PresentFilter.java b/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/PresentFilter.java
index c585028b7..b3207ab08 100644
--- a/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/PresentFilter.java
+++ b/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/PresentFilter.java
@@ -30,6 +30,14 @@ public class PresentFilter extends Filter
/** The attribute description. */
private String attributeDescription;
+ /**
+ * Default constructor
+ */
+ public PresentFilter()
+ {
+ super();
+ }
+
/**
* Get the attribute
diff --git a/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/SubstringFilter.java b/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/SubstringFilter.java
index 5c794a9b5..79447220f 100644
--- a/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/SubstringFilter.java
+++ b/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/request/SubstringFilter.java
@@ -54,6 +54,14 @@ public class SubstringFilter extends Filter
/** The final filter */
private String finalSubstrings;
+ /**
+ * Default constructor
+ */
+ public SubstringFilter()
+ {
+ super();
+ }
+
/**
* Get the internal substrings
diff --git a/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/ErrorResponse.java b/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/ErrorResponse.java
index b0baabd98..374372683 100644
--- a/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/ErrorResponse.java
+++ b/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/ErrorResponse.java
@@ -278,6 +278,8 @@ public class ErrorResponse extends AbstractResponse implements Response, DsmlDec
/**
+ * Get the LdapApiService instance
+ *
* @return The LdapApiService instance
*/
public LdapApiService getCodecService()
diff --git a/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/SearchResultEntryDsml.java b/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/SearchResultEntryDsml.java
index 41b92daf8..a795457ad 100644
--- a/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/SearchResultEntryDsml.java
+++ b/dsml/parser/src/main/java/org/apache/directory/api/dsmlv2/response/SearchResultEntryDsml.java
@@ -77,7 +77,9 @@ public class SearchResultEntryDsml
/**
- * @return The current ATtributeType
+ * Get the current attributeType
+ *
+ * @return The current AttributeType
*/
public Attribute getCurrentAttribute()
{
diff --git a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/LdapApiService.java b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/LdapApiService.java
index 57a64fac0..2123c2c8a 100644
--- a/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/LdapApiService.java
+++ b/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/LdapApiService.java
@@ -142,6 +142,8 @@ public interface LdapApiService
/**
+ * Get the request control factories
+ *
* @return the request controlFactories
*/
Map<String, ControlFactory<? extends Control>> getRequestControlFactories();
diff --git a/ldap/extras/aci/src/main/java/org/apache/directory/api/ldap/aci/protectedItem/AllUserAttributeTypesItem.java b/ldap/extras/aci/src/main/java/org/apache/directory/api/ldap/aci/protectedItem/AllUserAttributeTypesItem.java
index f4a8f6faf..5c20a590c 100644
--- a/ldap/extras/aci/src/main/java/org/apache/directory/api/ldap/aci/protectedItem/AllUserAttributeTypesItem.java
+++ b/ldap/extras/aci/src/main/java/org/apache/directory/api/ldap/aci/protectedItem/AllUserAttributeTypesItem.java
@@ -34,7 +34,7 @@ public class AllUserAttributeTypesItem extends ProtectedItem
/**
* Default constructor
*/
- public AllUserAttributeTypesItem
+ public AllUserAttributeTypesItem()
{
super();
}
diff --git a/ldap/extras/trigger/pom.xml b/ldap/extras/trigger/pom.xml
index 463c42781..30f19d7e4 100644
--- a/ldap/extras/trigger/pom.xml
+++ b/ldap/extras/trigger/pom.xml
@@ -69,6 +69,16 @@
<build>
<plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <configuration>
+ <sourceFileExcludes>
+ <sourceFileExclude>**/Antlr*</sourceFileExclude>
+ </sourceFileExcludes>
+ </configuration>
+ </plugin>
+
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>antlr-maven-plugin</artifactId>
diff --git a/ldap/extras/trigger/src/main/java/org/apache/directory/api/ldap/trigger/LdapOperation.java b/ldap/extras/trigger/src/main/java/org/apache/directory/api/ldap/trigger/LdapOperation.java
index 96951cd45..5387dbbd9 100644
--- a/ldap/extras/trigger/src/main/java/org/apache/directory/api/ldap/trigger/LdapOperation.java
+++ b/ldap/extras/trigger/src/main/java/org/apache/directory/api/ldap/trigger/LdapOperation.java
@@ -65,6 +65,8 @@ public enum LdapOperation
/**
+ * Get the Ldap Operation name
+ *
* @return the name of this LDAP operation
*/
public String getName()
diff --git a/ldap/extras/trigger/src/main/java/org/apache/directory/api/ldap/trigger/StoredProcedureParameter.java b/ldap/extras/trigger/src/main/java/org/apache/directory/api/ldap/trigger/StoredProcedureParameter.java
index 6116e44b3..25b5f44ae 100644
--- a/ldap/extras/trigger/src/main/java/org/apache/directory/api/ldap/trigger/StoredProcedureParameter.java
+++ b/ldap/extras/trigger/src/main/java/org/apache/directory/api/ldap/trigger/StoredProcedureParameter.java
@@ -59,6 +59,8 @@ public abstract class StoredProcedureParameter
/**
+ * Get the context name
+ *
* @return The context name
*/
public Dn getCtxName()
@@ -93,6 +95,8 @@ public abstract class StoredProcedureParameter
/**
+ * Get the generic Operation Principal instance
+ *
* @return The generic Operation Principal instance
*/
public static StoredProcedureParameter instance()
@@ -101,9 +105,15 @@ public abstract class StoredProcedureParameter
}
}
+ /** The stored procedure name */
protected final String name;
+ /**
+ * Store the StoredProcedure name
+ *
+ * @param name The StoredProcedure nale
+ */
protected StoredProcedureParameter( String name )
{
this.name = name;
@@ -111,6 +121,8 @@ public abstract class StoredProcedureParameter
/**
+ * Get the StoredProcedure name
+ *
* @return the name of this Stored Procedure Parameter.
*/
public String getName()
@@ -130,8 +142,7 @@ public abstract class StoredProcedureParameter
/**
- * @see java.lang.Object#hashCode()
- * @return the instance's hash code
+ * {@inheritDoc}
*/
@Override
public int hashCode()
@@ -145,7 +156,7 @@ public abstract class StoredProcedureParameter
/**
- * @see java.lang.Object#equals(java.lang.Object)
+ * {@inheritDoc}
*/
@Override
public boolean equals( Object obj )
@@ -190,7 +201,11 @@ public abstract class StoredProcedureParameter
{
private static Modify_OBJECT instance = new Modify_OBJECT( "$object" );
-
+ /**
+ * A private constructor
+ *
+ * @param identifier The ProcedureStored name
+ */
private Modify_OBJECT( String identifier )
{
super( identifier );
@@ -198,6 +213,8 @@ public abstract class StoredProcedureParameter
/**
+ * Get the Modify Object instance
+ *
* @return The Modify Object instance
*/
public static StoredProcedureParameter instance()
@@ -214,7 +231,11 @@ public abstract class StoredProcedureParameter
{
private static Modify_MODIFICATION instance = new Modify_MODIFICATION( "$modification" );
-
+ /**
+ * A private constructor
+ *
+ * @param identifier The ProcedureStored name
+ */
private Modify_MODIFICATION( String identifier )
{
super( identifier );
@@ -222,6 +243,8 @@ public abstract class StoredProcedureParameter
/**
+ * Get the Modify Modification instance
+ *
* @return The Modify Modification instance
*/
public static StoredProcedureParameter instance()
@@ -238,7 +261,11 @@ public abstract class StoredProcedureParameter
{
private static Modify_OLD_ENTRY instance = new Modify_OLD_ENTRY( "$oldEntry" );
-
+ /**
+ * A private constructor
+ *
+ * @param identifier The ProcedureStored name
+ */
private Modify_OLD_ENTRY( String identifier )
{
super( identifier );
@@ -246,6 +273,8 @@ public abstract class StoredProcedureParameter
/**
+ * Get the Modify Old Entry instance
+ *
* @return The Modify Old Entry instance
*/
public static StoredProcedureParameter instance()
@@ -262,7 +291,11 @@ public abstract class StoredProcedureParameter
{
private static Modify_NEW_ENTRY instance = new Modify_NEW_ENTRY( "$newEntry" );
-
+ /**
+ * A private constructor
+ *
+ * @param identifier The ProcedureStored name
+ */
private Modify_NEW_ENTRY( String identifier )
{
super( identifier );
@@ -270,6 +303,8 @@ public abstract class StoredProcedureParameter
/**
+ * Get the Modify New Entry instance
+ *
* @return The Modify New Entry instance
*/
public static StoredProcedureParameter instance()
@@ -286,7 +321,11 @@ public abstract class StoredProcedureParameter
{
private static Add_ENTRY instance = new Add_ENTRY( "$entry" );
-
+ /**
+ * A private constructor
+ *
+ * @param identifier The ProcedureStored name
+ */
private Add_ENTRY( String identifier )
{
super( identifier );
@@ -294,6 +333,8 @@ public abstract class StoredProcedureParameter
/**
+ * Get the Add Entry instance
+ *
* @return The Add Entry instance
*/
public static StoredProcedureParameter instance()
@@ -310,7 +351,11 @@ public abstract class StoredProcedureParameter
{
private static Add_ATTRIBUTES instance = new Add_ATTRIBUTES( "$attributes" );
-
+ /**
+ * A private constructor
+ *
+ * @param identifier The ProcedureStored name
+ */
private Add_ATTRIBUTES( String identifier )
{
super( identifier );
@@ -318,6 +363,8 @@ public abstract class StoredProcedureParameter
/**
+ * Get the Add Attributes instance
+ *
* @return The Add Attributes instance
*/
public static StoredProcedureParameter instance()
@@ -334,7 +381,11 @@ public abstract class StoredProcedureParameter
{
private static Delete_NAME instance = new Delete_NAME( "$name" );
-
+ /**
+ * A private constructor
+ *
+ * @param identifier The ProcedureStored name
+ */
private Delete_NAME( String identifier )
{
super( identifier );
@@ -342,6 +393,8 @@ public abstract class StoredProcedureParameter
/**
+ * Get the Delete Name instance
+ *
* @return The Delete Name instance
*/
public static StoredProcedureParameter instance()
@@ -358,7 +411,11 @@ public abstract class StoredProcedureParameter
{
private static Delete_DELETED_ENTRY instance = new Delete_DELETED_ENTRY( "$deletedEntry" );
-
+ /**
+ * A private constructor
+ *
+ * @param identifier The ProcedureStored name
+ */
private Delete_DELETED_ENTRY( String identifier )
{
super( identifier );
@@ -366,6 +423,8 @@ public abstract class StoredProcedureParameter
/**
+ * Get the Delete Deleted instance
+ *
* @return The Delete Deleted instance
*/
public static StoredProcedureParameter instance()
@@ -382,7 +441,11 @@ public abstract class StoredProcedureParameter
{
private static ModifyDN_ENTRY instance = new ModifyDN_ENTRY( "$entry" );
-
+ /**
+ * A private constructor
+ *
+ * @param identifier The ProcedureStored name
+ */
private ModifyDN_ENTRY( String identifier )
{
super( identifier );
@@ -390,6 +453,8 @@ public abstract class StoredProcedureParameter
/**
+ * Get the Modify DN Entry instance
+ *
* @return The Modify DN Entry instance
*/
public static StoredProcedureParameter instance()
@@ -406,7 +471,11 @@ public abstract class StoredProcedureParameter
{
private static ModifyDN_NEW_RDN instance = new ModifyDN_NEW_RDN( "$newrdn" );
-
+ /**
+ * A private constructor
+ *
+ * @param identifier The ProcedureStored name
+ */
private ModifyDN_NEW_RDN( String identifier )
{
super( identifier );
@@ -414,6 +483,8 @@ public abstract class StoredProcedureParameter
/**
+ * Get the Modify New Rdn instance
+ *
* @return The Modify New Rdn instance
*/
public static StoredProcedureParameter instance()
@@ -430,7 +501,11 @@ public abstract class StoredProcedureParameter
{
private static ModifyDN_DELETE_OLD_RDN instance = new ModifyDN_DELETE_OLD_RDN( "$deleteoldrdn" );
-
+ /**
+ * A private constructor
+ *
+ * @param identifier The ProcedureStored name
+ */
private ModifyDN_DELETE_OLD_RDN( String identifier )
{
super( identifier );
@@ -438,6 +513,8 @@ public abstract class StoredProcedureParameter
/**
+ * Get the Modify DN Delete Old RDN instance
+ *
* @return The Modify DN Delete Old RDN instance
*/
public static StoredProcedureParameter instance()
@@ -454,7 +531,11 @@ public abstract class StoredProcedureParameter
{
private static ModifyDN_NEW_SUPERIOR instance = new ModifyDN_NEW_SUPERIOR( "$newSuperior" );
-
+ /**
+ * A private constructor
+ *
+ * @param identifier The ProcedureStored name
+ */
private ModifyDN_NEW_SUPERIOR( String identifier )
{
super( identifier );
@@ -462,6 +543,8 @@ public abstract class StoredProcedureParameter
/**
+ * Get the Modify DN New Superior instance
+ *
* @return The Modify DN New Superior instance
*/
public static StoredProcedureParameter instance()
@@ -478,7 +561,11 @@ public abstract class StoredProcedureParameter
{
private static ModifyDN_OLD_RDN instance = new ModifyDN_OLD_RDN( "$oldRDN" );
-
+ /**
+ * A private constructor
+ *
+ * @param identifier The ProcedureStored name
+ */
private ModifyDN_OLD_RDN( String identifier )
{
super( identifier );
@@ -486,6 +573,8 @@ public abstract class StoredProcedureParameter
/**
+ * Get the Modify DN Old RDN instance
+ *
* @return The Modify DN Old RDN instance
*/
public static StoredProcedureParameter instance()
@@ -502,7 +591,11 @@ public abstract class StoredProcedureParameter
{
private static ModifyDN_OLD_SUPERIOR_DN instance = new ModifyDN_OLD_SUPERIOR_DN( "$oldRDN" );
-
+ /**
+ * A private constructor
+ *
+ * @param identifier
+ */
private ModifyDN_OLD_SUPERIOR_DN( String identifier )
{
super( identifier );
@@ -510,6 +603,8 @@ public abstract class StoredProcedureParameter
/**
+ * Get the Modify DN Old Superior DN instance
+ *
* @return The Modify DN Old Superior DN instance
*/
public static StoredProcedureParameter instance()
@@ -526,7 +621,11 @@ public abstract class StoredProcedureParameter
{
private static ModifyDN_NEW_DN instance = new ModifyDN_NEW_DN( "$oldRDN" );
-
+ /**
+ * A private constructor
+ *
+ * @param identifier The ProcedureStored name
+ */
private ModifyDN_NEW_DN( String identifier )
{
super( identifier );
@@ -534,6 +633,8 @@ public abstract class StoredProcedureParameter
/**
+ * Get the Modify DN New DN instance
+ *
* @return The Modify DN New DN instance
*/
public static StoredProcedureParameter instance()
diff --git a/ldap/schema/data/src/main/java/org/apache/directory/api/ldap/schema/loader/EntityFactory.java b/ldap/schema/data/src/main/java/org/apache/directory/api/ldap/schema/loader/EntityFactory.java
index 453d1b520..28301e613 100644
--- a/ldap/schema/data/src/main/java/org/apache/directory/api/ldap/schema/loader/EntityFactory.java
+++ b/ldap/schema/data/src/main/java/org/apache/directory/api/ldap/schema/loader/EntityFactory.java
@@ -141,6 +141,7 @@ public interface EntityFactory
/**
+ * Retrieve and load an ObjectClass from the DIT
*
* @param schemaManager The Schema Manager
* @param entry The entry containing all the informations to build an ObjectClass
@@ -154,6 +155,7 @@ public interface EntityFactory
/**
+ * Retrieve and load an LdapSyntax from the DIT
*
* @param schemaManager The Schema Manager
* @param entry The entry containing all the informations to build a LdapSyntax
diff --git a/ldap/schema/data/src/main/java/org/apache/directory/api/ldap/schema/manager/impl/DefaultSchemaManager.java b/ldap/schema/data/src/main/java/org/apache/directory/api/ldap/schema/manager/impl/DefaultSchemaManager.java
index dbfc2a633..784cba767 100644
--- a/ldap/schema/data/src/main/java/org/apache/directory/api/ldap/schema/manager/impl/DefaultSchemaManager.java
+++ b/ldap/schema/data/src/main/java/org/apache/directory/api/ldap/schema/manager/impl/DefaultSchemaManager.java
@@ -280,6 +280,13 @@ public class DefaultSchemaManager implements SchemaManager
}
+ /**
+ * Add all schema's SchemaObject into the registries
+ *
+ * @param schema The schema to inject
+ * @param registries The registries that will be updated
+ * @throws LdapException If the injection failed
+ */
protected void addSchemaObjects( Schema schema, Registries registries ) throws LdapException
{
// Create a content container for this schema
@@ -2485,13 +2492,22 @@ public class DefaultSchemaManager implements SchemaManager
isRelaxed = STRICT;
}
-
+ /**
+ * Get the Errors' handler
+ *
+ * @return The Errors' handler
+ */
public SchemaErrorHandler getErrorHandler()
{
return errorHandler;
}
+ /**
+ * Set the Errors' handler
+ *
+ * @param errorHandler The Errors' handler to set
+ */
public void setErrorHandler( SchemaErrorHandler errorHandler )
{
this.errorHandler = errorHandler;
diff --git a/pom.xml b/pom.xml
index aaa72541c..0becbe65b 100644
--- a/pom.xml
+++ b/pom.xml
@@ -353,9 +353,15 @@
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<configuration>
- <show>private</show>
+ <!--show>private</show-->
<nohelp>true</nohelp>
<!--doclint>none</doclint-->
+ <additionalJOptions>
+ <additionalJOption>-Xmaxerrs</additionalJOption>
+ <additionalJOption>65536</additionalJOption>
+ <additionalJOption>-Xmaxwarns</additionalJOption>
+ <additionalJOption>65536</additionalJOption>
+ </additionalJOptions>
</configuration>
</plugin>
(directory-ldap-api) 03/06: Fixed the schema converter javadoc warnings
Posted by el...@apache.org.
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
commit dfd1546e8ac92a5abd75a040eae6b018feca9f8f
Author: emmanuel lecharny <el...@apache.org>
AuthorDate: Thu Feb 6 06:23:31 2025 +0100
Fixed the schema converter javadoc warnings
---
.../apache/directory/api/ldap/util/tree/DnNode.java | 2 ++
ldap/schema/converter/pom.xml | 10 ++++++++++
ldap/schema/converter/src/main/antlr/schemaConverter.g | 6 +++---
.../api/ldap/schema/converter/ObjectClassHolder.java | 11 +++++++++++
.../directory/api/ldap/schema/converter/Schema.java | 18 +++++++++++++++++-
.../api/ldap/schema/converter/SchemaElement.java | 14 ++++++++++++++
.../api/ldap/schema/converter/SchemaElementImpl.java | 8 ++++++++
.../api/ldap/schema/converter/SchemaParser.java | 6 +++---
8 files changed, 68 insertions(+), 7 deletions(-)
diff --git a/ldap/extras/util/src/main/java/org/apache/directory/api/ldap/util/tree/DnNode.java b/ldap/extras/util/src/main/java/org/apache/directory/api/ldap/util/tree/DnNode.java
index 7ccc66407..4cf8b7336 100644
--- a/ldap/extras/util/src/main/java/org/apache/directory/api/ldap/util/tree/DnNode.java
+++ b/ldap/extras/util/src/main/java/org/apache/directory/api/ldap/util/tree/DnNode.java
@@ -1073,6 +1073,8 @@ public class DnNode<N>
/**
+ * Get the Dn
+ *
* @return the dn
*/
public synchronized Dn getDn()
diff --git a/ldap/schema/converter/pom.xml b/ldap/schema/converter/pom.xml
index aa0e4ecad..62fbf842b 100644
--- a/ldap/schema/converter/pom.xml
+++ b/ldap/schema/converter/pom.xml
@@ -69,6 +69,16 @@
<build>
<plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <configuration>
+ <sourceFileExcludes>
+ <sourceFileExclude>**/Antlr*</sourceFileExclude>
+ </sourceFileExcludes>
+ </configuration>
+ </plugin>
+
<plugin>
<artifactId>maven-antrun-plugin</artifactId>
<executions>
diff --git a/ldap/schema/converter/src/main/antlr/schemaConverter.g b/ldap/schema/converter/src/main/antlr/schemaConverter.g
index 679e3a096..44347d4c9 100644
--- a/ldap/schema/converter/src/main/antlr/schemaConverter.g
+++ b/ldap/schema/converter/src/main/antlr/schemaConverter.g
@@ -45,11 +45,11 @@ import org.apache.directory.api.ldap.model.schema.ObjectClassTypeEnum;
}
-class antlrSchemaConverterLexer extends Lexer ;
+class AntlrSchemaConverterLexer extends Lexer ;
options {
k = 7 ;
- exportVocab=antlrSchema ;
+ exportVocab=AntlrSchema ;
charVocabulary = '\3'..'\377' ;
caseSensitive = false ;
defaultErrorHandler = false ;
@@ -109,7 +109,7 @@ SYNTAX
"syntax" WS NUMERICOID ( OPEN_BRACKET ( DIGIT )+ CLOSE_BRACKET )?
;
-class antlrSchemaConverterParser extends Parser ;
+class AntlrSchemaConverterParser extends Parser ;
options {
k = 5 ;
diff --git a/ldap/schema/converter/src/main/java/org/apache/directory/api/ldap/schema/converter/ObjectClassHolder.java b/ldap/schema/converter/src/main/java/org/apache/directory/api/ldap/schema/converter/ObjectClassHolder.java
index d4357d2cc..b7d9637d2 100755
--- a/ldap/schema/converter/src/main/java/org/apache/directory/api/ldap/schema/converter/ObjectClassHolder.java
+++ b/ldap/schema/converter/src/main/java/org/apache/directory/api/ldap/schema/converter/ObjectClassHolder.java
@@ -66,6 +66,7 @@ public class ObjectClassHolder extends SchemaElementImpl
/**
* Get the list of superior for this objectClass
+ *
* @return A list of all inherited objectClasses
*/
public List<String> getSuperiors()
@@ -76,6 +77,7 @@ public class ObjectClassHolder extends SchemaElementImpl
/**
* Set the list of inherited objectClasses
+ *
* @param superiors The list of inherited objectClasses
*/
public void setSuperiors( List<String> superiors )
@@ -85,6 +87,8 @@ public class ObjectClassHolder extends SchemaElementImpl
/**
+ * Get the list of ObjectClass MUST attributes
+ *
* @return The list of mandatory attributes
*/
public List<String> getMust()
@@ -95,6 +99,7 @@ public class ObjectClassHolder extends SchemaElementImpl
/**
* Set the list of mandatory attributes
+ *
* @param must The list of mandatory attributes
*/
public void setMust( List<String> must )
@@ -104,6 +109,8 @@ public class ObjectClassHolder extends SchemaElementImpl
/**
+ * Get the list of optional attributes
+ *
* @return The list of optional attributes
*/
public List<String> getMay()
@@ -114,6 +121,7 @@ public class ObjectClassHolder extends SchemaElementImpl
/**
* Set the list of optional attributes
+ *
* @param may The list of optional attributes
*/
public void setMay( List<String> may )
@@ -123,6 +131,8 @@ public class ObjectClassHolder extends SchemaElementImpl
/**
+ * Get th eObjectClass type
+ *
* @return The objectClass type
*/
public ObjectClassTypeEnum getClassType()
@@ -133,6 +143,7 @@ public class ObjectClassHolder extends SchemaElementImpl
/**
* Set the objectClass type.
+ *
* @param classType The objectClass type.
*/
public void setClassType( ObjectClassTypeEnum classType )
diff --git a/ldap/schema/converter/src/main/java/org/apache/directory/api/ldap/schema/converter/Schema.java b/ldap/schema/converter/src/main/java/org/apache/directory/api/ldap/schema/converter/Schema.java
index 9c19a7d09..f1219eccf 100644
--- a/ldap/schema/converter/src/main/java/org/apache/directory/api/ldap/schema/converter/Schema.java
+++ b/ldap/schema/converter/src/main/java/org/apache/directory/api/ldap/schema/converter/Schema.java
@@ -42,7 +42,15 @@ public class Schema
/** The writer where we dump the ldif lines */
private Writer out;
-
+ /**
+ * Default construtor
+ */
+ public Schema()
+ {
+ // Nothing to do
+ }
+
+
/**
* Set the schema name to parse. This name is the prefix of the
* schema file, which postfix is '.schema'.
@@ -58,6 +66,8 @@ public class Schema
/**
+ * Get the schema name
+ *
* @return The schema name.
*/
public String getName()
@@ -68,6 +78,7 @@ public class Schema
/**
* Set the inputStream mapped on the schema file
+ *
* @param in The InputStream mapped on the schema file
*/
public void setInput( InputStream in )
@@ -77,6 +88,8 @@ public class Schema
/**
+ * Get the inputSteam mapped on the schema file
+ *
* @return The InputStream mapped on the schema file
*/
public InputStream getInput()
@@ -86,6 +99,8 @@ public class Schema
/**
+ * Get the writer in which the ldif lines will be dumped
+ *
* @return The writer in which the ldif lines will be dumped
*/
public Writer getOutput()
@@ -96,6 +111,7 @@ public class Schema
/**
* Set a writer to dump the ldif files
+ *
* @param out The writer
*/
public void setOutput( Writer out )
diff --git a/ldap/schema/converter/src/main/java/org/apache/directory/api/ldap/schema/converter/SchemaElement.java b/ldap/schema/converter/src/main/java/org/apache/directory/api/ldap/schema/converter/SchemaElement.java
index 6ed70d1fc..7bf1a5849 100644
--- a/ldap/schema/converter/src/main/java/org/apache/directory/api/ldap/schema/converter/SchemaElement.java
+++ b/ldap/schema/converter/src/main/java/org/apache/directory/api/ldap/schema/converter/SchemaElement.java
@@ -51,12 +51,16 @@ public interface SchemaElement
/**
+ * Get the Schema Element OID
+ *
* @return the schema element's OID
*/
String getOid();
/**
+ * Get the dschema element description
+ *
* @return Return the schema element description
*/
String getDescription();
@@ -64,12 +68,15 @@ public interface SchemaElement
/**
* Set the schema element's description
+ *
* @param description The schema element's description
*/
void setDescription( String description );
/**
+ * Get the list of possible names
+ *
* @return The list of names for the schemaElement
*/
List<String> getNames();
@@ -77,18 +84,23 @@ public interface SchemaElement
/**
* Set a list of names for a schemaElement
+ *
* @param names The list of names of this schemaElement
*/
void setNames( List<String> names );
/**
+ * Get the list of extensions
+ *
* @return The list of extensions for the schemaElement
*/
Map<String, List<String>> getExtensions();
/**
+ * Get the extension associated to a key
+ *
* @param key the Extension key
* @return The list of a values for a given extension
*/
@@ -97,6 +109,7 @@ public interface SchemaElement
/**
* Set a list of extensions for a schemaElement
+ *
* @param extensions The list of extensions of this schemaElement
*/
void setExtensions( Map<String, List<String>> extensions );
@@ -105,6 +118,7 @@ public interface SchemaElement
/**
* Generate a String representation of this schemaElement, formated
* as a ldif string
+ *
* @param schemaName The schema from which is extracted this schemaElement
* @return A string representing the schemaElement as a Ldif formated String
* @throws org.apache.directory.api.ldap.model.exception.LdapException If any error occurs.
diff --git a/ldap/schema/converter/src/main/java/org/apache/directory/api/ldap/schema/converter/SchemaElementImpl.java b/ldap/schema/converter/src/main/java/org/apache/directory/api/ldap/schema/converter/SchemaElementImpl.java
index be745386d..4f860e20a 100644
--- a/ldap/schema/converter/src/main/java/org/apache/directory/api/ldap/schema/converter/SchemaElementImpl.java
+++ b/ldap/schema/converter/src/main/java/org/apache/directory/api/ldap/schema/converter/SchemaElementImpl.java
@@ -58,6 +58,14 @@ public abstract class SchemaElementImpl implements SchemaElement
/** The optional list of extensions */
protected Map<String, List<String>> extensions = new HashMap<>();
+ /**
+ * Default constructor
+ */
+ public SchemaElementImpl()
+ {
+ // Nothing to do
+ }
+
/**
* {@inheritDoc}
diff --git a/ldap/schema/converter/src/main/java/org/apache/directory/api/ldap/schema/converter/SchemaParser.java b/ldap/schema/converter/src/main/java/org/apache/directory/api/ldap/schema/converter/SchemaParser.java
index af259f418..5e149cd34 100755
--- a/ldap/schema/converter/src/main/java/org/apache/directory/api/ldap/schema/converter/SchemaParser.java
+++ b/ldap/schema/converter/src/main/java/org/apache/directory/api/ldap/schema/converter/SchemaParser.java
@@ -47,7 +47,7 @@ import antlr.TokenStreamException;
public class SchemaParser
{
/** The antlr generated parser */
- private antlrSchemaConverterParser parser = null;
+ private AntlrSchemaConverterParser parser = null;
/** A pipe into the parser */
private PipedOutputStream parserIn = null;
@@ -83,8 +83,8 @@ public class SchemaParser
parserIn = new PipedOutputStream();
PipedInputStream in = new PipedInputStream();
parserIn.connect( in );
- antlrSchemaConverterLexer lexer = new antlrSchemaConverterLexer( in );
- parser = new antlrSchemaConverterParser( lexer );
+ AntlrSchemaConverterLexer lexer = new AntlrSchemaConverterLexer( in );
+ parser = new AntlrSchemaConverterParser( lexer );
}