This is an automated email from the ASF dual-hosted git repository.
elecharny pushed a commit to branch 1.2.X
in repository https://gitbox.apache.org/repos/asf/mina-ftpserver.git
The following commit(s) were added to refs/heads/1.2.X by this push:
new c65b1e2b Fixed the mvn site build, fixed some Javadoc errors
c65b1e2b is described below
commit c65b1e2b82336978002c0a7fec9c06f02055febe
Author: emmanuel lecharny <[email protected]>
AuthorDate: Mon Dec 30 18:53:28 2024 +0100
Fixed the mvn site build, fixed some Javadoc errors
---
distribution/pom.xml | 1 -
ftplet-api/pom.xml | 5 ++--
.../apache/ftpserver/ftplet/DataConnection.java | 7 +++--
.../ftpserver/ftplet/DataConnectionFactory.java | 3 +-
.../java/org/apache/ftpserver/ftplet/FtpFile.java | 3 +-
.../org/apache/ftpserver/ftplet/FtpSession.java | 2 --
.../java/org/apache/ftpserver/ftplet/Ftplet.java | 33 +++++++++-------------
.../org/apache/ftpserver/ftplet/FtpletResult.java | 2 +-
.../org/apache/ftpserver/ftplet/UserManager.java | 1 -
pom.xml | 8 +++++-
10 files changed, 33 insertions(+), 32 deletions(-)
diff --git a/distribution/pom.xml b/distribution/pom.xml
index dbf10d21..ff894df2 100644
--- a/distribution/pom.xml
+++ b/distribution/pom.xml
@@ -74,7 +74,6 @@
</excludes>
</configuration>
</plugin>
-
</plugins>
</build>
diff --git a/ftplet-api/pom.xml b/ftplet-api/pom.xml
index 597657f1..420fb967 100644
--- a/ftplet-api/pom.xml
+++ b/ftplet-api/pom.xml
@@ -63,8 +63,9 @@
<artifactId>maven-javadoc-plugin</artifactId>
</plugin>
<plugin>
- <groupId>org.codehaus.mojo</groupId>
- <artifactId>jxr-maven-plugin</artifactId>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-jxr-plugin</artifactId>
+ <version>3.6.0</version>
</plugin>
</plugins>
</reporting>
diff --git
a/ftplet-api/src/main/java/org/apache/ftpserver/ftplet/DataConnection.java
b/ftplet-api/src/main/java/org/apache/ftpserver/ftplet/DataConnection.java
index af5fa17f..39222a14 100644
--- a/ftplet-api/src/main/java/org/apache/ftpserver/ftplet/DataConnection.java
+++ b/ftplet-api/src/main/java/org/apache/ftpserver/ftplet/DataConnection.java
@@ -24,6 +24,7 @@ import java.io.InputStream;
import java.io.OutputStream;
/**
+ * The data transfert interface.
*
* @author <a href="http://mina.apache.org";>Apache MINA Project</a>
*/
@@ -36,7 +37,7 @@ public interface DataConnection {
* The {@link OutputStream} containing the destination of the
* data from the client.
* @return The length of the transferred data
- * @throws IOException
+ * @throws IOException If the transfer failed
*/
long transferFromClient(FtpSession session, OutputStream out)
throws IOException;
@@ -47,7 +48,7 @@ public interface DataConnection {
* @param in
* Data to be transfered to the client
* @return The length of the transferred data
- * @throws IOException
+ * @throws IOException If the transfer failed
*/
long transferToClient(FtpSession session, InputStream in)
throws IOException;
@@ -57,7 +58,7 @@ public interface DataConnection {
* @param session The current {@link FtpSession}
* @param str
* The string to transfer
- * @throws IOException
+ * @throws IOException If the transfer failed
*/
void transferToClient(FtpSession session, String str) throws IOException;
}
diff --git
a/ftplet-api/src/main/java/org/apache/ftpserver/ftplet/DataConnectionFactory.java
b/ftplet-api/src/main/java/org/apache/ftpserver/ftplet/DataConnectionFactory.java
index 99102034..6785e922 100644
---
a/ftplet-api/src/main/java/org/apache/ftpserver/ftplet/DataConnectionFactory.java
+++
b/ftplet-api/src/main/java/org/apache/ftpserver/ftplet/DataConnectionFactory.java
@@ -20,6 +20,7 @@
package org.apache.ftpserver.ftplet;
/**
+ * A DataConnection factory
*
* @author <a href="http://mina.apache.org";>Apache MINA Project</a>
*/
@@ -29,7 +30,7 @@ public interface DataConnectionFactory {
* Open an active data connection
*
* @return The open data connection
- * @throws Exception
+ * @throws Exception If the connection cannot be opened
*/
DataConnection openConnection() throws Exception;
diff --git a/ftplet-api/src/main/java/org/apache/ftpserver/ftplet/FtpFile.java
b/ftplet-api/src/main/java/org/apache/ftpserver/ftplet/FtpFile.java
index 5024ac24..2192a3d3 100644
--- a/ftplet-api/src/main/java/org/apache/ftpserver/ftplet/FtpFile.java
+++ b/ftplet-api/src/main/java/org/apache/ftpserver/ftplet/FtpFile.java
@@ -112,7 +112,8 @@ public interface FtpFile {
/**
* Set the last modified time stamp of a file.
- * @param time The last modified time, in milliseconds since the epoch.
See {@link File#setLastModified(long)}.
+ * @param time The last modified time, in milliseconds since the epoch.
+ * See {@link java.io.File#setLastModified(long)}.
* @return <code>true</code> if and only if the operation succeeded;
<code>false</code> otherwise
*/
boolean setLastModified(long time);
diff --git
a/ftplet-api/src/main/java/org/apache/ftpserver/ftplet/FtpSession.java
b/ftplet-api/src/main/java/org/apache/ftpserver/ftplet/FtpSession.java
index ad25a0ba..a947e230 100644
--- a/ftplet-api/src/main/java/org/apache/ftpserver/ftplet/FtpSession.java
+++ b/ftplet-api/src/main/java/org/apache/ftpserver/ftplet/FtpSession.java
@@ -86,7 +86,6 @@ public interface FtpSession {
/**
* Returns maximum idle time. This time equals to
- * {@link ConnectionManagerImpl#getDefaultIdleSec()} until user login, and
* {@link User#getMaxIdleTime()} after user login.
* @return The number of seconds the client is allowed to be idle before
disconnected.
*/
@@ -94,7 +93,6 @@ public interface FtpSession {
/**
* Set maximum idle time in seconds. This time equals to
- * {@link ConnectionManagerImpl#getDefaultIdleSec()} until user login, and
* {@link User#getMaxIdleTime()} after user login.
* @param maxIdleTimeSec The number of seconds the client is allowed to be
idle before disconnected.
*/
diff --git a/ftplet-api/src/main/java/org/apache/ftpserver/ftplet/Ftplet.java
b/ftplet-api/src/main/java/org/apache/ftpserver/ftplet/Ftplet.java
index 37b73f95..6024254c 100644
--- a/ftplet-api/src/main/java/org/apache/ftpserver/ftplet/Ftplet.java
+++ b/ftplet-api/src/main/java/org/apache/ftpserver/ftplet/Ftplet.java
@@ -54,7 +54,7 @@ public interface Ftplet {
* exactly once after instantiating the ftplet. The init method must
* complete successfully before the ftplet can receive any requests.
* @param ftpletContext The current {@link FtpletContext}
- * @throws FtpException
+ * @throws FtpException If the initialization failed
*/
void init(FtpletContext ftpletContext) throws FtpException;
@@ -85,13 +85,11 @@ public interface Ftplet {
* <li>Ftplet throws exception: Same as {@link
FtpletResult#DISCONNECT}</li>
* </ul>
*
- * @param session
- * The current session
- * @param request
- * The current request
+ * @param session The current session
+ * @param request The current request
* @return The desired action to be performed by the server
- * @throws FtpException
- * @throws IOException
+ * @throws FtpException If a FTP error occurred
+ * @throws IOException If an IO error occurred
*/
FtpletResult beforeCommand(FtpSession session, FtpRequest request)
throws FtpException, IOException;
@@ -110,17 +108,14 @@ public interface Ftplet {
* <li>Ftplet throws exception: Same as {@link
FtpletResult#DISCONNECT}</li>
* </ul>
*
- * @param session
- * The current session
- * @param request
- * The current request
- * @param reply
- * the reply that was sent for this command. Implementations can
+ * @param session The current session
+ * @param request The current request
+ * @param reply the reply that was sent for this command. Implementations
can
* use this to check the reply code and thus determine if the
* command was successfully processed or not.
* @return The desired action to be performed by the server
- * @throws FtpException
- * @throws IOException
+ * @throws FtpException If a FTP error occurred
+ * @throws IOException If an IO error occurred
*/
FtpletResult afterCommand(FtpSession session, FtpRequest request, FtpReply
reply)
throws FtpException, IOException;
@@ -129,8 +124,8 @@ public interface Ftplet {
* Client connect notification method.
* @param session The current {@link FtpSession}
* @return The desired action to be performed by the server
- * @throws FtpException
- * @throws IOException
+ * @throws FtpException If a FTP error occurred
+ * @throws IOException If an IO error occurred
*/
FtpletResult onConnect(FtpSession session) throws FtpException,
IOException;
@@ -138,8 +133,8 @@ public interface Ftplet {
* Client disconnect notification method. This is the last callback method.
* @param session The current {@link FtpSession}
* @return The desired action to be performed by the server
- * @throws FtpException
- * @throws IOException
+ * @throws FtpException If a FTP error occurred
+ * @throws IOException If an IO error occurred
*/
FtpletResult onDisconnect(FtpSession session) throws FtpException,
IOException;
diff --git
a/ftplet-api/src/main/java/org/apache/ftpserver/ftplet/FtpletResult.java
b/ftplet-api/src/main/java/org/apache/ftpserver/ftplet/FtpletResult.java
index e353d17d..60fe1324 100644
--- a/ftplet-api/src/main/java/org/apache/ftpserver/ftplet/FtpletResult.java
+++ b/ftplet-api/src/main/java/org/apache/ftpserver/ftplet/FtpletResult.java
@@ -22,7 +22,7 @@ package org.apache.ftpserver.ftplet;
/**
* This class encapsulates the return values of the ftplet methods.
*
- * DEFAULT < NO_FTPLET < SKIP < DISCONNECT
+ * DEFAULT < NO_FTPLET < SKIP < DISCONNECT
*
* @author <a href="http://mina.apache.org";>Apache MINA Project</a>
*/
diff --git
a/ftplet-api/src/main/java/org/apache/ftpserver/ftplet/UserManager.java
b/ftplet-api/src/main/java/org/apache/ftpserver/ftplet/UserManager.java
index b8e64077..62b148f7 100644
--- a/ftplet-api/src/main/java/org/apache/ftpserver/ftplet/UserManager.java
+++ b/ftplet-api/src/main/java/org/apache/ftpserver/ftplet/UserManager.java
@@ -78,7 +78,6 @@ public interface UserManager {
* @param authentication The {@link Authentication} that proves the users
identity
* @return the authenticated account.
* @throws AuthenticationFailedException
- * @throws FtpException when the UserManager can't fulfill the request.
*/
User authenticate(Authentication authentication)
throws AuthenticationFailedException;
diff --git a/pom.xml b/pom.xml
index fe9a8381..08940dc5 100644
--- a/pom.xml
+++ b/pom.xml
@@ -176,6 +176,7 @@
<!-- Maven plugin version -->
<maven-javadoc-plugin-version>3.11.2</maven-javadoc-plugin-version>
+ <version.site.plugin>4.0.0-M16</version.site.plugin>
</properties>
<dependencyManagement>
@@ -391,7 +392,12 @@
</parameter>
</configuration>
</plugin>
-
+
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-site-plugin</artifactId>
+ <version>${version.site.plugin}</version>
+ </plugin>
</plugins>
</pluginManagement>
