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 9289963f3c8b856586d57dcc1062dbeced1c7082 Author: Benoit Tellier <[email protected]> AuthorDate: Thu Nov 7 12:01:15 2019 +0700 [REFACTORING] Clean protocols-smtp javadoc - Solve IntellijJ warnings related to javaDoc - Remove verbose, meaningless entries --- .../org/apache/james/protocols/smtp/MailEnvelope.java | 17 +---------------- .../apache/james/protocols/smtp/MailEnvelopeImpl.java | 6 ------ .../james/protocols/smtp/SMTPConfigurationImpl.java | 2 -- .../org/apache/james/protocols/smtp/SMTPProtocol.java | 2 -- .../james/protocols/smtp/SMTPProtocolHandlerChain.java | 4 ---- .../org/apache/james/protocols/smtp/SMTPResponse.java | 8 +------- .../apache/james/protocols/smtp/SMTPServerMBean.java | 7 ++----- .../org/apache/james/protocols/smtp/SMTPSession.java | 2 -- .../james/protocols/smtp/SMTPStartTlsResponse.java | 2 -- .../protocols/smtp/core/AbstractAddHeadersFilter.java | 11 ++--------- .../smtp/core/AbstractAuthRequiredToRelayRcptHook.java | 3 +-- .../protocols/smtp/core/AbstractHookableCmdHandler.java | 1 - .../AbstractSenderAuthIdentifyVerificationRcptHook.java | 3 +-- .../james/protocols/smtp/core/DataCmdHandler.java | 1 - .../james/protocols/smtp/core/DataLineFilter.java | 4 ---- .../protocols/smtp/core/DataLineMessageHookHandler.java | 6 +----- .../james/protocols/smtp/core/ExpnCmdHandler.java | 1 - .../james/protocols/smtp/core/HelpCmdHandler.java | 1 - .../james/protocols/smtp/core/NoopCmdHandler.java | 1 - .../protocols/smtp/core/ReceivedDataLineFilter.java | 4 ---- .../james/protocols/smtp/core/RsetCmdHandler.java | 1 - .../james/protocols/smtp/core/VrfyCmdHandler.java | 1 - .../james/protocols/smtp/core/esmtp/AuthCmdHandler.java | 13 ++----------- .../smtp/core/fastfail/AbstractGreylistHandler.java | 9 +-------- .../protocols/smtp/core/fastfail/DNSRBLHandler.java | 6 ++---- .../smtp/core/fastfail/ValidSenderDomainHandler.java | 3 +-- .../james/protocols/smtp/core/log/HookResultLogger.java | 2 -- .../org/apache/james/protocols/smtp/hook/HeloHook.java | 4 ---- .../java/org/apache/james/protocols/smtp/hook/Hook.java | 2 -- .../apache/james/protocols/smtp/hook/SimpleHook.java | 2 -- .../apache/james/protocols/smtp/hook/UnknownHook.java | 4 ---- 31 files changed, 15 insertions(+), 118 deletions(-) diff --git a/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/MailEnvelope.java b/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/MailEnvelope.java index 915dd2f..1c38e75 100644 --- a/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/MailEnvelope.java +++ b/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/MailEnvelope.java @@ -29,23 +29,16 @@ import org.apache.james.core.MaybeSender; /** * The MailEnvelope of a SMTP-Transaction - * - * */ public interface MailEnvelope { /** - * Return the size of the message. If the message is "empty" it will return - * -1 - * - * @return size + * Return the size of the message. If the message is "empty" it will return -1 */ long getSize(); /** * Return the recipients which where supplied in the RCPT TO: command - * - * @return recipients */ List<MailAddress> getRecipients(); @@ -57,8 +50,6 @@ public interface MailEnvelope { * * Note that SMTP null sender ( "<>" ) needs to be implicitly handled by the caller under the form of 'null' or * {@link MailAddress#nullSender()}. Replacement method adds type safety on this operation. - * - * @return sender */ @Deprecated default MailAddress getSender() { @@ -82,17 +73,11 @@ public interface MailEnvelope { * Return the OutputStream of the message * * TODO: Think about how to remove this! - * - * @return out - * @throws IOException */ OutputStream getMessageOutputStream() throws IOException; /** * Return the InputStream of the message - * - * @return in - * @throws IOException */ InputStream getMessageInputStream() throws IOException; } diff --git a/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/MailEnvelopeImpl.java b/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/MailEnvelopeImpl.java index 2f51d58..a7c3850 100644 --- a/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/MailEnvelopeImpl.java +++ b/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/MailEnvelopeImpl.java @@ -31,8 +31,6 @@ import org.apache.james.core.MaybeSender; /** * MailEnvelope implementation which stores everything in memory - * - * */ public class MailEnvelopeImpl implements MailEnvelope { @@ -62,8 +60,6 @@ public class MailEnvelopeImpl implements MailEnvelope { /** * Set the recipients of the mail - * - * @param recipientCollection */ public void setRecipients(List<MailAddress> recipientCollection) { this.recipients = recipientCollection; @@ -71,8 +67,6 @@ public class MailEnvelopeImpl implements MailEnvelope { /** * Set the sender of the mail - * - * @param sender */ public void setSender(MaybeSender sender) { this.sender = sender; diff --git a/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/SMTPConfigurationImpl.java b/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/SMTPConfigurationImpl.java index 1e278a6..f16aa29 100644 --- a/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/SMTPConfigurationImpl.java +++ b/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/SMTPConfigurationImpl.java @@ -22,11 +22,9 @@ package org.apache.james.protocols.smtp; import org.apache.james.protocols.api.ProtocolConfigurationImpl; - /** * {@link SMTPConfiguration} implementation which allows to set and get various configuration params. The set and get methods * are not thread-safe - * */ public class SMTPConfigurationImpl extends ProtocolConfigurationImpl implements SMTPConfiguration { diff --git a/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/SMTPProtocol.java b/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/SMTPProtocol.java index cef7e4a..784db50 100644 --- a/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/SMTPProtocol.java +++ b/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/SMTPProtocol.java @@ -26,8 +26,6 @@ import org.apache.james.protocols.api.handler.ProtocolHandlerChain; /** * {@link ProtocolImpl} which creates {@link SMTPSessionImpl} instances - * - * */ public class SMTPProtocol extends ProtocolImpl { diff --git a/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/SMTPProtocolHandlerChain.java b/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/SMTPProtocolHandlerChain.java index 6c869c2..098d1a9 100644 --- a/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/SMTPProtocolHandlerChain.java +++ b/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/SMTPProtocolHandlerChain.java @@ -56,7 +56,6 @@ import org.apache.james.protocols.smtp.hook.Hook; * This {@link ProtocolHandlerChain} implementation add all needed handlers to * the chain to act as full blown SMTPServer. By default messages will just get * rejected after the DATA command. - * */ public class SMTPProtocolHandlerChain extends ProtocolHandlerChainImpl { @@ -76,9 +75,6 @@ public class SMTPProtocolHandlerChain extends ProtocolHandlerChainImpl { /** * Add all default handlers to the chain and the given {@link Hook}'s. After that {@link #wireExtensibleHandlers()} is called - * - * @param hooks - * @throws WiringException */ public SMTPProtocolHandlerChain(MetricFactory metricFactory, Hook... hooks) throws WiringException { this(metricFactory, true); diff --git a/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/SMTPResponse.java b/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/SMTPResponse.java index a9b3f08..8c5f2b2 100644 --- a/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/SMTPResponse.java +++ b/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/SMTPResponse.java @@ -43,13 +43,7 @@ public class SMTPResponse extends AbstractResponse { public SMTPResponse(String code, CharSequence description) { super(code, description); } - - /** - * Construct a new SMTPResponse. The given rawLine need to be in format [SMTPResponseReturnCode SMTResponseDescription]. - * If this is not the case an IllegalArgumentException get thrown. - * - * @param rawLine the raw SMTPResponse - */ + /** * Construct a new SMTPResponse. The given rawLine need to be in format [SMTPResponseReturnCode SMTResponseDescription]. * If this is not the case an IllegalArgumentException get thrown. diff --git a/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/SMTPServerMBean.java b/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/SMTPServerMBean.java index ab60d0c..f6687ac 100644 --- a/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/SMTPServerMBean.java +++ b/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/SMTPServerMBean.java @@ -17,13 +17,10 @@ * under the License. * ****************************************************************/ - - package org.apache.james.protocols.smtp; /** * An interface to expose James management functionality through JMX. - * */ public interface SMTPServerMBean { /** @@ -36,7 +33,7 @@ public interface SMTPServerMBean { /** * Returns the server socket type, plain or SSL * - * @return String The scoekt type, plain or SSL + * @return String The socket type, plain or SSL */ - String getSocketType(); + String getSocketType(); } diff --git a/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/SMTPSession.java b/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/SMTPSession.java index 21bda43..02c84c2 100644 --- a/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/SMTPSession.java +++ b/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/SMTPSession.java @@ -61,8 +61,6 @@ public interface SMTPSession extends ProtocolSession { /** * Set if reallying is allowed - * - * @param relayingAllowed */ void setRelayingAllowed(boolean relayingAllowed); diff --git a/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/SMTPStartTlsResponse.java b/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/SMTPStartTlsResponse.java index 5c0da2a..e42e787 100644 --- a/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/SMTPStartTlsResponse.java +++ b/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/SMTPStartTlsResponse.java @@ -27,8 +27,6 @@ import org.apache.james.protocols.api.StartTlsResponse; /** * This {@link SMTPResponse} should only be used once you want to start tls after the {@link SMTPResponse} was written to the client - * - * */ public class SMTPStartTlsResponse extends SMTPResponse implements StartTlsResponse { diff --git a/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/core/AbstractAddHeadersFilter.java b/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/core/AbstractAddHeadersFilter.java index 5fb1a7e..9c29ffd 100644 --- a/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/core/AbstractAddHeadersFilter.java +++ b/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/core/AbstractAddHeadersFilter.java @@ -75,10 +75,7 @@ public abstract class AbstractAddHeadersFilter extends SeparatingDataLineFilter /** * Add headers to the message - * - * @param session - * @param line - * @param next + * * @return response */ private Response addHeaders(SMTPSession session, ByteBuffer line, LineHandler<SMTPSession> next) { @@ -112,8 +109,6 @@ public abstract class AbstractAddHeadersFilter extends SeparatingDataLineFilter /** * Add the value to the header - * @param value - * @return */ public Header add(String value) { values.add(value); @@ -126,9 +121,7 @@ public abstract class AbstractAddHeadersFilter extends SeparatingDataLineFilter * * This is done for each line of the {@link Header} until the end is reached or the {@link LineHandler#onLine(org.apache.james.protocols.api.ProtocolSession, ByteBuffer)} * return <code>non-null</code> - * - * @param session - * @param handler + * * @return response */ public Response transferTo(SMTPSession session, LineHandler<SMTPSession> handler) { diff --git a/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/core/AbstractAuthRequiredToRelayRcptHook.java b/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/core/AbstractAuthRequiredToRelayRcptHook.java index 43fc8c8..2911e6a 100644 --- a/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/core/AbstractAuthRequiredToRelayRcptHook.java +++ b/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/core/AbstractAuthRequiredToRelayRcptHook.java @@ -67,8 +67,7 @@ public abstract class AbstractAuthRequiredToRelayRcptHook implements RcptHook { /** * Return true if the given domain is a local domain for this server - * - * @param domain + * * @return isLocal */ protected abstract boolean isLocalDomain(Domain domain); diff --git a/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/core/AbstractHookableCmdHandler.java b/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/core/AbstractHookableCmdHandler.java index 0d392e2..f938018 100644 --- a/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/core/AbstractHookableCmdHandler.java +++ b/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/core/AbstractHookableCmdHandler.java @@ -47,7 +47,6 @@ import org.slf4j.LoggerFactory; /** * Abstract class which Handle hook-aware CommanHandler. - * */ public abstract class AbstractHookableCmdHandler<HookT extends org.apache.james.protocols.smtp.hook.Hook> implements CommandHandler<SMTPSession>, ExtensibleHandler { private static final Logger LOGGER = LoggerFactory.getLogger(AbstractHookableCmdHandler.class); diff --git a/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/core/AbstractSenderAuthIdentifyVerificationRcptHook.java b/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/core/AbstractSenderAuthIdentifyVerificationRcptHook.java index 4a60cfc..8351806 100644 --- a/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/core/AbstractSenderAuthIdentifyVerificationRcptHook.java +++ b/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/core/AbstractSenderAuthIdentifyVerificationRcptHook.java @@ -79,8 +79,7 @@ public abstract class AbstractSenderAuthIdentifyVerificationRcptHook implements /** * Return true if the given domain is a local domain for this server - * - * @param domain + * * @return isLocal */ protected abstract boolean isLocalDomain(Domain domain); diff --git a/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/core/DataCmdHandler.java b/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/core/DataCmdHandler.java index 2aa7f05..8bebea0 100644 --- a/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/core/DataCmdHandler.java +++ b/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/core/DataCmdHandler.java @@ -125,7 +125,6 @@ public class DataCmdHandler implements CommandHandler<SMTPSession>, ExtensibleHa /** * process DATA command - * */ @Override public Response onCommand(SMTPSession session, Request request) { diff --git a/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/core/DataLineFilter.java b/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/core/DataLineFilter.java index d1804db..acec85e 100644 --- a/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/core/DataLineFilter.java +++ b/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/core/DataLineFilter.java @@ -36,10 +36,6 @@ public interface DataLineFilter extends ProtocolHandler { /** * Handle line processing - * - * @param session - * @param line - * @param next */ Response onLine(SMTPSession session, ByteBuffer line, LineHandler<SMTPSession> next); } \ No newline at end of file diff --git a/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/core/DataLineMessageHookHandler.java b/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/core/DataLineMessageHookHandler.java index d2e7711..cc645ea 100644 --- a/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/core/DataLineMessageHookHandler.java +++ b/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/core/DataLineMessageHookHandler.java @@ -45,8 +45,7 @@ import org.slf4j.LoggerFactory; /** * This class handles the actual calling of the {@link MessageHook} implementations to queue the message. If no {@link MessageHook} return OK or DECLINED it will write back an - * error to the client to report the problem while trying to queue the message - * + * error to the client to report the problem while trying to queue the message */ public class DataLineMessageHookHandler implements DataLineFilter, ExtensibleHandler { private static final Logger LOGGER = LoggerFactory.getLogger(DataLineMessageHookHandler.class); @@ -108,9 +107,6 @@ public class DataLineMessageHookHandler implements DataLineFilter, ExtensibleHan return bline; } - /** - * @param session - */ protected Response processExtensions(SMTPSession session, MailEnvelopeImpl mail) { diff --git a/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/core/ExpnCmdHandler.java b/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/core/ExpnCmdHandler.java index 604b1c0..4e8e6e1 100644 --- a/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/core/ExpnCmdHandler.java +++ b/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/core/ExpnCmdHandler.java @@ -48,7 +48,6 @@ public class ExpnCmdHandler implements CommandHandler<SMTPSession> { * Handler method called upon receipt of a EXPN command. * This method informs the client that the command is * not implemented. - * */ @Override public Response onCommand(SMTPSession session, Request request) { diff --git a/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/core/HelpCmdHandler.java b/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/core/HelpCmdHandler.java index 9fb5530..cac6a3e 100644 --- a/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/core/HelpCmdHandler.java +++ b/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/core/HelpCmdHandler.java @@ -44,7 +44,6 @@ public class HelpCmdHandler implements CommandHandler<SMTPSession> { /** * handles HELP command - * **/ @Override public Response onCommand(SMTPSession session, Request request) { diff --git a/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/core/NoopCmdHandler.java b/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/core/NoopCmdHandler.java index 5b7e47d..72dba30 100644 --- a/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/core/NoopCmdHandler.java +++ b/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/core/NoopCmdHandler.java @@ -48,7 +48,6 @@ public class NoopCmdHandler implements CommandHandler<SMTPSession> { /** * Handler method called upon receipt of a NOOP command. * Just sends back an OK and logs the command. - * */ @Override public Response onCommand(SMTPSession session, Request request) { diff --git a/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/core/ReceivedDataLineFilter.java b/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/core/ReceivedDataLineFilter.java index fe06546..c0f19f9 100644 --- a/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/core/ReceivedDataLineFilter.java +++ b/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/core/ReceivedDataLineFilter.java @@ -46,10 +46,6 @@ public class ReceivedDataLineFilter extends AbstractAddHeadersFilter { /** * Return the service type which will be used in the Received headers. - * - * @param session - * @param heloMode - * @return type */ protected String getServiceType(SMTPSession session, String heloMode) { // Check if EHLO was used diff --git a/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/core/RsetCmdHandler.java b/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/core/RsetCmdHandler.java index 8b0edf3..21ddf1f 100644 --- a/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/core/RsetCmdHandler.java +++ b/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/core/RsetCmdHandler.java @@ -54,7 +54,6 @@ public class RsetCmdHandler implements CommandHandler<SMTPSession> { * * @param session SMTP session object * @param argument the argument passed in with the command by the SMTP client - * @return */ private Response doRSET(SMTPSession session, String argument) { if ((argument == null) || (argument.length() == 0)) { diff --git a/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/core/VrfyCmdHandler.java b/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/core/VrfyCmdHandler.java index ab42862..83e2994 100644 --- a/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/core/VrfyCmdHandler.java +++ b/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/core/VrfyCmdHandler.java @@ -44,7 +44,6 @@ public class VrfyCmdHandler implements CommandHandler<SMTPSession> { * Handler method called upon receipt of a VRFY command. * This method informs the client that the command is * not implemented. - * */ @Override public Response onCommand(SMTPSession session, Request request) { diff --git a/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/core/esmtp/AuthCmdHandler.java b/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/core/esmtp/AuthCmdHandler.java index a62abd9..84e0b57 100644 --- a/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/core/esmtp/AuthCmdHandler.java +++ b/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/core/esmtp/AuthCmdHandler.java @@ -213,7 +213,7 @@ public class AuthCmdHandler * Decoded: test\000test\000tEst42 * * @param session SMTP session object - * @param initialResponse the initial response line passed in with the AUTH command + * @param line the initial response line passed in with the AUTH command */ private Response doPlainAuthPass(SMTPSession session, String line) { String user = null; @@ -286,7 +286,7 @@ public class AuthCmdHandler * Carries out the Login AUTH SASL exchange. * * @param session SMTP session object - * @param initialResponse the initial response line passed in with the AUTH command + * @param user the user passed in with the AUTH command */ private Response doLoginAuthPass(SMTPSession session, String user) { if (user != null) { @@ -335,15 +335,6 @@ public class AuthCmdHandler return doAuthTest(session, user, pass, "LOGIN"); } - - - /** - * @param session - * @param user - * @param pass - * @param authType - * @return - */ protected Response doAuthTest(SMTPSession session, String user, String pass, String authType) { if ((user == null) || (pass == null)) { return new SMTPResponse(SMTPRetCode.SYNTAX_ERROR_ARGUMENTS,"Could not decode parameters for AUTH " + authType); diff --git a/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/core/fastfail/AbstractGreylistHandler.java b/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/core/fastfail/AbstractGreylistHandler.java index 2095f3d..a320dfd 100644 --- a/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/core/fastfail/AbstractGreylistHandler.java +++ b/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/core/fastfail/AbstractGreylistHandler.java @@ -34,11 +34,8 @@ import org.apache.james.protocols.smtp.hook.RcptHook; import org.slf4j.Logger; import org.slf4j.LoggerFactory; - /** - * Abstract base class which implement GreyListing. - * - * + * Abstract base class which implement GreyListing. */ public abstract class AbstractGreylistHandler implements RcptHook { private static final Logger LOGGER = LoggerFactory.getLogger(AbstractGreylistHandler.class); @@ -152,7 +149,6 @@ public abstract class AbstractGreylistHandler implements RcptHook { * The rcptTo * @return data * The data - * @throws Exception */ protected abstract Iterator<String> getGreyListData(String ipAddress, String sender, String recip) throws Exception; @@ -187,7 +183,6 @@ public abstract class AbstractGreylistHandler implements RcptHook { * The count * @param time * the current time in ms - * @throws Exception */ protected abstract void updateTriplet(String ipAddress, String sender, String recip, int count, Instant time) throws Exception; @@ -197,7 +192,6 @@ public abstract class AbstractGreylistHandler implements RcptHook { * * @param time * The time which must be reached before delete the records - * @throws Exception */ protected abstract void cleanupAutoWhiteListGreyList(Instant time)throws Exception; @@ -206,7 +200,6 @@ public abstract class AbstractGreylistHandler implements RcptHook { * * @param time * The time which must be reached before delete the records - * @throws Exception */ protected abstract void cleanupGreyList(Instant time) throws Exception; diff --git a/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/core/fastfail/DNSRBLHandler.java b/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/core/fastfail/DNSRBLHandler.java index dc90d37..2439de8 100644 --- a/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/core/fastfail/DNSRBLHandler.java +++ b/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/core/fastfail/DNSRBLHandler.java @@ -198,8 +198,7 @@ public class DNSRBLHandler implements RcptHook { * Check if the given ipaddress is resolvable. * * This implementation use {@link InetAddress#getByName(String)}. Sub-classes may override this with a more performant solution - * - * @param ip + * * @return canResolve */ protected boolean resolve(String ip) { @@ -215,8 +214,7 @@ public class DNSRBLHandler implements RcptHook { * Return a {@link Collection} which holds all TXT records for the ip. This is most times used to add details for a RBL entry. * * This implementation always returns an empty {@link Collection}. Sub-classes may override this. - * - * @param ip + * * @return txtRecords */ protected Collection<String> resolveTXTRecords(String ip) { diff --git a/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/core/fastfail/ValidSenderDomainHandler.java b/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/core/fastfail/ValidSenderDomainHandler.java index efb0384..c3649bb 100644 --- a/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/core/fastfail/ValidSenderDomainHandler.java +++ b/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/core/fastfail/ValidSenderDomainHandler.java @@ -27,8 +27,7 @@ import org.apache.james.protocols.smtp.hook.HookReturnCode; import org.apache.james.protocols.smtp.hook.MailHook; /** - * Add MFDNSCheck feature to SMTPServer. This handler reject mail from domains which have not an an valid MX record. - * + * Add MFDNSCheck feature to SMTPServer. This handler reject mail from domains which have not an an valid MX record. */ public abstract class ValidSenderDomainHandler implements MailHook { diff --git a/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/core/log/HookResultLogger.java b/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/core/log/HookResultLogger.java index 8253e63..726e9cc 100644 --- a/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/core/log/HookResultLogger.java +++ b/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/core/log/HookResultLogger.java @@ -27,10 +27,8 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** - * * Log the {@link HookResult}. If {@link HookReturnCode.Action#DENY}, {@link HookReturnCode.Action#DENYSOFT} or {@link HookReturnCode#isDisconnected()} was used it will get * logged to INFO. If not to DEBUG - * */ public class HookResultLogger implements HookResultHook { private static final Logger LOGGER = LoggerFactory.getLogger(HookResultLogger.class); diff --git a/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/hook/HeloHook.java b/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/hook/HeloHook.java index 716a0e1..f792a40 100644 --- a/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/hook/HeloHook.java +++ b/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/hook/HeloHook.java @@ -17,16 +17,12 @@ * under the License. * ****************************************************************/ - - - package org.apache.james.protocols.smtp.hook; import org.apache.james.protocols.smtp.SMTPSession; /** * Implement this interfaces to hook in the HELO Command - * */ public interface HeloHook extends Hook { diff --git a/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/hook/Hook.java b/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/hook/Hook.java index 6e60f8b..995b12a 100644 --- a/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/hook/Hook.java +++ b/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/hook/Hook.java @@ -22,8 +22,6 @@ import org.apache.james.protocols.api.handler.ProtocolHandler; /** * Just and marker interface for the different Hooks - * - * */ public interface Hook extends ProtocolHandler{ diff --git a/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/hook/SimpleHook.java b/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/hook/SimpleHook.java index 50a3371..e73d2be 100644 --- a/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/hook/SimpleHook.java +++ b/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/hook/SimpleHook.java @@ -24,12 +24,10 @@ import org.apache.james.core.MaybeSender; import org.apache.james.protocols.smtp.MailEnvelope; import org.apache.james.protocols.smtp.SMTPSession; - /** * Simple {@link Hook} implementation which can be used as base class when writing simple {@link Hook}'s * * The SMTP-Server will just accept email with this {@link Hook} in place and discard it - * */ public class SimpleHook implements HeloHook, MailHook, RcptHook, MessageHook { diff --git a/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/hook/UnknownHook.java b/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/hook/UnknownHook.java index 91820fc..2505e20 100644 --- a/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/hook/UnknownHook.java +++ b/protocols/smtp/src/main/java/org/apache/james/protocols/smtp/hook/UnknownHook.java @@ -22,16 +22,12 @@ import org.apache.james.protocols.smtp.SMTPSession; /** * Hook for unknown commands - * - * */ public interface UnknownHook extends Hook { /** * Called on unknown smtp command * - * @param session - * @param command * @return result */ HookResult doUnknown(SMTPSession session, String command); --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
