This is an automated email from the ASF dual-hosted git repository.
cziegeler pushed a commit to branch master
in repository
https://gitbox.apache.org/repos/asf/sling-org-apache-sling-launchpad-base.git
The following commit(s) were added to refs/heads/master by this push:
new 1558d5a Fix javadoc errors
1558d5a is described below
commit 1558d5a9a2a95a94a7a5aec4286c1971bba25b96
Author: Carsten Ziegeler <[email protected]>
AuthorDate: Fri Jul 21 09:15:53 2023 +0200
Fix javadoc errors
---
.../java/org/apache/sling/launchpad/app/Main.java | 19 ++++++++-----------
.../launchpad/base/impl/DefaultStartupHandler.java | 1 +
.../sling/launchpad/base/impl/DirectoryUtil.java | 4 ++++
.../org/apache/sling/launchpad/base/impl/Sling.java | 8 ++++++--
.../sling/launchpad/base/impl/StartupManager.java | 1 +
.../impl/bootstrapcommands/BootstrapCommandFile.java | 16 +++++++++++++---
.../apache/sling/launchpad/base/shared/Launcher.java | 4 ++++
.../apache/sling/launchpad/base/shared/Loader.java | 9 ++++++++-
.../sling/launchpad/base/shared/SharedConstants.java | 6 +++---
.../org/apache/sling/launchpad/base/shared/Util.java | 2 +-
.../launchpad/base/webapp/SlingServletDelegate.java | 10 ++--------
.../apache/sling/launchpad/webapp/SlingServlet.java | 2 +-
12 files changed, 52 insertions(+), 30 deletions(-)
diff --git a/src/main/java/org/apache/sling/launchpad/app/Main.java
b/src/main/java/org/apache/sling/launchpad/app/Main.java
index 312ba8f..243e677 100644
--- a/src/main/java/org/apache/sling/launchpad/app/Main.java
+++ b/src/main/java/org/apache/sling/launchpad/app/Main.java
@@ -222,8 +222,8 @@ public class Main {
* the communication with a running Sling instance. To setup this
* communication the configuration properties supplied to the constructor
* are evaluated as follows:
- * <p>
* <table>
+ * <caption>Control Properties</caption>
* <tr>
* <td><code>{@value #PROP_CONTROL_SOCKET}</code></td>
* <td>Specifies the socket to use for the control connection. This
@@ -238,19 +238,15 @@ public class Main {
* <td><code>{@value #PROP_CONTROL_ACTION}</code></td>
* <td>The actual action to execute:
* <ul>
- * <b>start</b> -- Start the listener on the configured socket and expect
+ * <li><b>start</b> -- Start the listener on the configured socket and
expect
* commands there. This action is useful only when launching the Sling
- * application since this action helps manage a running system.
- * </ul>
- * <ul>
- * <b>stop</b> -- Connects to the listener running on the configured socket
+ * application since this action helps manage a running system.</li>
+ * <li><b>stop</b> -- Connects to the listener running on the configured
socket
* and send the command to terminate the Sling Application. If this command
- * is used, it is expected the Sling Application will not start.
- * </ul>
- * <ul>
- * <b>status</b> -- Connects to the listener running on the configured
+ * is used, it is expected the Sling Application will not start.</li>
+ * <li><b>status</b> -- Connects to the listener running on the configured
* socket and query about its status. If this command is used, it is
- * expected the Sling Application will not start.
+ * expected the Sling Application will not start.</li>
* </ul>
* </td>
* </tr>
@@ -530,6 +526,7 @@ public class Main {
/**
* Return the absolute path to sling home
+ * @return The path to sling home
*/
public String getSlingHome() {
return this.slingHome;
diff --git
a/src/main/java/org/apache/sling/launchpad/base/impl/DefaultStartupHandler.java
b/src/main/java/org/apache/sling/launchpad/base/impl/DefaultStartupHandler.java
index 4212df0..513195b 100644
---
a/src/main/java/org/apache/sling/launchpad/base/impl/DefaultStartupHandler.java
+++
b/src/main/java/org/apache/sling/launchpad/base/impl/DefaultStartupHandler.java
@@ -114,6 +114,7 @@ public class DefaultStartupHandler
* @param context Bundle context
* @param logger Logger
* @param manager The startup manager
+ * @param startedAt The started time
*/
public DefaultStartupHandler(final BundleContext context,
final Logger logger,
diff --git
a/src/main/java/org/apache/sling/launchpad/base/impl/DirectoryUtil.java
b/src/main/java/org/apache/sling/launchpad/base/impl/DirectoryUtil.java
index 9d42f3f..8754730 100644
--- a/src/main/java/org/apache/sling/launchpad/base/impl/DirectoryUtil.java
+++ b/src/main/java/org/apache/sling/launchpad/base/impl/DirectoryUtil.java
@@ -84,6 +84,8 @@ public class DirectoryUtil {
/**
* Return the config dir.
+ * @param properties The properties.
+ * @return The config dir.
*/
public static File getConfigDir(final Map<String, String> properties) {
return new File(getHomeDir(properties), PATH_CONF);
@@ -91,6 +93,8 @@ public class DirectoryUtil {
/**
* Return the startup dir.
+ * @param properties The properties.
+ * @return The startup dir.
*/
public static File getStartupDir(final Map<String, String> properties) {
return new File(getHomeDir(properties), PATH_STARTUP);
diff --git a/src/main/java/org/apache/sling/launchpad/base/impl/Sling.java
b/src/main/java/org/apache/sling/launchpad/base/impl/Sling.java
index 076aec8..dcc17aa 100644
--- a/src/main/java/org/apache/sling/launchpad/base/impl/Sling.java
+++ b/src/main/java/org/apache/sling/launchpad/base/impl/Sling.java
@@ -83,7 +83,6 @@ import org.osgi.service.url.URLStreamHandlerService;
* <code>${inner}</code> and then resolving the property whose name is the
* catenation of <code>outer-</code> and the result of resolving
* <code>${inner}</code>.
- * <p>
*/
public class Sling {
@@ -181,7 +180,10 @@ public class Sling {
* properties, starting the OSGi framework (Apache Felix) and exposing the
* system bundle context and the <code>Felix</code> instance as servlet
* context attributes.
- *
+ * @param notifiable The notifiable
+ * @param logger The logger
+ * @param resourceProvider The resource provider
+ * @param propOverwrite The properties to overwrite
* @throws BundleException if the framework cannot be initialized.
*/
public Sling(final Notifiable notifiable,
@@ -692,6 +694,8 @@ public class Sling {
* framework launched by this servlet. This method only returns a
non-<code>null</code>
* object after the system bundle of the framework has been started and
* before it is being stopped.
+ *
+ * @return The <code>BundleContext</code> of the system bundle
*/
public final BundleContext getBundleContext() {
return this.framework.getBundleContext();
diff --git
a/src/main/java/org/apache/sling/launchpad/base/impl/StartupManager.java
b/src/main/java/org/apache/sling/launchpad/base/impl/StartupManager.java
index 5e87644..e5eac05 100644
--- a/src/main/java/org/apache/sling/launchpad/base/impl/StartupManager.java
+++ b/src/main/java/org/apache/sling/launchpad/base/impl/StartupManager.java
@@ -108,6 +108,7 @@ public class StartupManager {
/**
* Is the incremental startup enabled?
+ * @return {@code true} if incremental startup is enabled.
*/
public boolean isIncrementalStartupEnabled() {
return this.incrementalStartupEnabled;
diff --git
a/src/main/java/org/apache/sling/launchpad/base/impl/bootstrapcommands/BootstrapCommandFile.java
b/src/main/java/org/apache/sling/launchpad/base/impl/bootstrapcommands/BootstrapCommandFile.java
index b36fcd8..0b29dbe 100644
---
a/src/main/java/org/apache/sling/launchpad/base/impl/bootstrapcommands/BootstrapCommandFile.java
+++
b/src/main/java/org/apache/sling/launchpad/base/impl/bootstrapcommands/BootstrapCommandFile.java
@@ -46,14 +46,22 @@ public class BootstrapCommandFile {
commandPrototypes.add(new UninstallBundleCommand());
}
- /** Will load our commands from specified file, if found */
+ /**
+ * Will load our commands from specified file, if found
+ * @param logger Logger to use
+ * @param cmdFile File to load commands from, or null
+ */
public BootstrapCommandFile(Logger logger, File cmdFile) {
this.logger = logger;
this.commandFile = cmdFile;
}
- /** True if we have a command file that needs to be executed, based on its
- * file timestamp and stored timstamp
+ /**
+ * True if we have a command file that needs to be executed, based on its
+ * file timestamp and stored timstamp
+ * @param ctx BundleContext to use
+ * @return True if we have a command file that needs to be executed
+ *
*/
boolean anythingToExecute(BundleContext ctx) {
boolean result = false;
@@ -82,7 +90,9 @@ public class BootstrapCommandFile {
/**
* Execute commands if needed, and store execution timestamp
+ * @param ctx BundleContext to use
* @return If system bundle needs a restart.
+ * @throws IOException If an error occurs
*/
public boolean execute(BundleContext ctx) throws IOException {
boolean needsRestart = false;
diff --git a/src/main/java/org/apache/sling/launchpad/base/shared/Launcher.java
b/src/main/java/org/apache/sling/launchpad/base/shared/Launcher.java
index 398326f..5e960cb 100644
--- a/src/main/java/org/apache/sling/launchpad/base/shared/Launcher.java
+++ b/src/main/java/org/apache/sling/launchpad/base/shared/Launcher.java
@@ -31,21 +31,25 @@ public interface Launcher {
* Sets the sling.home to be used for starting the framework. This method
* must be called with a non-<code>null</code> argument before trying to
* start the framework.
+ * @param slingHome The sling.home directory
*/
public void setSlingHome(String slingHome);
/**
* The {@link Notifiable} to notify on framework stop or update
+ * @param notifiable The notifiable
*/
public void setNotifiable(Notifiable notifiable);
/**
* The commandline provided from the standalone launch case.
+ * @param args The commandline
*/
public void setCommandLine(Map<String, String> args);
/**
* Starts the framework and returns <code>true</code> if successfull.
+ * @return <code>true</code> if the framework has been started successfully
*/
public boolean start();
diff --git a/src/main/java/org/apache/sling/launchpad/base/shared/Loader.java
b/src/main/java/org/apache/sling/launchpad/base/shared/Loader.java
index 605b23c..11935ff 100644
--- a/src/main/java/org/apache/sling/launchpad/base/shared/Loader.java
+++ b/src/main/java/org/apache/sling/launchpad/base/shared/Loader.java
@@ -155,6 +155,7 @@ public class Loader {
* sling home directory. If the existing file is is a more recent bundle
* version than the supplied launcher JAR file, it is is not replaced.
*
+ * @param launcherJar The URL to the launcher JAR
* @return <code>true</code> if the launcher JAR file has been installed or
* updated, <code>false</code> otherwise.
* @throws IOException If an error occurrs transferring the contents
@@ -268,6 +269,8 @@ public class Loader {
* contents of the file with the contents of the input stream. When this
* method returns, the input stream is guaranteed to be closed.
*
+ * @param ins The input stream to spool
+ * @param destFile The file to spool the input stream contents to
* @throws IOException If an error occurrs reading or writing the input
* stream contents.
*/
@@ -405,7 +408,11 @@ public class Loader {
}
}
- /** Meant to be overridden to display or log info */
+ /**
+ * Meant to be overridden to display or log info
+ *
+ * @param msg The message to display or log
+ */
protected void info(String msg) {
}
diff --git
a/src/main/java/org/apache/sling/launchpad/base/shared/SharedConstants.java
b/src/main/java/org/apache/sling/launchpad/base/shared/SharedConstants.java
index 51764ad..5a77e29 100644
--- a/src/main/java/org/apache/sling/launchpad/base/shared/SharedConstants.java
+++ b/src/main/java/org/apache/sling/launchpad/base/shared/SharedConstants.java
@@ -78,7 +78,7 @@ public interface SharedConstants {
/**
* True or false value which controls whether sling will load bundles which
- * are contained in the resources/# path locations in the sling jar or war
<br/>
+ * are contained in the resources/# path locations in the sling jar or war.
* The default is to unpack the jars and deploy them to the startup folder
* in sling home
*/
@@ -86,7 +86,7 @@ public interface SharedConstants {
/**
* True or false value which controls whether sling will load bundles which
- * are contained in the resources/# path locations in the sling jar or war
<br/>
+ * are contained in the resources/# path locations in the sling jar or war
* regardless of the modification time of the Launchpad JAR.
*/
public static final String FORCE_PACKAGE_BUNDLE_LOADING =
"org.apache.sling.launchpad.force.package.bundle.loading";
@@ -144,7 +144,7 @@ public interface SharedConstants {
* The framework starts with the startlevel of {@value
#SLING_INSTALL_STARTLEVEL}
* and the stops when it reaches this level
* Default value is the value of the osgi initial framework start level
- * @see {@link #SLING_INSTALL_STARTLEVEL}
+ * @see #SLING_INSTALL_STARTLEVEL
*/
public static final String SLING_INSTALL_TARGETSTARTLEVEL =
"sling.framework.install.targetstartlevel";
}
diff --git a/src/main/java/org/apache/sling/launchpad/base/shared/Util.java
b/src/main/java/org/apache/sling/launchpad/base/shared/Util.java
index 43cd7ce..19d1f4f 100644
--- a/src/main/java/org/apache/sling/launchpad/base/shared/Util.java
+++ b/src/main/java/org/apache/sling/launchpad/base/shared/Util.java
@@ -44,7 +44,7 @@ public final class Util {
/**
* This method performs property variable substitution on the specified
* value. If the specified value contains the syntax
- * <tt>${<prop-name>}</tt>, where <tt><prop-name></tt>
+ * <b>${<prop-name>}</b>, where <b><prop-name></b>
* refers to either a configuration property or a system property, then the
* corresponding property value is substituted for the variable
placeholder.
* Multiple variable placeholders may exist in the specified value as well
diff --git
a/src/main/java/org/apache/sling/launchpad/base/webapp/SlingServletDelegate.java
b/src/main/java/org/apache/sling/launchpad/base/webapp/SlingServletDelegate.java
index 4fe6f4b..2ee5f17 100644
---
a/src/main/java/org/apache/sling/launchpad/base/webapp/SlingServletDelegate.java
+++
b/src/main/java/org/apache/sling/launchpad/base/webapp/SlingServletDelegate.java
@@ -128,7 +128,7 @@ public class SlingServletDelegate extends GenericServlet
implements Launcher {
/**
* Flag set by the {@link #destroy()} method to indicate the servlet has
- * been destroyed. This flag is used by the {@link #startSling(String)}
+ * been destroyed. This flag is used by the {@link #init()}
* method to check whether the SlingServletDelegate has been destroyed
while Sling
* was starting up.
*/
@@ -141,13 +141,7 @@ public class SlingServletDelegate extends GenericServlet
implements Launcher {
private Sling sling;
/**
- * The map of delegatee servlets to which requests are delegated. This map
- * is managed through the
- * {@link #serviceChanged(ServiceEvent) service listener} based on servlets
- * registered.
- *
- * @see #getDelegatee()
- * @see #ungetDelegatee(Object)
+ * The delegatee servlets to which requests are delegated.
*/
private Servlet delegatee;
diff --git a/src/main/java/org/apache/sling/launchpad/webapp/SlingServlet.java
b/src/main/java/org/apache/sling/launchpad/webapp/SlingServlet.java
index 60a37d9..c5992d3 100644
--- a/src/main/java/org/apache/sling/launchpad/webapp/SlingServlet.java
+++ b/src/main/java/org/apache/sling/launchpad/webapp/SlingServlet.java
@@ -92,7 +92,7 @@ public class SlingServlet extends GenericServlet implements
Notifiable {
private Servlet sling;
/**
- * Field managed by the {@link #startSling(String)} method to indicate
+ * Field managed by the {@link #startSling(ServletRequest)} method to
indicate
* whether Sling is in the process of being started.
*/
private Thread startingSling;
