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 c398e35c5b6e8ac79f5875bddba614796c41974e Author: Benoit Tellier <[email protected]> AuthorDate: Sun Nov 17 15:10:46 2019 +0700 [Refactoring] Clean mailetcontainer-camel javadoc --- .../impl/camel/CamelMailetProcessor.java | 2 -- .../mailetcontainer/impl/camel/CamelProcessor.java | 6 ---- .../impl/camel/MatcherSplitter.java | 1 - .../jmx/JMXStateCompositeProcessorListener.java | 9 ------ .../impl/jmx/JMXStateMailetProcessorListener.java | 15 ---------- .../impl/jmx/MailProcessorManagement.java | 3 -- .../james/mailetcontainer/impl/matchers/Not.java | 6 ++-- .../james/mailetcontainer/impl/matchers/Or.java | 7 ++--- .../james/mailetcontainer/impl/matchers/Xor.java | 7 ++--- .../lib/AbstractStateCompositeProcessor.java | 13 -------- .../lib/AbstractStateMailetProcessor.java | 35 ++-------------------- 11 files changed, 12 insertions(+), 92 deletions(-) diff --git a/server/mailet/mailetcontainer-camel/src/main/java/org/apache/james/mailetcontainer/impl/camel/CamelMailetProcessor.java b/server/mailet/mailetcontainer-camel/src/main/java/org/apache/james/mailetcontainer/impl/camel/CamelMailetProcessor.java index 16c0dab..2d221d8 100644 --- a/server/mailet/mailetcontainer-camel/src/main/java/org/apache/james/mailetcontainer/impl/camel/CamelMailetProcessor.java +++ b/server/mailet/mailetcontainer-camel/src/main/java/org/apache/james/mailetcontainer/impl/camel/CamelMailetProcessor.java @@ -90,8 +90,6 @@ public class CamelMailetProcessor extends AbstractStateMailetProcessor implement * Return the endpoint for the processorname. * * This will return a "direct" endpoint. - * - * @return endPoint */ protected String getEndpoint() { return "direct:processor." + getState(); diff --git a/server/mailet/mailetcontainer-camel/src/main/java/org/apache/james/mailetcontainer/impl/camel/CamelProcessor.java b/server/mailet/mailetcontainer-camel/src/main/java/org/apache/james/mailetcontainer/impl/camel/CamelProcessor.java index 779545c..346e738 100644 --- a/server/mailet/mailetcontainer-camel/src/main/java/org/apache/james/mailetcontainer/impl/camel/CamelProcessor.java +++ b/server/mailet/mailetcontainer-camel/src/main/java/org/apache/james/mailetcontainer/impl/camel/CamelProcessor.java @@ -47,12 +47,6 @@ public class CamelProcessor { private final Mailet mailet; private final CamelMailetProcessor processor; - /** - * Mailet to call on process - * @param metricFactory - * @param processor - * @param mailet - */ public CamelProcessor(MetricFactory metricFactory, CamelMailetProcessor processor, Mailet mailet) { this.metricFactory = metricFactory; this.processor = processor; diff --git a/server/mailet/mailetcontainer-camel/src/main/java/org/apache/james/mailetcontainer/impl/camel/MatcherSplitter.java b/server/mailet/mailetcontainer-camel/src/main/java/org/apache/james/mailetcontainer/impl/camel/MatcherSplitter.java index 03fe79a..044dcf2 100644 --- a/server/mailet/mailetcontainer-camel/src/main/java/org/apache/james/mailetcontainer/impl/camel/MatcherSplitter.java +++ b/server/mailet/mailetcontainer-camel/src/main/java/org/apache/james/mailetcontainer/impl/camel/MatcherSplitter.java @@ -82,7 +82,6 @@ public class MatcherSplitter { * @param mail * Mail which is stored in the @Body of the MailMessage * @return mailMessageList - * @throws MessagingException */ @Handler public List<Mail> split(@Body Mail mail) throws MessagingException { diff --git a/server/mailet/mailetcontainer-camel/src/main/java/org/apache/james/mailetcontainer/impl/jmx/JMXStateCompositeProcessorListener.java b/server/mailet/mailetcontainer-camel/src/main/java/org/apache/james/mailetcontainer/impl/jmx/JMXStateCompositeProcessorListener.java index 098cbe3..c3789b5 100644 --- a/server/mailet/mailetcontainer-camel/src/main/java/org/apache/james/mailetcontainer/impl/jmx/JMXStateCompositeProcessorListener.java +++ b/server/mailet/mailetcontainer-camel/src/main/java/org/apache/james/mailetcontainer/impl/jmx/JMXStateCompositeProcessorListener.java @@ -27,7 +27,6 @@ import java.util.Map; import javax.mail.MessagingException; import javax.management.JMException; import javax.management.MBeanServer; -import javax.management.MalformedObjectNameException; import javax.management.ObjectName; import org.apache.james.lifecycle.api.Disposable; @@ -71,9 +70,6 @@ public class JMXStateCompositeProcessorListener implements CompositeProcessorLis /** * Register all JMX MBeans - * - * @throws JMException - * @throws MalformedObjectNameException */ private void registerMBeans() throws JMException { @@ -87,11 +83,6 @@ public class JMXStateCompositeProcessorListener implements CompositeProcessorLis /** * Register a JMX MBean for a {@link MailProcessor} - * - * @param baseObjectName - * @param processorName - * @throws JMException - * @throws MalformedObjectNameException */ private void registerProcessorMBean(String baseObjectName, String processorName) throws JMException { String processorMBeanName = baseObjectName + "processor=" + processorName; diff --git a/server/mailet/mailetcontainer-camel/src/main/java/org/apache/james/mailetcontainer/impl/jmx/JMXStateMailetProcessorListener.java b/server/mailet/mailetcontainer-camel/src/main/java/org/apache/james/mailetcontainer/impl/jmx/JMXStateMailetProcessorListener.java index 4a07dba..38fe438 100644 --- a/server/mailet/mailetcontainer-camel/src/main/java/org/apache/james/mailetcontainer/impl/jmx/JMXStateMailetProcessorListener.java +++ b/server/mailet/mailetcontainer-camel/src/main/java/org/apache/james/mailetcontainer/impl/jmx/JMXStateMailetProcessorListener.java @@ -28,7 +28,6 @@ import java.util.Map; import javax.management.JMException; import javax.management.MBeanServer; -import javax.management.MalformedObjectNameException; import javax.management.ObjectName; import org.apache.james.core.MailAddress; @@ -84,9 +83,6 @@ public class JMXStateMailetProcessorListener implements MailetProcessorListener, /** * Register all JMX MBeans - * - * @throws JMException - * @throws MalformedObjectNameException */ private void registerMBeans() throws JMException { String baseObjectName = "org.apache.james:type=component,component=mailetcontainer,name=processor,processor=" + name; @@ -97,11 +93,6 @@ public class JMXStateMailetProcessorListener implements MailetProcessorListener, /** * Register the Mailets as JMX MBeans - * - * @param parentMBeanName - * @param mailets - * @throws JMException - * @throws MalformedObjectNameException */ private void registerMailets(String parentMBeanName, Iterator<Mailet> mailets) throws JMException { int i = 0; @@ -118,12 +109,6 @@ public class JMXStateMailetProcessorListener implements MailetProcessorListener, /** * Register the {@link Matcher}'s as JMX MBeans - * - * @param parentMBeanName - * @param matchers - * @param nestingLevel - * @throws JMException - * @throws MalformedObjectNameException */ private void registerMatchers(String parentMBeanName, Iterator<Matcher> matchers, int nestingLevel) throws JMException { int i = 0; diff --git a/server/mailet/mailetcontainer-camel/src/main/java/org/apache/james/mailetcontainer/impl/jmx/MailProcessorManagement.java b/server/mailet/mailetcontainer-camel/src/main/java/org/apache/james/mailetcontainer/impl/jmx/MailProcessorManagement.java index 4e3f567..5719653 100644 --- a/server/mailet/mailetcontainer-camel/src/main/java/org/apache/james/mailetcontainer/impl/jmx/MailProcessorManagement.java +++ b/server/mailet/mailetcontainer-camel/src/main/java/org/apache/james/mailetcontainer/impl/jmx/MailProcessorManagement.java @@ -46,9 +46,6 @@ public class MailProcessorManagement extends StandardMBean implements MailProces /** * Update the stats - * - * @param processTime - * @param success */ public void update(long processTime, boolean success) { long fastest = fastestProcessing.get(); diff --git a/server/mailet/mailetcontainer-camel/src/main/java/org/apache/james/mailetcontainer/impl/matchers/Not.java b/server/mailet/mailetcontainer-camel/src/main/java/org/apache/james/mailetcontainer/impl/matchers/Not.java index d39be52..245b23f 100644 --- a/server/mailet/mailetcontainer-camel/src/main/java/org/apache/james/mailetcontainer/impl/matchers/Not.java +++ b/server/mailet/mailetcontainer-camel/src/main/java/org/apache/james/mailetcontainer/impl/matchers/Not.java @@ -36,12 +36,12 @@ import com.google.common.collect.Lists; * of each child matcher. Of course it is easier to understand if it only * includes one matcher in the composition, the normal recommended use. @See * CompositeMatcher interface. - * - * @return Collection of Recipients from the Negated composition of the child - * Matcher(s). */ public class Not extends GenericCompositeMatcher { + /** + * @return Collection of Recipients from the Negated composition of the child Matcher(s). + */ @Override public Collection<MailAddress> match(Mail mail) throws MessagingException { Collection<MailAddress> finalResult = Optional.ofNullable(Lists.newArrayList(mail.getRecipients())).orElse(new ArrayList<>()); diff --git a/server/mailet/mailetcontainer-camel/src/main/java/org/apache/james/mailetcontainer/impl/matchers/Or.java b/server/mailet/mailetcontainer-camel/src/main/java/org/apache/james/mailetcontainer/impl/matchers/Or.java index 8321dc8..36f5a9e 100644 --- a/server/mailet/mailetcontainer-camel/src/main/java/org/apache/james/mailetcontainer/impl/matchers/Or.java +++ b/server/mailet/mailetcontainer-camel/src/main/java/org/apache/james/mailetcontainer/impl/matchers/Or.java @@ -31,12 +31,11 @@ import org.apache.mailet.Matcher; /** * This is the Or CompositeMatcher - consider it to be a union of the * results. - * - * @return Collection of Recipients from the Or composition results of the - * child matchers. */ public class Or extends GenericCompositeMatcher { - + /** + * @return Collection of Recipients from the Or composition results of the child matchers. + */ @Override public Collection<MailAddress> match(Mail mail) throws MessagingException { HashSet<MailAddress> result = new HashSet<>(); diff --git a/server/mailet/mailetcontainer-camel/src/main/java/org/apache/james/mailetcontainer/impl/matchers/Xor.java b/server/mailet/mailetcontainer-camel/src/main/java/org/apache/james/mailetcontainer/impl/matchers/Xor.java index 3170b43..d2ba03d 100644 --- a/server/mailet/mailetcontainer-camel/src/main/java/org/apache/james/mailetcontainer/impl/matchers/Xor.java +++ b/server/mailet/mailetcontainer-camel/src/main/java/org/apache/james/mailetcontainer/impl/matchers/Xor.java @@ -36,12 +36,11 @@ import com.google.common.collect.Sets; * This is the Xor CompositeMatcher - consider it to be the inequality * operator for recipients. If any recipients match other matcher results * then the result does not include that recipient. - * - * @return Collection of Recipients from the Xor composition of the child - * matchers. */ public class Xor extends GenericCompositeMatcher { - + /** + * @return Collection of Recipients from the Xor composition of the child matchers. + */ @Override public Collection<MailAddress> match(Mail mail) throws MessagingException { Collection<MailAddress> finalResult = null; diff --git a/server/mailet/mailetcontainer-camel/src/main/java/org/apache/james/mailetcontainer/lib/AbstractStateCompositeProcessor.java b/server/mailet/mailetcontainer-camel/src/main/java/org/apache/james/mailetcontainer/lib/AbstractStateCompositeProcessor.java index b7a5bd9..0aeb08c 100644 --- a/server/mailet/mailetcontainer-camel/src/main/java/org/apache/james/mailetcontainer/lib/AbstractStateCompositeProcessor.java +++ b/server/mailet/mailetcontainer-camel/src/main/java/org/apache/james/mailetcontainer/lib/AbstractStateCompositeProcessor.java @@ -109,9 +109,6 @@ public abstract class AbstractStateCompositeProcessor implements MailProcessor, /** * Return a {@link MailProcessor} for a given state - * - * @param state - * @return processor */ public MailProcessor getProcessor(String state) { return processors.get(state); @@ -124,8 +121,6 @@ public abstract class AbstractStateCompositeProcessor implements MailProcessor, /** * Check if all needed Processors are configured and if not throw a * {@link ConfigurationException} - * - * @throws ConfigurationException */ private void checkProcessors() throws ConfigurationException { boolean errorProcessorFound = false; @@ -189,11 +184,6 @@ public abstract class AbstractStateCompositeProcessor implements MailProcessor, /** * Create a new {@link MailProcessor} - * - * @param state - * @param config - * @return container - * @throws Exception */ protected abstract MailProcessor createMailProcessor(String state, HierarchicalConfiguration<ImmutableNode> config) throws Exception; @@ -206,9 +196,6 @@ public abstract class AbstractStateCompositeProcessor implements MailProcessor, /** * Get called after the processing via a {@link MailProcessor} was * complete - * - * @param processor - * @param mailName * @param processTime * in ms * @param e diff --git a/server/mailet/mailetcontainer-camel/src/main/java/org/apache/james/mailetcontainer/lib/AbstractStateMailetProcessor.java b/server/mailet/mailetcontainer-camel/src/main/java/org/apache/james/mailetcontainer/lib/AbstractStateMailetProcessor.java index 1e55d80..adbea53 100644 --- a/server/mailet/mailetcontainer-camel/src/main/java/org/apache/james/mailetcontainer/lib/AbstractStateMailetProcessor.java +++ b/server/mailet/mailetcontainer-camel/src/main/java/org/apache/james/mailetcontainer/lib/AbstractStateMailetProcessor.java @@ -29,7 +29,6 @@ import javax.annotation.PostConstruct; import javax.annotation.PreDestroy; import javax.inject.Inject; import javax.mail.MessagingException; -import javax.management.NotCompliantMBeanException; import org.apache.commons.configuration2.HierarchicalConfiguration; import org.apache.commons.configuration2.ex.ConfigurationException; @@ -111,8 +110,6 @@ public abstract class AbstractStateMailetProcessor implements MailProcessor, Con /** * Init the container - * - * @throws Exception */ @PostConstruct public void init() throws Exception { @@ -149,9 +146,6 @@ public abstract class AbstractStateMailetProcessor implements MailProcessor, Con /** * Hand the mail over to another processor - * - * @param mail - * @throws MessagingException */ protected void toProcessor(Mail mail) throws MessagingException { rootMailProcessor.service(mail); @@ -163,8 +157,6 @@ public abstract class AbstractStateMailetProcessor implements MailProcessor, Con /** * Return a unmodifiable {@link List} of the configured {@link Mailet}'s - * - * @return mailets */ public List<Mailet> getMailets() { return pairs.stream() @@ -174,8 +166,6 @@ public abstract class AbstractStateMailetProcessor implements MailProcessor, Con /** * Return a unmodifiable {@link List} of the configured {@link Matcher}'s - * - * @return matchers */ public List<Matcher> getMatchers() { return pairs.stream() @@ -193,10 +183,6 @@ public abstract class AbstractStateMailetProcessor implements MailProcessor, Con /** * Create a {@link MailetConfig} for the given mailetname and configuration - * - * @param mailetName - * @param configuration - * @return mailetConfig */ private MailetConfig createMailetConfig(String mailetName, HierarchicalConfiguration<ImmutableNode> configuration) { @@ -209,9 +195,6 @@ public abstract class AbstractStateMailetProcessor implements MailProcessor, Con /** * Create a {@link MatcherConfig} for the given "match=" attribute. - * - * @param matchName - * @return matcherConfig */ private MatcherConfig createMatcherConfig(String matchName) { String condition = null; @@ -233,13 +216,8 @@ public abstract class AbstractStateMailetProcessor implements MailProcessor, Con * {@link Matcher}'s * * CompositeMatcher were added by JAMES-948 - * - * @param compMap - * @param compMatcherConfs + * * @return compositeMatchers - * @throws ConfigurationException - * @throws MessagingException - * @throws NotCompliantMBeanException */ private List<Matcher> loadCompositeMatchers(String state, Map<String, Matcher> compMap, List<HierarchicalConfiguration<ImmutableNode>> compMatcherConfs) throws ConfigurationException, MessagingException { List<Matcher> matchers = new ArrayList<>(); @@ -426,10 +404,7 @@ public abstract class AbstractStateMailetProcessor implements MailProcessor, Con /** * Get called after each {@link Mailet} call was complete - * - * @param m - * @param mailName - * @param state + * * @param processTime * in ms * @param e @@ -439,11 +414,7 @@ public abstract class AbstractStateMailetProcessor implements MailProcessor, Con /** * Get called after each {@link Matcher} call was complete - * - * @param m - * @param mailName - * @param recipients - * @param matches + * * @param processTime * in ms * @param e --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
