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 2014/12/31 09:58:40 UTC
svn commit: r1648664 - in /directory/apacheds/trunk:
core-api/src/main/java/org/apache/directory/server/core/api/
service/src/main/java/org/apache/directory/server/
Author: elecharny
Date: Wed Dec 31 08:58:40 2014
New Revision: 1648664
URL: http://svn.apache.org/r1648664
Log:
Added some missing Javadoc, and clarified the existing one.
Modified:
directory/apacheds/trunk/core-api/src/main/java/org/apache/directory/server/core/api/AbstractLayout.java
directory/apacheds/trunk/core-api/src/main/java/org/apache/directory/server/core/api/InstanceLayout.java
directory/apacheds/trunk/service/src/main/java/org/apache/directory/server/InstallationLayout.java
Modified: directory/apacheds/trunk/core-api/src/main/java/org/apache/directory/server/core/api/AbstractLayout.java
URL: http://svn.apache.org/viewvc/directory/apacheds/trunk/core-api/src/main/java/org/apache/directory/server/core/api/AbstractLayout.java?rev=1648664&r1=1648663&r2=1648664&view=diff
==============================================================================
--- directory/apacheds/trunk/core-api/src/main/java/org/apache/directory/server/core/api/AbstractLayout.java (original)
+++ directory/apacheds/trunk/core-api/src/main/java/org/apache/directory/server/core/api/AbstractLayout.java Wed Dec 31 08:58:40 2014
@@ -45,15 +45,14 @@ public abstract class AbstractLayout
/** The required files */
private File[] requiredFiles = new File[0];
- /** The directory */
+ /** The base directory */
private File directory;
/**
* Creates a new instance of AbstractLayout.
*
- * @param directory
- * the directory
+ * @param directory the base directory
*/
protected AbstractLayout( File directory )
{
@@ -64,8 +63,7 @@ public abstract class AbstractLayout
/**
* Creates a new instance of AbstractLayout.
*
- * @param directoryPath
- * the path to the directory
+ * @param directoryPath the path to the base directory
*/
protected AbstractLayout( String directoryPath )
{
@@ -74,10 +72,9 @@ public abstract class AbstractLayout
/**
- * Gets the installation directory.
+ * Gets the base directory.
*
- * @return
- * the installation directory
+ * @return the base directory
*/
protected File getDirectory()
{
@@ -88,8 +85,7 @@ public abstract class AbstractLayout
/**
* Gets the required directories.
*
- * @return
- * the required directories
+ * @return the required directories
*/
public File[] getRequiredDirectories()
{
@@ -100,8 +96,7 @@ public abstract class AbstractLayout
/**
* Gets the required files.
*
- * @return
- * the required files
+ * @return the required files
*/
public File[] getRequiredFiles()
{
@@ -130,8 +125,7 @@ public abstract class AbstractLayout
/**
* Sets the required directories.
*
- * @param requiredDirectories
- * an array of required directories
+ * @param requiredDirectories an array of required directories
*/
protected void setRequiredDirectories( File[] requiredDirectories )
{
@@ -142,8 +136,7 @@ public abstract class AbstractLayout
/**
* Sets the required files.
*
- * @param requiredFiles
- * an array of required files
+ * @param requiredFiles an array of required files
*/
protected void setRequiredFiles( File[] requiredFiles )
{
Modified: directory/apacheds/trunk/core-api/src/main/java/org/apache/directory/server/core/api/InstanceLayout.java
URL: http://svn.apache.org/viewvc/directory/apacheds/trunk/core-api/src/main/java/org/apache/directory/server/core/api/InstanceLayout.java?rev=1648664&r1=1648663&r2=1648664&view=diff
==============================================================================
--- directory/apacheds/trunk/core-api/src/main/java/org/apache/directory/server/core/api/InstanceLayout.java (original)
+++ directory/apacheds/trunk/core-api/src/main/java/org/apache/directory/server/core/api/InstanceLayout.java Wed Dec 31 08:58:40 2014
@@ -87,7 +87,7 @@ public class InstanceLayout extends Abst
private static final String PARTITIONS_NAME = "partitions";
private static final String REPL_NAME = "syncrepl-data";
private static final String CACHE_NAME = "cache";
-
+
/** Static file names */
private static final String LOG4J_PROPERTIES = "log4j.properties";
private static final String WRAPPER_CONF = "wrapper.conf";
@@ -111,6 +111,7 @@ public class InstanceLayout extends Abst
/** The cache directory */
private File cacheDir;
+
/**
* Creates a new instance of InstanceLayout.
*
@@ -149,8 +150,8 @@ public class InstanceLayout extends Abst
getPartitionsDirectory(),
getRunDirectory(),
getCacheDirectory()
- };
-
+ };
+
setRequiredDirectories( requiredDirectories );
// The required files
@@ -159,14 +160,14 @@ public class InstanceLayout extends Abst
getWrapperConfigurationFile(),
getLogConfigurationFile() /*,
getApacheDsConfigurationLdifFile() */// TODO re-activate this when possible.
- };
-
+ };
+
setRequiredFiles( requiredFiles );
}
/**
- * Gets the 'conf' directory.
+ * Gets the 'conf' directory ('<instance>/conf').
*
* @return the 'conf' directory
*/
@@ -189,10 +190,9 @@ public class InstanceLayout extends Abst
this.confDir = confDir;
}
-
-
+
/**
- * Gets the 'cache' directory.
+ * Gets the 'cache' directory ('<instance>/cache').
*
* @return the 'cache' directory
*/
@@ -202,11 +202,11 @@ public class InstanceLayout extends Abst
{
cacheDir = new File( getInstanceDirectory(), CACHE_NAME );
}
-
+
return cacheDir;
}
-
-
+
+
/**
* @param cacheDir the confDir to set
*/
@@ -215,8 +215,9 @@ public class InstanceLayout extends Abst
this.cacheDir = cacheDir;
}
+
/**
- * Gets the 'log' directory.
+ * Gets the 'log' directory ('<instance>/log').
*
* @return the 'log' directory
*/
@@ -250,7 +251,7 @@ public class InstanceLayout extends Abst
/**
- * Gets the 'partitions' directory.
+ * Gets the 'partitions' directory ('<instance>/partitions')
*
* @return the 'partitions' directory
*/
@@ -275,7 +276,7 @@ public class InstanceLayout extends Abst
/**
- * Gets the 'run' directory in the installation directory.
+ * Gets the 'run' directory in the installation directory ('<instance>/run').
*
* @return the 'run' directory
*/
@@ -320,7 +321,7 @@ public class InstanceLayout extends Abst
/**
- * Gets the log configuration file (<em>'/conf/log4j.properties'</em>).
+ * Gets the log configuration file (<em>'<instance>/conf/log4j.properties'</em>).
*
* @return the log configuration file
*/
@@ -331,7 +332,7 @@ public class InstanceLayout extends Abst
/**
- * Gets the wrapper configuration file (<em>'/conf/wrapper.conf'</em>).
+ * Gets the wrapper configuration file (<em>'<instance>/conf/wrapper.conf'</em>).
*
* @return the wrapper configuration file
*/
@@ -342,7 +343,7 @@ public class InstanceLayout extends Abst
/**
- * Gets the apacheds configuration ldif file (<em>'/conf/wrapper.conf'</em>).
+ * Gets the apacheds configuration ldif file (<em>'<instance>/conf/config.ldif'</em>).
*
* @return the apacheds configuration ldif file
*/
@@ -353,7 +354,8 @@ public class InstanceLayout extends Abst
/**
- * Gets the 'replication' directory where replication journals are stored.
+ * Gets the 'replication' directory where replication journals are stored
+ * (<em>'<instance>/syncrepl-data'</em>).
*
* @return the 'replication' directory
*/
@@ -369,6 +371,8 @@ public class InstanceLayout extends Abst
/**
+ * Sets the directory where the replication data are stored
+ *
* @param replDir the replication journal data directory
*/
public void setReplDirectory( File replDir )
@@ -377,6 +381,9 @@ public class InstanceLayout extends Abst
}
+ /**
+ * @see String#toString()
+ */
public String toString()
{
return "Instance Layout: \n" +
Modified: directory/apacheds/trunk/service/src/main/java/org/apache/directory/server/InstallationLayout.java
URL: http://svn.apache.org/viewvc/directory/apacheds/trunk/service/src/main/java/org/apache/directory/server/InstallationLayout.java?rev=1648664&r1=1648663&r2=1648664&view=diff
==============================================================================
--- directory/apacheds/trunk/service/src/main/java/org/apache/directory/server/InstallationLayout.java (original)
+++ directory/apacheds/trunk/service/src/main/java/org/apache/directory/server/InstallationLayout.java Wed Dec 31 08:58:40 2014
@@ -28,7 +28,26 @@ import org.apache.directory.server.core.
/**
* Convenience class to encapsulate paths to various directories and files within
- * an installation.
+ * an installation. The default installation layout will be :
+ * <pre>
+ * apacheds-<version>/ : installation directory
+ * |
+ * +-- bin : binDirectory
+ * | |
+ * | +-- apacheds* : scriptFile
+ * | |
+ * | +-- wrapper* : wrapperFile
+ * |
+ * +-- conf/ : confDirectory
+ * | |
+ * | +-- wrapper.conf : wrapperConfFile
+ * |
+ * +-- lib/ : LibDirectory
+ * |
+ * +-- LICENSE
+ * |
+ * +-- NOTICE
+ * </pre>
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
@@ -37,8 +56,7 @@ public class InstallationLayout extends
/**
* Creates a new instance of InstallationLayout.
*
- * @param installationDirectory
- * the installation directory
+ * @param installationDirectory the installation directory
*/
public InstallationLayout( File installationDirectory )
{
@@ -50,8 +68,7 @@ public class InstallationLayout extends
/**
* Creates a new instance of InstallationLayout.
*
- * @param installationDirectoryPath
- * the path to the installation directory
+ * @param installationDirectoryPath the path to the installation directory
*/
public InstallationLayout( String installationDirectoryPath )
{
@@ -89,8 +106,7 @@ public class InstallationLayout extends
/**
* Gets the 'bin' directory in the installation directory.
*
- * @return
- * the 'bin' directory
+ * @return the 'bin' directory
*/
public File getBinDirectory()
{
@@ -101,8 +117,7 @@ public class InstallationLayout extends
/**
* Gets the 'conf' directory in the installation directory.
*
- * @return
- * the 'conf' directory
+ * @return the 'conf' directory
*/
public File getConfDirectory()
{
@@ -113,8 +128,7 @@ public class InstallationLayout extends
/**
* Gets the installation directory.
*
- * @return
- * the installation directory
+ * @return the installation directory
*/
public File getInstallationDirectory()
{
@@ -125,8 +139,7 @@ public class InstallationLayout extends
/**
* Gets the 'lib' directory in the installation directory.
*
- * @return
- * the 'lib' directory
+ * @return the 'lib' directory
*/
public File getLibDirectory()
{
@@ -137,8 +150,7 @@ public class InstallationLayout extends
/**
* Gets the LICENSE file (<em>'/LICENSE'</em>).
*
- * @return
- * the LICENSE file
+ * @return the LICENSE file
*/
public File getLicenseFile()
{
@@ -149,8 +161,7 @@ public class InstallationLayout extends
/**
* Gets the NOTICE file (<em>'/NOTICE'</em>).
*
- * @return
- * the NOTICE file
+ * @return the NOTICE file
*/
public File getNoticeFile()
{
@@ -161,8 +172,7 @@ public class InstallationLayout extends
/**
* Gets the script file (<em>'/bin/apacheds'</em>).
*
- * @return
- * the script file
+ * @return the script file
*/
public File getScriptFile()
{
@@ -173,8 +183,7 @@ public class InstallationLayout extends
/**
* Gets the wrapper configuration file (<em>'/conf/wrapper.conf'</em>).
*
- * @return
- * the wrapper configuration file
+ * @return the wrapper configuration file
*/
public File getWrapperConfigurationFile()
{
@@ -185,8 +194,7 @@ public class InstallationLayout extends
/**
* Gets the wrapper file (<em>'/bin/wrapper'</em>).
*
- * @return
- * the wrapper file
+ * @return the wrapper file
*/
public File getWrapperFile()
{