You are viewing a plain text version of this content. The canonical link for it is here.
Posted to server-dev@james.apache.org by bt...@apache.org on 2019/11/20 01:57:13 UTC
[james-project] 45/49: [Refactoring] protocols-* clean javaDoc
This is an automated email from the ASF dual-hosted git repository.
btellier pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/james-project.git
commit 0a6a86ca73113e9445332af9552260afe7d3df6c
Author: Benoit Tellier <bt...@linagora.com>
AuthorDate: Sun Nov 17 21:27:16 2019 +0700
[Refactoring] protocols-* clean javaDoc
---
.../james/protocols/lib/handler/HandlersPackage.java | 2 --
.../protocols/lib/handler/ProtocolHandlerLoader.java | 5 -----
.../jmx/AbstractCommandHandlerResultJMXMonitor.java | 4 ----
.../protocols/lib/jmx/AbstractCommandHandlerStats.java | 4 ----
.../jmx/AbstractConnectHandlerResultJMXMonitor.java | 4 ----
.../lib/jmx/AbstractLineHandlerResultJMXMonitor.java | 2 --
.../protocols/lib/jmx/CommandHandlerStatsMBean.java | 5 +----
.../james/protocols/lib/jmx/ConnectHandlerStats.java | 2 --
.../james/protocols/lib/jmx/HandlerStatsMBean.java | 6 ------
.../james/protocols/lib/jmx/LineHandlerStats.java | 2 --
.../apache/james/protocols/lib/jmx/ServerMBean.java | 18 ------------------
.../apache/james/lmtpserver/netty/LMTPServerMBean.java | 6 ------
.../pop3server/jmx/POP3CommandHandlerStatsMBean.java | 4 ----
.../apache/james/pop3server/netty/OioPOP3Server.java | 1 -
.../org/apache/james/pop3server/netty/POP3Server.java | 3 ---
.../org/apache/james/smtpserver/SendMailHandler.java | 1 -
.../apache/james/smtpserver/jmx/HookStatsMBean.java | 12 ------------
.../smtpserver/jmx/SMTPCommandHandlerStatsMBean.java | 6 ------
.../apache/james/smtpserver/netty/OioSMTPServer.java | 1 -
.../smtpserver/netty/SMTPChannelUpstreamHandler.java | 2 --
.../org/apache/james/smtpserver/netty/SMTPServer.java | 4 ----
.../apache/james/smtpserver/netty/SMTPServerMBean.java | 10 ----------
22 files changed, 1 insertion(+), 103 deletions(-)
diff --git a/server/protocols/protocols-library/src/main/java/org/apache/james/protocols/lib/handler/HandlersPackage.java b/server/protocols/protocols-library/src/main/java/org/apache/james/protocols/lib/handler/HandlersPackage.java
index 79c354f..d71295b 100644
--- a/server/protocols/protocols-library/src/main/java/org/apache/james/protocols/lib/handler/HandlersPackage.java
+++ b/server/protocols/protocols-library/src/main/java/org/apache/james/protocols/lib/handler/HandlersPackage.java
@@ -34,8 +34,6 @@ public interface HandlersPackage extends ProtocolHandler {
/**
* Return a List which contains a set of CommandHandlers
- *
- * @return Map
*/
List<String> getHandlers();
diff --git a/server/protocols/protocols-library/src/main/java/org/apache/james/protocols/lib/handler/ProtocolHandlerLoader.java b/server/protocols/protocols-library/src/main/java/org/apache/james/protocols/lib/handler/ProtocolHandlerLoader.java
index 4e3e6ea..483dcc0 100644
--- a/server/protocols/protocols-library/src/main/java/org/apache/james/protocols/lib/handler/ProtocolHandlerLoader.java
+++ b/server/protocols/protocols-library/src/main/java/org/apache/james/protocols/lib/handler/ProtocolHandlerLoader.java
@@ -31,11 +31,6 @@ public interface ProtocolHandlerLoader {
/**
* Load the {@link ProtocolHandler} and make sure all lifecycle methods are called and all
* needed services injected.
- *
- * @param name
- * @param config
- * @return handler
- * @throws LoadingException
*/
ProtocolHandler load(String name, Configuration config) throws LoadingException;
diff --git a/server/protocols/protocols-library/src/main/java/org/apache/james/protocols/lib/jmx/AbstractCommandHandlerResultJMXMonitor.java b/server/protocols/protocols-library/src/main/java/org/apache/james/protocols/lib/jmx/AbstractCommandHandlerResultJMXMonitor.java
index 6015f4f..ddd143d 100644
--- a/server/protocols/protocols-library/src/main/java/org/apache/james/protocols/lib/jmx/AbstractCommandHandlerResultJMXMonitor.java
+++ b/server/protocols/protocols-library/src/main/java/org/apache/james/protocols/lib/jmx/AbstractCommandHandlerResultJMXMonitor.java
@@ -82,10 +82,6 @@ public abstract class AbstractCommandHandlerResultJMXMonitor<S extends ProtocolS
/**
* Create the {@link AbstractCommandHandlerStats} for the given
* {@link CommandHandler}
- *
- * @param handler
- * @return stats
- * @throws Exception
*/
protected abstract AbstractCommandHandlerStats createCommandHandlerStats(CommandHandler<S> handler) throws Exception;
diff --git a/server/protocols/protocols-library/src/main/java/org/apache/james/protocols/lib/jmx/AbstractCommandHandlerStats.java b/server/protocols/protocols-library/src/main/java/org/apache/james/protocols/lib/jmx/AbstractCommandHandlerStats.java
index 1ae62d8..85f3c67 100644
--- a/server/protocols/protocols-library/src/main/java/org/apache/james/protocols/lib/jmx/AbstractCommandHandlerStats.java
+++ b/server/protocols/protocols-library/src/main/java/org/apache/james/protocols/lib/jmx/AbstractCommandHandlerStats.java
@@ -59,8 +59,6 @@ public abstract class AbstractCommandHandlerStats extends StandardMBean implemen
/**
* Increment stats based on the given response
- *
- * @param response
*/
public void increment(Response response) {
if (response.isEndSession()) {
@@ -73,8 +71,6 @@ public abstract class AbstractCommandHandlerStats extends StandardMBean implemen
/**
* Subclasses need to implement this to handle more precise stats
- *
- * @param response
*/
protected abstract void incrementStats(Response response);
diff --git a/server/protocols/protocols-library/src/main/java/org/apache/james/protocols/lib/jmx/AbstractConnectHandlerResultJMXMonitor.java b/server/protocols/protocols-library/src/main/java/org/apache/james/protocols/lib/jmx/AbstractConnectHandlerResultJMXMonitor.java
index c75b2d0..7e2f042 100644
--- a/server/protocols/protocols-library/src/main/java/org/apache/james/protocols/lib/jmx/AbstractConnectHandlerResultJMXMonitor.java
+++ b/server/protocols/protocols-library/src/main/java/org/apache/james/protocols/lib/jmx/AbstractConnectHandlerResultJMXMonitor.java
@@ -35,8 +35,6 @@ import org.apache.james.protocols.api.handler.WiringException;
/**
* Handler which will gather statistics for {@link ConnectHandler}'s
- *
- * @param <S>
*/
public abstract class AbstractConnectHandlerResultJMXMonitor<R extends Response, S extends ProtocolSession> implements ProtocolHandlerResultHandler<R,S>, ExtensibleHandler, ProtocolHandler {
@@ -92,8 +90,6 @@ public abstract class AbstractConnectHandlerResultJMXMonitor<R extends Response,
/**
* Return the default JMXName to use if none is configured
- *
- * @return defaultJMXName
*/
protected abstract String getDefaultJMXName();
}
diff --git a/server/protocols/protocols-library/src/main/java/org/apache/james/protocols/lib/jmx/AbstractLineHandlerResultJMXMonitor.java b/server/protocols/protocols-library/src/main/java/org/apache/james/protocols/lib/jmx/AbstractLineHandlerResultJMXMonitor.java
index 3aa1f17..9939fb7 100644
--- a/server/protocols/protocols-library/src/main/java/org/apache/james/protocols/lib/jmx/AbstractLineHandlerResultJMXMonitor.java
+++ b/server/protocols/protocols-library/src/main/java/org/apache/james/protocols/lib/jmx/AbstractLineHandlerResultJMXMonitor.java
@@ -92,8 +92,6 @@ public abstract class AbstractLineHandlerResultJMXMonitor<R extends Response, S
/**
* Return default JMX Name if none is configured
- *
- * @return defaultJMXName
*/
protected abstract String getDefaultJMXName();
}
diff --git a/server/protocols/protocols-library/src/main/java/org/apache/james/protocols/lib/jmx/CommandHandlerStatsMBean.java b/server/protocols/protocols-library/src/main/java/org/apache/james/protocols/lib/jmx/CommandHandlerStatsMBean.java
index d9df450..3f6d0e9 100644
--- a/server/protocols/protocols-library/src/main/java/org/apache/james/protocols/lib/jmx/CommandHandlerStatsMBean.java
+++ b/server/protocols/protocols-library/src/main/java/org/apache/james/protocols/lib/jmx/CommandHandlerStatsMBean.java
@@ -18,8 +18,6 @@
****************************************************************/
package org.apache.james.protocols.lib.jmx;
-import org.apache.james.protocols.lib.jmx.HandlerStatsMBean;
-
/**
* JMX MBean for CommandHandler
*/
@@ -27,8 +25,7 @@ public interface CommandHandlerStatsMBean extends HandlerStatsMBean {
/**
* Return all implemented commands by this handler
- *
- * @return commands
+
*/
String[] getCommands();
}
diff --git a/server/protocols/protocols-library/src/main/java/org/apache/james/protocols/lib/jmx/ConnectHandlerStats.java b/server/protocols/protocols-library/src/main/java/org/apache/james/protocols/lib/jmx/ConnectHandlerStats.java
index 7fe8f0f..2e86864 100644
--- a/server/protocols/protocols-library/src/main/java/org/apache/james/protocols/lib/jmx/ConnectHandlerStats.java
+++ b/server/protocols/protocols-library/src/main/java/org/apache/james/protocols/lib/jmx/ConnectHandlerStats.java
@@ -53,8 +53,6 @@ public class ConnectHandlerStats extends StandardMBean implements HandlerStatsMB
/**
* Increment the stats
- *
- * @param response
*/
public void increment(Response response) {
all.incrementAndGet();
diff --git a/server/protocols/protocols-library/src/main/java/org/apache/james/protocols/lib/jmx/HandlerStatsMBean.java b/server/protocols/protocols-library/src/main/java/org/apache/james/protocols/lib/jmx/HandlerStatsMBean.java
index 8960b9a..3733a7f 100644
--- a/server/protocols/protocols-library/src/main/java/org/apache/james/protocols/lib/jmx/HandlerStatsMBean.java
+++ b/server/protocols/protocols-library/src/main/java/org/apache/james/protocols/lib/jmx/HandlerStatsMBean.java
@@ -25,22 +25,16 @@ public interface HandlerStatsMBean {
/**
* Return the count of all processed transactions by the handler
- *
- * @return all
*/
long getAll();
/**
* Return the name of the handler
- *
- * @return name
*/
String getName();
/**
* Return how often the Handler issued a disconnect
- *
- * @return disconnect
*/
long getDisconnect();
diff --git a/server/protocols/protocols-library/src/main/java/org/apache/james/protocols/lib/jmx/LineHandlerStats.java b/server/protocols/protocols-library/src/main/java/org/apache/james/protocols/lib/jmx/LineHandlerStats.java
index aca25ec..dd08360 100644
--- a/server/protocols/protocols-library/src/main/java/org/apache/james/protocols/lib/jmx/LineHandlerStats.java
+++ b/server/protocols/protocols-library/src/main/java/org/apache/james/protocols/lib/jmx/LineHandlerStats.java
@@ -55,8 +55,6 @@ public class LineHandlerStats extends StandardMBean implements HandlerStatsMBean
/**
* Increment the stats
- *
- * @param response
*/
public void increment(Response response) {
all.incrementAndGet();
diff --git a/server/protocols/protocols-library/src/main/java/org/apache/james/protocols/lib/jmx/ServerMBean.java b/server/protocols/protocols-library/src/main/java/org/apache/james/protocols/lib/jmx/ServerMBean.java
index 276d292..0a0aea2 100644
--- a/server/protocols/protocols-library/src/main/java/org/apache/james/protocols/lib/jmx/ServerMBean.java
+++ b/server/protocols/protocols-library/src/main/java/org/apache/james/protocols/lib/jmx/ServerMBean.java
@@ -25,36 +25,26 @@ public interface ServerMBean {
/**
* Return the maximum allowed concurrent connections for the server
- *
- * @return maxConcurrentConnections
*/
int getMaximumConcurrentConnections();
/**
* Return the current connection count
- *
- * @return currentConnection
*/
int getCurrentConnections();
/**
* Return the count of handled connections till startup
- *
- * @return handledConnections
*/
long getHandledConnections();
/**
* Return true if the server is enabled
- *
- * @return isEnabled
*/
boolean isEnabled();
/**
* Return true if startTLS is supported by the server
- *
- * @return startTLS
*/
boolean getStartTLSSupported();
@@ -75,29 +65,21 @@ public interface ServerMBean {
/**
* Return true if the server is started, which basicly means it is bound to
* a address and accept connections
- *
- * @return started
*/
boolean isStarted();
/**
* Start the server
- *
- * @return start
*/
boolean start();
/**
* Stop the server
- *
- * @return stop
*/
boolean stop();
/**
* Return the timeout in seconds
- *
- * @return timeout
*/
int getTimeout();
}
diff --git a/server/protocols/protocols-lmtp/src/main/java/org/apache/james/lmtpserver/netty/LMTPServerMBean.java b/server/protocols/protocols-lmtp/src/main/java/org/apache/james/lmtpserver/netty/LMTPServerMBean.java
index f42cdc2..a21ee61 100644
--- a/server/protocols/protocols-lmtp/src/main/java/org/apache/james/lmtpserver/netty/LMTPServerMBean.java
+++ b/server/protocols/protocols-lmtp/src/main/java/org/apache/james/lmtpserver/netty/LMTPServerMBean.java
@@ -25,23 +25,17 @@ public interface LMTPServerMBean extends ServerMBean, SMTPServerMBean {
/**
* Return the maximum allowed size of the message
- *
- * @return maxMessageSize
*/
long getMaximalMessageSize();
/**
* Set the maximum allowed size of messages. Set this to 0 to accept every
* message
- *
- * @param maxSize
*/
void setMaximalMessageSize(long maxSize);
/**
* Return the hello name
- *
- * @return helo
*/
String getHeloName();
diff --git a/server/protocols/protocols-pop3/src/main/java/org/apache/james/pop3server/jmx/POP3CommandHandlerStatsMBean.java b/server/protocols/protocols-pop3/src/main/java/org/apache/james/pop3server/jmx/POP3CommandHandlerStatsMBean.java
index 5321adc..baeacea 100644
--- a/server/protocols/protocols-pop3/src/main/java/org/apache/james/pop3server/jmx/POP3CommandHandlerStatsMBean.java
+++ b/server/protocols/protocols-pop3/src/main/java/org/apache/james/pop3server/jmx/POP3CommandHandlerStatsMBean.java
@@ -24,15 +24,11 @@ public interface POP3CommandHandlerStatsMBean extends CommandHandlerStatsMBean {
/**
* Return the count of errors returned by the handler
- *
- * @return error
*/
long getError();
/**
* Return the count of successful handling returned by the handler
- *
- * @return tempCount
*/
long getOk();
diff --git a/server/protocols/protocols-pop3/src/main/java/org/apache/james/pop3server/netty/OioPOP3Server.java b/server/protocols/protocols-pop3/src/main/java/org/apache/james/pop3server/netty/OioPOP3Server.java
index adae9b7..6ac1978 100644
--- a/server/protocols/protocols-pop3/src/main/java/org/apache/james/pop3server/netty/OioPOP3Server.java
+++ b/server/protocols/protocols-pop3/src/main/java/org/apache/james/pop3server/netty/OioPOP3Server.java
@@ -35,7 +35,6 @@ public class OioPOP3Server extends POP3Server {
/**
* As OIO use one thread per connection we disable the use of the {@link ExecutionHandler}
- *
*/
@Override
protected ExecutionHandler createExecutionHander() {
diff --git a/server/protocols/protocols-pop3/src/main/java/org/apache/james/pop3server/netty/POP3Server.java b/server/protocols/protocols-pop3/src/main/java/org/apache/james/pop3server/netty/POP3Server.java
index f00db57..cd4f4f5 100644
--- a/server/protocols/protocols-pop3/src/main/java/org/apache/james/pop3server/netty/POP3Server.java
+++ b/server/protocols/protocols-pop3/src/main/java/org/apache/james/pop3server/netty/POP3Server.java
@@ -55,9 +55,6 @@ public class POP3Server extends AbstractProtocolAsyncServer implements POP3Serve
* A class to provide POP3 handler configuration to the handlers
*/
private class POP3Configuration implements ProtocolConfiguration {
-
- /**
- */
@Override
public String getHelloName() {
return POP3Server.this.getHelloName();
diff --git a/server/protocols/protocols-smtp/src/main/java/org/apache/james/smtpserver/SendMailHandler.java b/server/protocols/protocols-smtp/src/main/java/org/apache/james/smtpserver/SendMailHandler.java
index 4de5cfe..4ef8201 100644
--- a/server/protocols/protocols-smtp/src/main/java/org/apache/james/smtpserver/SendMailHandler.java
+++ b/server/protocols/protocols-smtp/src/main/java/org/apache/james/smtpserver/SendMailHandler.java
@@ -54,7 +54,6 @@ public class SendMailHandler implements JamesMessageHook {
/**
* Adds header to the message
- *
*/
@Override
public HookResult onMessage(SMTPSession session, Mail mail) {
diff --git a/server/protocols/protocols-smtp/src/main/java/org/apache/james/smtpserver/jmx/HookStatsMBean.java b/server/protocols/protocols-smtp/src/main/java/org/apache/james/smtpserver/jmx/HookStatsMBean.java
index 87a147b..87ddc69 100644
--- a/server/protocols/protocols-smtp/src/main/java/org/apache/james/smtpserver/jmx/HookStatsMBean.java
+++ b/server/protocols/protocols-smtp/src/main/java/org/apache/james/smtpserver/jmx/HookStatsMBean.java
@@ -25,43 +25,31 @@ public interface HookStatsMBean {
/**
* Return the name of the Hook
- *
- * @return name
*/
String getName();
/**
* Return the count of how many OK the hook returned
- *
- * @return ok
*/
long getOk();
/**
* Return the count of how many DECLINED the hook returned
- *
- * @return declined
*/
long getDeclined();
/**
* Return the count of how many DENY the hook returned
- *
- * @return deny
*/
long getDeny();
/**
* Return the count of how many DENYSOFT the hook returned
- *
- * @return denysoft
*/
long getDenysoft();
/**
* Return the count of how many transaction this hook as processed
- *
- * @return all
*/
long getAll();
}
diff --git a/server/protocols/protocols-smtp/src/main/java/org/apache/james/smtpserver/jmx/SMTPCommandHandlerStatsMBean.java b/server/protocols/protocols-smtp/src/main/java/org/apache/james/smtpserver/jmx/SMTPCommandHandlerStatsMBean.java
index 6af16d2..4fc3daf 100644
--- a/server/protocols/protocols-smtp/src/main/java/org/apache/james/smtpserver/jmx/SMTPCommandHandlerStatsMBean.java
+++ b/server/protocols/protocols-smtp/src/main/java/org/apache/james/smtpserver/jmx/SMTPCommandHandlerStatsMBean.java
@@ -27,22 +27,16 @@ public interface SMTPCommandHandlerStatsMBean extends CommandHandlerStatsMBean {
/**
* Return the count of temporary errors returned by the handler
- *
- * @return tempCount
*/
long getTemporaryError();
/**
* Return the count of permanent errors returned by the handler
- *
- * @return permCount
*/
long getPermantError();
/**
* Return the count of successful handling returned by the handler
- *
- * @return tempCount
*/
long getOk();
diff --git a/server/protocols/protocols-smtp/src/main/java/org/apache/james/smtpserver/netty/OioSMTPServer.java b/server/protocols/protocols-smtp/src/main/java/org/apache/james/smtpserver/netty/OioSMTPServer.java
index b40ad5d..bb8a456 100644
--- a/server/protocols/protocols-smtp/src/main/java/org/apache/james/smtpserver/netty/OioSMTPServer.java
+++ b/server/protocols/protocols-smtp/src/main/java/org/apache/james/smtpserver/netty/OioSMTPServer.java
@@ -39,7 +39,6 @@ public class OioSMTPServer extends SMTPServer {
/**
* As OIO use one thread per connection we disable the use of the {@link ExecutionHandler}
- *
*/
@Override
protected ExecutionHandler createExecutionHander() {
diff --git a/server/protocols/protocols-smtp/src/main/java/org/apache/james/smtpserver/netty/SMTPChannelUpstreamHandler.java b/server/protocols/protocols-smtp/src/main/java/org/apache/james/smtpserver/netty/SMTPChannelUpstreamHandler.java
index 653b66d..6ad881d 100644
--- a/server/protocols/protocols-smtp/src/main/java/org/apache/james/smtpserver/netty/SMTPChannelUpstreamHandler.java
+++ b/server/protocols/protocols-smtp/src/main/java/org/apache/james/smtpserver/netty/SMTPChannelUpstreamHandler.java
@@ -69,8 +69,6 @@ public class SMTPChannelUpstreamHandler extends BasicChannelUpstreamHandler {
/**
* Cleanup temporary files
- *
- * @param ctx
*/
@Override
protected void cleanup(ChannelHandlerContext ctx) {
diff --git a/server/protocols/protocols-smtp/src/main/java/org/apache/james/smtpserver/netty/SMTPServer.java b/server/protocols/protocols-smtp/src/main/java/org/apache/james/smtpserver/netty/SMTPServer.java
index 3f11a02..cc5379a 100644
--- a/server/protocols/protocols-smtp/src/main/java/org/apache/james/smtpserver/netty/SMTPServer.java
+++ b/server/protocols/protocols-smtp/src/main/java/org/apache/james/smtpserver/netty/SMTPServer.java
@@ -195,8 +195,6 @@ public class SMTPServer extends AbstractProtocolAsyncServer implements SMTPServe
/**
* Return the default port which will get used for this server if non is
* specify in the configuration
- *
- * @return port
*/
@Override
protected int getDefaultPort() {
@@ -261,8 +259,6 @@ public class SMTPServer extends AbstractProtocolAsyncServer implements SMTPServe
/**
* Return true if the username and mail from must match for a authorized
* user
- *
- * @return verify
*/
public boolean verifyIdentity() {
return SMTPServer.this.verifyIdentity;
diff --git a/server/protocols/protocols-smtp/src/main/java/org/apache/james/smtpserver/netty/SMTPServerMBean.java b/server/protocols/protocols-smtp/src/main/java/org/apache/james/smtpserver/netty/SMTPServerMBean.java
index 3b6b17c..898d454 100644
--- a/server/protocols/protocols-smtp/src/main/java/org/apache/james/smtpserver/netty/SMTPServerMBean.java
+++ b/server/protocols/protocols-smtp/src/main/java/org/apache/james/smtpserver/netty/SMTPServerMBean.java
@@ -27,16 +27,12 @@ public interface SMTPServerMBean extends org.apache.james.protocols.smtp.SMTPSer
/**
* Return the maximum allowed size of the message
- *
- * @return maxMessageSize
*/
long getMaximalMessageSize();
/**
* Set the maximum allowed size of messages. Set this to 0 to accept every
* message
- *
- * @param maxSize
*/
void setMaximalMessageSize(long maxSize);
@@ -51,8 +47,6 @@ public interface SMTPServerMBean extends org.apache.james.protocols.smtp.SMTPSer
/**
* Enable or disable brackets enforcement around addressed in the MAIL and
* RCPT command
- *
- * @param enforceAddressBrackets
*/
void setAddressBracketsEnforcement(boolean enforceAddressBrackets);
@@ -65,15 +59,11 @@ public interface SMTPServerMBean extends org.apache.james.protocols.smtp.SMTPSer
/**
* Enable or disable the need of the HELO/EHLO
- *
- * @param enforceHeloEHlo
*/
void setHeloEhloEnforcement(boolean enforceHeloEHlo);
/**
* Return the hello name
- *
- * @return helo
*/
String getHeloName();
}
---------------------------------------------------------------------
To unsubscribe, e-mail: server-dev-unsubscribe@james.apache.org
For additional commands, e-mail: server-dev-help@james.apache.org