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 65f15cb3 Minor refactoring for lisibility
65f15cb3 is described below
commit 65f15cb322a001d9eec8c920905de99d2d170de6
Author: emmanuel lecharny <[email protected]>
AuthorDate: Mon Jan 6 09:04:10 2025 +0100
Minor refactoring for lisibility
---
.../java/org/apache/ftpserver/message/MessageResource.java | 8 +++++---
.../org/apache/ftpserver/message/MessageResourceFactory.java | 12 ++++++++----
.../ftpserver/message/impl/DefaultMessageResource.java | 4 ++--
.../java/org/apache/ftpserver/usermanager/impl/BaseUser.java | 1 -
.../filesystem/nativefs/impl/FtpFileTestTemplate.java | 2 --
.../src/main/java/org/apache/ftpserver/ftplet/User.java | 10 +++++++---
6 files changed, 22 insertions(+), 15 deletions(-)
diff --git
a/core/src/main/java/org/apache/ftpserver/message/MessageResource.java
b/core/src/main/java/org/apache/ftpserver/message/MessageResource.java
index 924fa1a8..3939636c 100644
--- a/core/src/main/java/org/apache/ftpserver/message/MessageResource.java
+++ b/core/src/main/java/org/apache/ftpserver/message/MessageResource.java
@@ -28,16 +28,17 @@ import java.util.Map;
* @author <a href="http://mina.apache.org";>Apache MINA Project</a>
*/
public interface MessageResource {
-
/**
- * Get all the available languages.
- * @return A list of available languages
+ * Get all the supported message languages.
+ *
+ * @return A list of supported message languages
*/
List<String> getAvailableLanguages();
/**
* Get the message for the corresponding code and sub id. If not found it
* will return null.
+ *
* @param code The reply code
* @param subId The sub ID
* @param language The language
@@ -47,6 +48,7 @@ public interface MessageResource {
/**
* Get all the messages.
+ *
* @param language The language
* @return All messages for the provided language
*/
diff --git
a/core/src/main/java/org/apache/ftpserver/message/MessageResourceFactory.java
b/core/src/main/java/org/apache/ftpserver/message/MessageResourceFactory.java
index 8aab0f35..9c998bc7 100644
---
a/core/src/main/java/org/apache/ftpserver/message/MessageResourceFactory.java
+++
b/core/src/main/java/org/apache/ftpserver/message/MessageResourceFactory.java
@@ -38,6 +38,7 @@ public class MessageResourceFactory {
/**
* Create an {@link MessageResource} based on the configuration on this
factory
+ *
* @return The {@link MessageResource} instance
*/
public MessageResource createMessageResource() {
@@ -46,23 +47,25 @@ public class MessageResourceFactory {
/**
* The languages for which messages are available
- * @return The list of available languages
+ *
+ * @return The list of supported languages
*/
public List<String> getLanguages() {
return languages;
}
/**
- * Set the languages for which messages are available
- * @param languages The list of available languages
+ * Set the languages for which messages are supported
+ *
+ * @param languages The list of supported languages
*/
-
public void setLanguages(List<String> languages) {
this.languages = languages;
}
/**
* The directory where custom message bundles can be located
+ *
* @return The {@link File} denoting the directory with message bundles
*/
public File getCustomMessageDirectory() {
@@ -71,6 +74,7 @@ public class MessageResourceFactory {
/**
* Set the directory where custom message bundles can be located
+ *
* @param customMessageDirectory The {@link File} denoting the directory
with message bundles
*/
public void setCustomMessageDirectory(File customMessageDirectory) {
diff --git
a/core/src/main/java/org/apache/ftpserver/message/impl/DefaultMessageResource.java
b/core/src/main/java/org/apache/ftpserver/message/impl/DefaultMessageResource.java
index fc209ff3..49411499 100644
---
a/core/src/main/java/org/apache/ftpserver/message/impl/DefaultMessageResource.java
+++
b/core/src/main/java/org/apache/ftpserver/message/impl/DefaultMessageResource.java
@@ -41,8 +41,8 @@ import org.slf4j.LoggerFactory;
* <br>
* Basic message search path is:
*
- * Custom Language Specific Messages -> Default Language Specific Messages ->
- * Custom Common Messages -> Default Common Messages -> null (not found)
+ * Custom Language Specific Messages -> Default Language Specific Messages
->
+ * Custom Common Messages -> Default Common Messages -> null (not found)
* <br>
* <strong>Internal class, do not use directly.</strong>
*
diff --git
a/core/src/main/java/org/apache/ftpserver/usermanager/impl/BaseUser.java
b/core/src/main/java/org/apache/ftpserver/usermanager/impl/BaseUser.java
index 315c05ca..edc6735d 100644
--- a/core/src/main/java/org/apache/ftpserver/usermanager/impl/BaseUser.java
+++ b/core/src/main/java/org/apache/ftpserver/usermanager/impl/BaseUser.java
@@ -44,7 +44,6 @@ import org.apache.ftpserver.ftplet.User;
*
* @author <a href="http://mina.apache.org";>Apache MINA Project</a>
*/
-
public class BaseUser implements User {
private String name = null;
diff --git
a/core/src/test/java/org/apache/ftpserver/filesystem/nativefs/impl/FtpFileTestTemplate.java
b/core/src/test/java/org/apache/ftpserver/filesystem/nativefs/impl/FtpFileTestTemplate.java
index a8216ad0..ddc8bde7 100644
---
a/core/src/test/java/org/apache/ftpserver/filesystem/nativefs/impl/FtpFileTestTemplate.java
+++
b/core/src/test/java/org/apache/ftpserver/filesystem/nativefs/impl/FtpFileTestTemplate.java
@@ -34,7 +34,6 @@ import org.apache.ftpserver.usermanager.impl.BaseUser;
*
*/
public abstract class FtpFileTestTemplate extends TestCase {
-
protected static final String FILE2_PATH = "/dir1/file2";
protected static final String DIR1_PATH = "/dir1";
@@ -123,5 +122,4 @@ public abstract class FtpFileTestTemplate extends TestCase {
assertEquals("file1", files.get(1).getName());
assertEquals("file3", files.get(2).getName());
}
-
}
\ No newline at end of file
diff --git a/ftplet-api/src/main/java/org/apache/ftpserver/ftplet/User.java
b/ftplet-api/src/main/java/org/apache/ftpserver/ftplet/User.java
index 3de52375..a351b8d7 100644
--- a/ftplet-api/src/main/java/org/apache/ftpserver/ftplet/User.java
+++ b/ftplet-api/src/main/java/org/apache/ftpserver/ftplet/User.java
@@ -27,15 +27,16 @@ import java.util.List;
* @author <a href="http://mina.apache.org";>Apache MINA Project</a>
*/
public interface User {
-
/**
* Get the user name.
+ *
* @return The user name, the same used for login
*/
String getName();
/**
* Get password.
+ *
* @return The users password or null if the user manager can not provide
the password
*/
String getPassword();
@@ -49,6 +50,7 @@ public interface User {
/**
* Get authorities of the specified type granted to this user
+ *
* @param clazz The type of {@link Authority}
* @return Authorities of the specified class
*/
@@ -57,8 +59,7 @@ public interface User {
/**
* Authorize a {@link AuthorizationRequest} for this user
*
- * @param request
- * The {@link AuthorizationRequest} to authorize
+ * @param request The {@link AuthorizationRequest} to authorize
* @return A populated AuthorizationRequest if the user was authorized,
null
* otherwise.
*/
@@ -67,18 +68,21 @@ public interface User {
/**
* Get the maximum idle time in seconds. Zero or less idle time means no
* limit.
+ *
* @return The idle time in seconds
*/
int getMaxIdleTime();
/**
* Get the user enable status.
+ *
* @return true if the user is enabled
*/
boolean getEnabled();
/**
* Get the user home directory
+ *
* @return The path to the home directory for the user
*/
String getHomeDirectory();
