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 2018/08/12 22:08:43 UTC
[directory-server] branch master updated: Fixed server-config
javadoc errors and warnings
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-server.git
The following commit(s) were added to refs/heads/master by this push:
new b8d4d87 Fixed server-config javadoc errors and warnings
b8d4d87 is described below
commit b8d4d8780537dbeaf5ed2a0df55479c40fab212a
Author: Emmanuel Lécharny <el...@symas.com>
AuthorDate: Mon Aug 13 00:08:38 2018 +0200
Fixed server-config javadoc errors and warnings
---
.../server/config/ConfigPartitionInitializer.java | 2 +-
.../server/config/ConfigPartitionReader.java | 22 ++++++++++++++--------
.../server/config/ConfigurationElement.java | 2 ++
.../server/config/LdifConfigExtractor.java | 2 ++
.../directory/server/config/beans/AdsBaseBean.java | 20 ++++++++++++++++++++
.../server/config/beans/ChangeLogBean.java | 2 +-
.../directory/server/config/beans/ConfigBean.java | 2 +-
.../server/config/beans/DirectoryServiceBean.java | 2 +-
.../server/config/beans/JdbmIndexBean.java | 2 +-
.../server/config/beans/PartitionBean.java | 2 +-
.../server/config/beans/ReplConsumerBean.java | 2 +-
.../server/config/beans/SaslMechHandlerBean.java | 4 ++--
.../server/config/beans/TransportBean.java | 4 ++--
13 files changed, 49 insertions(+), 19 deletions(-)
diff --git a/server-config/src/main/java/org/apache/directory/server/config/ConfigPartitionInitializer.java b/server-config/src/main/java/org/apache/directory/server/config/ConfigPartitionInitializer.java
index b1beced..9299f1a 100644
--- a/server-config/src/main/java/org/apache/directory/server/config/ConfigPartitionInitializer.java
+++ b/server-config/src/main/java/org/apache/directory/server/config/ConfigPartitionInitializer.java
@@ -85,7 +85,7 @@ public class ConfigPartitionInitializer
* to new multi-file LDIF partition.
*
* @return the initialized configuration partition
- * @throws Exception
+ * @throws Exception If we can't initialize the configuration partition
*/
public LdifPartition initConfigPartition() throws Exception
{
diff --git a/server-config/src/main/java/org/apache/directory/server/config/ConfigPartitionReader.java b/server-config/src/main/java/org/apache/directory/server/config/ConfigPartitionReader.java
index 94284a6..eea08dd 100644
--- a/server-config/src/main/java/org/apache/directory/server/config/ConfigPartitionReader.java
+++ b/server-config/src/main/java/org/apache/directory/server/config/ConfigPartitionReader.java
@@ -502,7 +502,13 @@ public class ConfigPartitionReader
/**
* Read some configuration element from the DIT using its name
- * @throws LdapInvalidAttributeValueException
+ *
+ * @param baseDn The base Dn in the DIT where the configuration is stored
+ * @param name The element to read
+ * @param scope The search scope
+ * @param mandatory If the element is mandatory or not
+ * @return The list of beans read
+ * @throws ConfigurationException If the configuration cannot be read
*/
public List<AdsBaseBean> read( Dn baseDn, String name, SearchScope scope, boolean mandatory )
throws ConfigurationException
@@ -615,9 +621,9 @@ public class ConfigPartitionReader
/**
* Creates a configuration bean from the given entry.
*
- * @param entry any configuration entry of thetype "ads-base"
- * @return
- * @throws Exception
+ * @param entry any configuration entry of the type "ads-base"
+ * @return The ApacheDS base configuration
+ * @throws Exception If the configuration cannot be read
*/
public AdsBaseBean readConfig( Entry entry ) throws Exception
{
@@ -750,7 +756,7 @@ public class ConfigPartitionReader
/**
* Read the configuration from the DIT, returning a bean containing all of it.
*
- * @param base The base Dn in the DIT where the configuration is stored
+ * @param baseDn The base Dn in the DIT where the configuration is stored
* @return The Config bean, containing the whole configuration
* @throws ConfigurationException If we had some issue reading the configuration
*/
@@ -764,7 +770,7 @@ public class ConfigPartitionReader
/**
* Read the configuration from the DIT, returning a bean containing all of it.
*
- * @param base The base Dn in the DIT where the configuration is stored
+ * @param baseDn The base Dn in the DIT where the configuration is stored
* @return The Config bean, containing the whole configuration
* @throws ConfigurationException If we had some issue reading the configuration
*/
@@ -781,7 +787,7 @@ public class ConfigPartitionReader
* @param baseDn The base Dn in the DIT where the configuration is stored
* @param objectClass The element to read from the DIT
* @return The bean containing the configuration for the required element
- * @throws ConfigurationException
+ * @throws ConfigurationException If the configuration cannot be read
*/
public ConfigBean readConfig( String baseDn, String objectClass ) throws LdapException
{
@@ -795,7 +801,7 @@ public class ConfigPartitionReader
* @param baseDn The base Dn in the DIT where the configuration is stored
* @param objectClass The element to read from the DIT
* @return The bean containing the configuration for the required element
- * @throws ConfigurationException
+ * @throws ConfigurationException If the configuration cannot be read
*/
public ConfigBean readConfig( Dn baseDn, String objectClass ) throws ConfigurationException
{
diff --git a/server-config/src/main/java/org/apache/directory/server/config/ConfigurationElement.java b/server-config/src/main/java/org/apache/directory/server/config/ConfigurationElement.java
index b248ca0..d47398e 100644
--- a/server-config/src/main/java/org/apache/directory/server/config/ConfigurationElement.java
+++ b/server-config/src/main/java/org/apache/directory/server/config/ConfigurationElement.java
@@ -93,6 +93,8 @@ public @interface ConfigurationElement
/**
* Returns the list of string values that are the
* default values when the element is multi-valued.
+ *
+ * @return The default values
*/
String[] defaultValues() default {};
}
diff --git a/server-config/src/main/java/org/apache/directory/server/config/LdifConfigExtractor.java b/server-config/src/main/java/org/apache/directory/server/config/LdifConfigExtractor.java
index 09dcc6a..d825e13 100644
--- a/server-config/src/main/java/org/apache/directory/server/config/LdifConfigExtractor.java
+++ b/server-config/src/main/java/org/apache/directory/server/config/LdifConfigExtractor.java
@@ -74,6 +74,7 @@ public final class LdifConfigExtractor
/**
* Extracts the LDIF files from a Jar file or copies exploded LDIF resources.
*
+ * @param outputDirectory The directory where to extract the configuration
* @param overwrite over write extracted structure if true, false otherwise
* @throws IOException if schema already extracted and on IO errors
*/
@@ -268,6 +269,7 @@ public final class LdifConfigExtractor
* extracts or overwrites the configuration LDIF file and returns the absolute path of this file
*
* @param configDir the directory where the config file should be extracted to
+ * @param file The file containing the configuration
* @param overwrite flag to indicate to overwrite the config file if already present in the given config directory
* @return complete path of the config file on disk
*/
diff --git a/server-config/src/main/java/org/apache/directory/server/config/beans/AdsBaseBean.java b/server-config/src/main/java/org/apache/directory/server/config/beans/AdsBaseBean.java
index e9a0097..4bc28e5 100644
--- a/server-config/src/main/java/org/apache/directory/server/config/beans/AdsBaseBean.java
+++ b/server-config/src/main/java/org/apache/directory/server/config/beans/AdsBaseBean.java
@@ -101,6 +101,11 @@ public abstract class AdsBaseBean
/**
* Formated print of a boolean
+ *
+ * @param tabs The starting spaces
+ * @param name The bean name
+ * @param value the boolean value
+ * @return A string for this boolean
*/
protected String toString( String tabs, String name, boolean value )
{
@@ -125,6 +130,11 @@ public abstract class AdsBaseBean
/**
* Formated print of a String that can be null
+ *
+ * @param tabs The starting spaces
+ * @param name The bean name
+ * @param value the string value
+ * @return A string for this String
*/
protected String toString( String tabs, String name, String value )
{
@@ -141,6 +151,11 @@ public abstract class AdsBaseBean
/**
* Formated print of a Dn that can be null
+ *
+ * @param tabs The starting spaces
+ * @param name The bean name
+ * @param value the Dn value
+ * @return A string for this Dn
*/
protected String toString( String tabs, String name, Dn value )
{
@@ -168,6 +183,11 @@ public abstract class AdsBaseBean
/**
* Formated print of a long
+ *
+ * @param tabs The starting spaces
+ * @param name The bean name
+ * @param value the long value
+ * @return A string for this long
*/
protected String toString( String tabs, String name, long value )
{
diff --git a/server-config/src/main/java/org/apache/directory/server/config/beans/ChangeLogBean.java b/server-config/src/main/java/org/apache/directory/server/config/beans/ChangeLogBean.java
index 300ff74..9a3553a 100644
--- a/server-config/src/main/java/org/apache/directory/server/config/beans/ChangeLogBean.java
+++ b/server-config/src/main/java/org/apache/directory/server/config/beans/ChangeLogBean.java
@@ -80,7 +80,7 @@ public class ChangeLogBean extends AdsBaseBean
/**
- * @param exposed Set the exposed flag
+ * @param changeLogExposed Set the exposed flag
*/
public void setChangeLogExposed( boolean changeLogExposed )
{
diff --git a/server-config/src/main/java/org/apache/directory/server/config/beans/ConfigBean.java b/server-config/src/main/java/org/apache/directory/server/config/beans/ConfigBean.java
index 6668074..dd756d7 100644
--- a/server-config/src/main/java/org/apache/directory/server/config/beans/ConfigBean.java
+++ b/server-config/src/main/java/org/apache/directory/server/config/beans/ConfigBean.java
@@ -88,7 +88,7 @@ public class ConfigBean
/**
- * @param The DirectoryService ID we want to get
+ * @param directoryServiceId The DirectoryService ID we want to get
* @return the found directoryServiceBean
*/
public DirectoryServiceBean getDirectoryServiceBean( String directoryServiceId )
diff --git a/server-config/src/main/java/org/apache/directory/server/config/beans/DirectoryServiceBean.java b/server-config/src/main/java/org/apache/directory/server/config/beans/DirectoryServiceBean.java
index eaf895d..090f87f 100644
--- a/server-config/src/main/java/org/apache/directory/server/config/beans/DirectoryServiceBean.java
+++ b/server-config/src/main/java/org/apache/directory/server/config/beans/DirectoryServiceBean.java
@@ -293,7 +293,7 @@ public class DirectoryServiceBean extends AdsBaseBean
/**
- * @param cChangeLog the ChangeLog to set
+ * @param changeLog the ChangeLog to set
*/
public void setChangeLog( ChangeLogBean changeLog )
{
diff --git a/server-config/src/main/java/org/apache/directory/server/config/beans/JdbmIndexBean.java b/server-config/src/main/java/org/apache/directory/server/config/beans/JdbmIndexBean.java
index 8964f11..c0908d0 100644
--- a/server-config/src/main/java/org/apache/directory/server/config/beans/JdbmIndexBean.java
+++ b/server-config/src/main/java/org/apache/directory/server/config/beans/JdbmIndexBean.java
@@ -75,7 +75,7 @@ public class JdbmIndexBean extends IndexBean
/**
* Sets the size of the index cache in terms of the number of index entries to be cached.
*
- * @param IndexCacheSize the size of the index cache
+ * @param indexCacheSize the size of the index cache
*/
public void setIndexCacheSize( int indexCacheSize )
{
diff --git a/server-config/src/main/java/org/apache/directory/server/config/beans/PartitionBean.java b/server-config/src/main/java/org/apache/directory/server/config/beans/PartitionBean.java
index d7488f5..b89f6ac 100644
--- a/server-config/src/main/java/org/apache/directory/server/config/beans/PartitionBean.java
+++ b/server-config/src/main/java/org/apache/directory/server/config/beans/PartitionBean.java
@@ -127,7 +127,7 @@ public abstract class PartitionBean extends AdsBaseBean
/**
- * @param partitions the indexes to set
+ * @param indexes the indexes to set
*/
public void setIndexes( List<IndexBean> indexes )
{
diff --git a/server-config/src/main/java/org/apache/directory/server/config/beans/ReplConsumerBean.java b/server-config/src/main/java/org/apache/directory/server/config/beans/ReplConsumerBean.java
index 10828d8..5167019 100644
--- a/server-config/src/main/java/org/apache/directory/server/config/beans/ReplConsumerBean.java
+++ b/server-config/src/main/java/org/apache/directory/server/config/beans/ReplConsumerBean.java
@@ -147,7 +147,7 @@ public class ReplConsumerBean extends AdsBaseBean
/**
- * @param searchBaseDN the searchBaseDn to set
+ * @param searchBaseDn the searchBaseDn to set
*/
public void setSearchBaseDn( String searchBaseDn )
{
diff --git a/server-config/src/main/java/org/apache/directory/server/config/beans/SaslMechHandlerBean.java b/server-config/src/main/java/org/apache/directory/server/config/beans/SaslMechHandlerBean.java
index 26bbcfa..d615ffd 100644
--- a/server-config/src/main/java/org/apache/directory/server/config/beans/SaslMechHandlerBean.java
+++ b/server-config/src/main/java/org/apache/directory/server/config/beans/SaslMechHandlerBean.java
@@ -80,7 +80,7 @@ public class SaslMechHandlerBean extends AdsBaseBean
/**
- * @param SaslMechClassName the SaslMechClassName to set
+ * @param saslMechClassName the SaslMechClassName to set
*/
public void setSaslMechClassName( String saslMechClassName )
{
@@ -98,7 +98,7 @@ public class SaslMechHandlerBean extends AdsBaseBean
/**
- * @param NtlmMechProvider the NtlmMechProvider to set
+ * @param ntlmMechProvider the NtlmMechProvider to set
*/
public void setNtlmMechProvider( String ntlmMechProvider )
{
diff --git a/server-config/src/main/java/org/apache/directory/server/config/beans/TransportBean.java b/server-config/src/main/java/org/apache/directory/server/config/beans/TransportBean.java
index 5f818a0..6d53849 100644
--- a/server-config/src/main/java/org/apache/directory/server/config/beans/TransportBean.java
+++ b/server-config/src/main/java/org/apache/directory/server/config/beans/TransportBean.java
@@ -157,7 +157,7 @@ public class TransportBean extends AdsBaseBean
/**
* Sets the number of thread to use to process incoming requests
*
- * @param The number of threads
+ * @param transportNbThreads The number of threads
*/
public void setTransportNbThreads( int transportNbThreads )
{
@@ -177,7 +177,7 @@ public class TransportBean extends AdsBaseBean
/**
* Sets the size of the incoming requests waiting queue
*
- * @param The size of waiting request queue
+ * @param transportBacklog The size of waiting request queue
*/
public void setTransportBackLog( int transportBacklog )
{