This is an automated email from the ASF dual-hosted git repository. srdo pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/storm.git
The following commit(s) were added to refs/heads/master by this push: new 82b8bdf STORM-3447: jms: fix all checkstyle warnings new 0b3ca35 Merge pull request #3062 from krichter722/checkstyle-jms 82b8bdf is described below commit 82b8bdf8908de117fef0f5178d11325e70b42221 Author: Karl-Philipp Richter <krich...@posteo.de> AuthorDate: Mon Jul 1 20:46:09 2019 +0200 STORM-3447: jms: fix all checkstyle warnings --- external/storm-jms/pom.xml | 2 +- .../org/apache/storm/jms/JmsMessageProducer.java | 8 +-- .../java/org/apache/storm/jms/JmsProvider.java | 6 +- .../org/apache/storm/jms/JmsTupleProducer.java | 9 ++- .../java/org/apache/storm/jms/bolt/JmsBolt.java | 47 +++++-------- .../org/apache/storm/jms/spout/JmsMessageID.java | 15 +++-- .../java/org/apache/storm/jms/spout/JmsSpout.java | 2 +- .../org/apache/storm/jms/trident/JmsState.java | 4 +- .../apache/storm/jms/trident/JmsStateFactory.java | 2 +- .../apache/storm/jms/trident/TridentJmsSpout.java | 78 ++++++++++------------ 10 files changed, 69 insertions(+), 104 deletions(-) diff --git a/external/storm-jms/pom.xml b/external/storm-jms/pom.xml index 984d8cf..ceb4efb 100644 --- a/external/storm-jms/pom.xml +++ b/external/storm-jms/pom.xml @@ -81,7 +81,7 @@ <artifactId>maven-checkstyle-plugin</artifactId> <!--Note - the version would be inherited--> <configuration> - <maxAllowedViolations>63</maxAllowedViolations> + <maxAllowedViolations>0</maxAllowedViolations> </configuration> </plugin> <plugin> diff --git a/external/storm-jms/src/main/java/org/apache/storm/jms/JmsMessageProducer.java b/external/storm-jms/src/main/java/org/apache/storm/jms/JmsMessageProducer.java index 671cdd9..1dcd608 100644 --- a/external/storm-jms/src/main/java/org/apache/storm/jms/JmsMessageProducer.java +++ b/external/storm-jms/src/main/java/org/apache/storm/jms/JmsMessageProducer.java @@ -22,18 +22,12 @@ import org.apache.storm.tuple.ITuple; * JmsMessageProducer implementations are responsible for translating * a <code>org.apache.storm.tuple.Values</code> instance into a * <code>javax.jms.Message</code> object. - * <p> */ public interface JmsMessageProducer extends Serializable { /** * Translate a <code>org.apache.storm.tuple.Tuple</code> object - * to a <code>javax.jms.Message</code object. - * - * @param session - * @param input - * @return - * @throws JMSException + * to a <code>javax.jms.Message</code> object. */ public Message toMessage(Session session, ITuple input) throws JMSException; } diff --git a/external/storm-jms/src/main/java/org/apache/storm/jms/JmsProvider.java b/external/storm-jms/src/main/java/org/apache/storm/jms/JmsProvider.java index b8dde44..324ff9d 100644 --- a/external/storm-jms/src/main/java/org/apache/storm/jms/JmsProvider.java +++ b/external/storm-jms/src/main/java/org/apache/storm/jms/JmsProvider.java @@ -24,19 +24,15 @@ import javax.jms.Destination; */ public interface JmsProvider extends Serializable { /** - * Provides the JMS <code>ConnectionFactory</code> + * Provides the JMS <code>ConnectionFactory</code>. * * @return the connection factory - * @throws Exception */ public ConnectionFactory connectionFactory() throws Exception; /** * Provides the <code>Destination</code> (topic or queue) from which the * <code>JmsSpout</code> will receive messages. - * - * @return - * @throws Exception */ public Destination destination() throws Exception; } diff --git a/external/storm-jms/src/main/java/org/apache/storm/jms/JmsTupleProducer.java b/external/storm-jms/src/main/java/org/apache/storm/jms/JmsTupleProducer.java index 4457f5a..44adf99 100644 --- a/external/storm-jms/src/main/java/org/apache/storm/jms/JmsTupleProducer.java +++ b/external/storm-jms/src/main/java/org/apache/storm/jms/JmsTupleProducer.java @@ -21,11 +21,11 @@ import org.apache.storm.tuple.Values; /** * Interface to define classes that can produce a Storm <code>Values</code> objects * from a <code>javax.jms.Message</code> object>. - * <p> - * Implementations are also responsible for declaring the output + * + * <p>Implementations are also responsible for declaring the output * fields they produce. - * <p> - * If for some reason the implementation can't process a message + * + * <p>If for some reason the implementation can't process a message * (for example if it received a <code>javax.jms.ObjectMessage</code> * when it was expecting a <code>javax.jms.TextMessage</code> it should * return <code>null</code> to indicate to the <code>JmsSpout</code> that @@ -38,7 +38,6 @@ public interface JmsTupleProducer extends Serializable { * * @param msg - the JMS message * @return the Values tuple, or null if the message couldn't be processed. - * @throws JMSException */ Values toTuple(Message msg) throws JMSException; diff --git a/external/storm-jms/src/main/java/org/apache/storm/jms/bolt/JmsBolt.java b/external/storm-jms/src/main/java/org/apache/storm/jms/bolt/JmsBolt.java index 0b461a1..362c3a6 100644 --- a/external/storm-jms/src/main/java/org/apache/storm/jms/bolt/JmsBolt.java +++ b/external/storm-jms/src/main/java/org/apache/storm/jms/bolt/JmsBolt.java @@ -33,23 +33,23 @@ import org.slf4j.LoggerFactory; /** * A JmsBolt receives <code>org.apache.storm.tuple.Tuple</code> objects from a Storm * topology and publishes JMS Messages to a destination (topic or queue). - * <p> - * To use a JmsBolt in a topology, the following must be supplied: + * + * <p>To use a JmsBolt in a topology, the following must be supplied: * <ol> * <li>A <code>JmsProvider</code> implementation.</li> * <li>A <code>JmsMessageProducer</code> implementation.</li> * </ol> * The <code>JmsProvider</code> provides the JMS <code>javax.jms.ConnectionFactory</code> * and <code>javax.jms.Destination</code> objects requied to publish JMS messages. - * <p> - * The JmsBolt uses a <code>JmsMessageProducer</code> to translate + * + * <p>The JmsBolt uses a <code>JmsMessageProducer</code> to translate * <code>org.apache.storm.tuple.Tuple</code> objects into * <code>javax.jms.Message</code> objects for publishing. - * <p> - * Both JmsProvider and JmsMessageProducer must be set, or the bolt will + * + * <p>Both JmsProvider and JmsMessageProducer must be set, or the bolt will * fail upon deployment to a cluster. - * <p> - * The JmsBolt is typically an endpoint in a topology -- in other words + * + * <p>The JmsBolt is typically an endpoint in a topology -- in other words * it does not emit any tuples. */ public class JmsBolt extends BaseTickTupleAwareRichBolt { @@ -74,9 +74,7 @@ public class JmsBolt extends BaseTickTupleAwareRichBolt { private OutputCollector collector; /** - * Set the JmsProvider used to connect to the JMS destination topic/queue - * - * @param provider + * Set the JmsProvider used to connect to the JMS destination topic/queue. */ public void setJmsProvider(JmsProvider provider) { this.jmsProvider = provider; @@ -85,8 +83,6 @@ public class JmsBolt extends BaseTickTupleAwareRichBolt { /** * Set the JmsMessageProducer used to convert tuples * into JMS messages. - * - * @param producer */ public void setJmsMessageProducer(JmsMessageProducer producer) { this.producer = producer; @@ -95,8 +91,8 @@ public class JmsBolt extends BaseTickTupleAwareRichBolt { /** * Sets the JMS acknowledgement mode for JMS messages sent * by this bolt. - * <p> - * Possible values: + * + * <p>Possible values: * <ul> * <li>javax.jms.Session.AUTO_ACKNOWLEDGE</li> * <li>javax.jms.Session.CLIENT_ACKNOWLEDGE</li> @@ -110,33 +106,20 @@ public class JmsBolt extends BaseTickTupleAwareRichBolt { } /** - * Set the JMS transactional setting for the JMS session. - * - * @param transactional - */ - // public void setJmsTransactional(boolean transactional){ - // this.jmsTransactional = transactional; - // } - - /** * Sets whether or not tuples should be acknowledged by this * bolt. - * <p> - * - * @param autoAck */ public void setAutoAck(boolean autoAck) { this.autoAck = autoAck; } - /** * Consumes a tuple and sends a JMS message. - * <p> - * If autoAck is true, the tuple will be acknowledged + * + * <p>If autoAck is true, the tuple will be acknowledged * after the message is sent. - * <p> - * If JMS sending fails, the tuple will be failed. + * + * <p>If JMS sending fails, the tuple will be failed. */ @Override protected void process(Tuple input) { diff --git a/external/storm-jms/src/main/java/org/apache/storm/jms/spout/JmsMessageID.java b/external/storm-jms/src/main/java/org/apache/storm/jms/spout/JmsMessageID.java index c069b7c..aae3c44 100644 --- a/external/storm-jms/src/main/java/org/apache/storm/jms/spout/JmsMessageID.java +++ b/external/storm-jms/src/main/java/org/apache/storm/jms/spout/JmsMessageID.java @@ -14,20 +14,21 @@ package org.apache.storm.jms.spout; import java.io.Serializable; +@SuppressWarnings("checkstyle:AbbreviationAsWordInName") public class JmsMessageID implements Comparable<JmsMessageID>, Serializable { - private String jmsID; + private final String jmsId; - private Long sequence; + private final Long sequence; - public JmsMessageID(long sequence, String jmsID) { - this.jmsID = jmsID; + public JmsMessageID(long sequence, String jmsId) { + this.jmsId = jmsId; this.sequence = sequence; } - + @SuppressWarnings("checkstyle:AbbreviationAsWordInName") public String getJmsID() { - return this.jmsID; + return this.jmsId; } @Override @@ -44,7 +45,7 @@ public class JmsMessageID implements Comparable<JmsMessageID>, Serializable { public boolean equals(Object o) { if (o instanceof JmsMessageID) { JmsMessageID id = (JmsMessageID) o; - return this.jmsID.equals(id.jmsID); + return this.jmsId.equals(id.jmsId); } else { return false; } diff --git a/external/storm-jms/src/main/java/org/apache/storm/jms/spout/JmsSpout.java b/external/storm-jms/src/main/java/org/apache/storm/jms/spout/JmsSpout.java index 1980a96..b76dbb7 100644 --- a/external/storm-jms/src/main/java/org/apache/storm/jms/spout/JmsSpout.java +++ b/external/storm-jms/src/main/java/org/apache/storm/jms/spout/JmsSpout.java @@ -19,9 +19,9 @@ package org.apache.storm.jms.spout; import java.io.Serializable; +import java.util.Collections; import java.util.HashMap; import java.util.Map; -import java.util.Collections; import javax.jms.Connection; import javax.jms.ConnectionFactory; diff --git a/external/storm-jms/src/main/java/org/apache/storm/jms/trident/JmsState.java b/external/storm-jms/src/main/java/org/apache/storm/jms/trident/JmsState.java index 3611e78..b1b4344 100644 --- a/external/storm-jms/src/main/java/org/apache/storm/jms/trident/JmsState.java +++ b/external/storm-jms/src/main/java/org/apache/storm/jms/trident/JmsState.java @@ -63,11 +63,11 @@ public class JmsState implements State { } @Override - public void beginCommit(Long aLong) { + public void beginCommit(Long someLong) { } @Override - public void commit(Long aLong) { + public void commit(Long someLong) { LOG.debug("Committing JMS transaction."); if (this.options.jmsTransactional) { try { diff --git a/external/storm-jms/src/main/java/org/apache/storm/jms/trident/JmsStateFactory.java b/external/storm-jms/src/main/java/org/apache/storm/jms/trident/JmsStateFactory.java index b72f88c..9c549a9 100644 --- a/external/storm-jms/src/main/java/org/apache/storm/jms/trident/JmsStateFactory.java +++ b/external/storm-jms/src/main/java/org/apache/storm/jms/trident/JmsStateFactory.java @@ -26,7 +26,7 @@ public class JmsStateFactory implements StateFactory { } @Override - public State makeState(Map<String, Object> map, IMetricsContext iMetricsContext, int partitionIndex, int numPartitions) { + public State makeState(Map<String, Object> map, IMetricsContext metricsContext, int partitionIndex, int numPartitions) { JmsState state = new JmsState(options); state.prepare(); return state; diff --git a/external/storm-jms/src/main/java/org/apache/storm/jms/trident/TridentJmsSpout.java b/external/storm-jms/src/main/java/org/apache/storm/jms/trident/TridentJmsSpout.java index de7c182..bf310f4 100644 --- a/external/storm-jms/src/main/java/org/apache/storm/jms/trident/TridentJmsSpout.java +++ b/external/storm-jms/src/main/java/org/apache/storm/jms/trident/TridentJmsSpout.java @@ -41,9 +41,7 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** - * Trident implementation of the JmsSpout - * <p> - * + * Trident implementation of the JmsSpout. */ public class TridentJmsSpout implements ITridentSpout<JmsBatch> { @@ -59,7 +57,7 @@ public class TridentJmsSpout implements ITridentSpout<JmsBatch> { private String name; /** - * Create a TridentJmsSpout with a default name and acknowledge mode of AUTO_ACKNOWLEDGE + * Create a TridentJmsSpout with a default name and acknowledge mode of AUTO_ACKNOWLEDGE. */ public TridentJmsSpout() { this.name = "JmsSpout_" + (nameIndex++); @@ -95,7 +93,7 @@ public class TridentJmsSpout implements ITridentSpout<JmsBatch> { } /** - * Set the name for this spout, to improve log identification + * Set the name for this spout, to improve log identification. * @param name The name to be used in log messages * @return This spout */ @@ -105,11 +103,8 @@ public class TridentJmsSpout implements ITridentSpout<JmsBatch> { } /** - * Set the <code>JmsProvider</code> - * implementation that this Spout will use to connect to - * a JMS <code>javax.jms.Desination</code> - * - * @param provider + * Set the <code>JmsProvider</code> implementation that this Spout will use to connect to a JMS + * <code>javax.jms.Desination</code>. */ public TridentJmsSpout withJmsProvider(JmsProvider provider) { this.jmsProvider = provider; @@ -117,12 +112,9 @@ public class TridentJmsSpout implements ITridentSpout<JmsBatch> { } /** - * Set the <code>JmsTupleProducer</code> - * implementation that will convert <code>javax.jms.Message</code> - * object to <code>backtype.storm.tuple.Values</code> objects - * to be emitted. + * Set the <code>JmsTupleProducer</code> implementation that will convert <code>javax.jms.Message</code> + * object to <code>backtype.storm.tuple.Values</code> objects to be emitted. * - * @param tupleProducer * @return This spout */ public TridentJmsSpout withTupleProducer(JmsTupleProducer tupleProducer) { @@ -193,7 +185,7 @@ public class TridentJmsSpout implements ITridentSpout<JmsBatch> { private final long rotateTimeMillis; private final int maxBatchSize; private final String name; - private final Logger LOG = LoggerFactory.getLogger(JmsEmitter.class); + private final Logger log = LoggerFactory.getLogger(JmsEmitter.class); private long lastRotate; public JmsEmitter(String name, JmsProvider jmsProvider, JmsTupleProducer tupleProducer, int jmsAcknowledgeMode, @@ -224,12 +216,12 @@ public class TridentJmsSpout implements ITridentSpout<JmsBatch> { consumer.setMessageListener(this); this.connection.start(); - LOG.info( - "Created JmsEmitter with max batch size " + maxBatchSize + " rotate time " + rotateTimeMillis + "ms and destination " + - dest + " for " + name); + log.info( + "Created JmsEmitter with max batch size " + maxBatchSize + " rotate time " + rotateTimeMillis + + "ms and destination " + dest + " for " + name); } catch (Exception e) { - LOG.warn("Error creating JMS connection.", e); + log.warn("Error creating JMS connection.", e); throw new IllegalStateException("Could not create JMS connection for spout ", e); } @@ -243,7 +235,7 @@ public class TridentJmsSpout implements ITridentSpout<JmsBatch> { if (messages != null) { if (!messages.isEmpty()) { - LOG.debug("Success for batch with transaction id " + tx.getTransactionId() + "/" + tx.getAttemptId() + " for " + name); + log.debug("Success for batch with transaction id " + tx.getTransactionId() + "/" + tx.getAttemptId() + " for " + name); } for (Message msg : messages) { @@ -252,13 +244,13 @@ public class TridentJmsSpout implements ITridentSpout<JmsBatch> { try { messageId = msg.getJMSMessageID(); msg.acknowledge(); - LOG.trace("Acknowledged message " + messageId); + log.trace("Acknowledged message " + messageId); } catch (JMSException e) { - LOG.warn("Failed to acknowledge message " + messageId, e); + log.warn("Failed to acknowledge message " + messageId, e); } } } else { - LOG.warn("No messages found in batch with transaction id " + tx.getTransactionId() + "/" + tx.getAttemptId()); + log.warn("No messages found in batch with transaction id " + tx.getTransactionId() + "/" + tx.getAttemptId()); } } @@ -270,28 +262,28 @@ public class TridentJmsSpout implements ITridentSpout<JmsBatch> { * @param messages The list of messages to fail. */ private void fail(Long transactionId, List<Message> messages) { - LOG.debug("Failure for batch with transaction id " + transactionId + " for " + name); + log.debug("Failure for batch with transaction id " + transactionId + " for " + name); if (messages != null) { for (Message msg : messages) { try { - LOG.trace("Failed message " + msg.getJMSMessageID()); + log.trace("Failed message " + msg.getJMSMessageID()); } catch (JMSException e) { - LOG.warn("Could not identify failed message ", e); + log.warn("Could not identify failed message ", e); } } } else { - LOG.warn("Failed batch has no messages with transaction id " + transactionId); + log.warn("Failed batch has no messages with transaction id " + transactionId); } } @Override public void close() { try { - LOG.info("Closing JMS connection."); + log.info("Closing JMS connection."); this.session.close(); this.connection.close(); } catch (JMSException e) { - LOG.warn("Error closing JMS connection.", e); + log.warn("Error closing JMS connection.", e); } } @@ -303,14 +295,14 @@ public class TridentJmsSpout implements ITridentSpout<JmsBatch> { if (now - lastRotate > rotateTimeMillis) { Map<Long, List<Message>> failed = batchMessageMap.rotate(); for (Long id : failed.keySet()) { - LOG.warn("TIMED OUT batch with transaction id " + id + " for " + name); + log.warn("TIMED OUT batch with transaction id " + id + " for " + name); fail(id, failed.get(id)); } lastRotate = now; } if (batchMessageMap.containsKey(tx.getTransactionId())) { - LOG.warn("FAILED duplicate batch with transaction id " + tx.getTransactionId() + "/" + tx.getAttemptId() + " for " + name); + log.warn("FAILED duplicate batch with transaction id " + tx.getTransactionId() + "/" + tx.getAttemptId() + " for " + name); fail(tx.getTransactionId(), batchMessageMap.get(tx.getTransactionId())); } @@ -330,17 +322,17 @@ public class TridentJmsSpout implements ITridentSpout<JmsBatch> { Values tuple = tupleProducer.toTuple(msg); collector.emit(tuple); } catch (JMSException e) { - LOG.warn("Failed to emit message, could not retrieve data for " + name + ": " + e); + log.warn("Failed to emit message, could not retrieve data for " + name + ": " + e); } } if (!batchMessages.isEmpty()) { - LOG.debug("Emitting batch with transaction id " + tx.getTransactionId() + "/" + tx.getAttemptId() + " and size " + - batchMessages.size() + " for " + name); + log.debug("Emitting batch with transaction id " + tx.getTransactionId() + + "/" + tx.getAttemptId() + " and size " + batchMessages.size() + " for " + name); } else { - LOG.trace( - "No items to acknowledge for batch with transaction id " + tx.getTransactionId() + "/" + tx.getAttemptId() + " for " + - name); + log.trace( + "No items to acknowledge for batch with transaction id " + tx.getTransactionId() + + "/" + tx.getAttemptId() + " for " + name); } batchMessageMap.put(tx.getTransactionId(), batchMessages); } @@ -348,7 +340,7 @@ public class TridentJmsSpout implements ITridentSpout<JmsBatch> { @Override public void onMessage(Message msg) { try { - LOG.trace("Queuing msg [" + msg.getJMSMessageID() + "]"); + log.trace("Queuing msg [" + msg.getJMSMessageID() + "]"); } catch (JMSException e) { // Nothing here, could not get message id } @@ -358,23 +350,23 @@ public class TridentJmsSpout implements ITridentSpout<JmsBatch> { } /** - * Bare implementation of a BatchCoordinator, returning a null JmsBatch object + * Bare implementation of a BatchCoordinator, returning a null JmsBatch object. * */ private class JmsBatchCoordinator implements BatchCoordinator<JmsBatch> { private final String name; - private final Logger LOG = LoggerFactory.getLogger(JmsBatchCoordinator.class); + private final Logger log = LoggerFactory.getLogger(JmsBatchCoordinator.class); public JmsBatchCoordinator(String name) { this.name = name; - LOG.info("Created batch coordinator for " + name); + log.info("Created batch coordinator for " + name); } @Override public JmsBatch initializeTransaction(long txid, JmsBatch prevMetadata, JmsBatch curMetadata) { - LOG.debug("Initialise transaction " + txid + " for " + name); + log.debug("Initialise transaction " + txid + " for " + name); return null; }