You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@qpid.apache.org by ro...@apache.org on 2015/08/25 19:26:55 UTC

qpid-jms git commit: QPIDJMS-96: rename the option to be 'localMessageExpiry' for alignment with existing priority option

Repository: qpid-jms
Updated Branches:
  refs/heads/master 3a810c311 -> 11125ba2a


QPIDJMS-96: rename the option to be 'localMessageExpiry' for alignment with existing priority option


Project: http://git-wip-us.apache.org/repos/asf/qpid-jms/repo
Commit: http://git-wip-us.apache.org/repos/asf/qpid-jms/commit/11125ba2
Tree: http://git-wip-us.apache.org/repos/asf/qpid-jms/tree/11125ba2
Diff: http://git-wip-us.apache.org/repos/asf/qpid-jms/diff/11125ba2

Branch: refs/heads/master
Commit: 11125ba2a1273a0acafadf86c06c0ef9d7ed6fdb
Parents: 3a810c3
Author: Robert Gemmell <ro...@apache.org>
Authored: Tue Aug 25 18:12:42 2015 +0100
Committer: Robert Gemmell <ro...@apache.org>
Committed: Tue Aug 25 18:25:20 2015 +0100

----------------------------------------------------------------------
 .../java/org/apache/qpid/jms/JmsConnection.java | 10 +++++-----
 .../apache/qpid/jms/JmsConnectionFactory.java   | 20 ++++++++++----------
 .../org/apache/qpid/jms/JmsMessageConsumer.java |  4 ++--
 .../java/org/apache/qpid/jms/JmsSession.java    |  9 ---------
 .../apache/qpid/jms/meta/JmsConsumerInfo.java   | 10 +++++-----
 .../apache/qpid/jms/meta/JmsSessionInfo.java    |  9 ---------
 .../jms/integration/MessageIntegrationTest.java |  2 +-
 qpid-jms-docs/Configuration.md                  |  5 ++---
 .../JmsExpiredMessageConsumptionTest.java       |  4 ++--
 9 files changed, 27 insertions(+), 46 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/qpid-jms/blob/11125ba2/qpid-jms-client/src/main/java/org/apache/qpid/jms/JmsConnection.java
----------------------------------------------------------------------
diff --git a/qpid-jms-client/src/main/java/org/apache/qpid/jms/JmsConnection.java b/qpid-jms-client/src/main/java/org/apache/qpid/jms/JmsConnection.java
index 39f97ab..6873fee 100644
--- a/qpid-jms-client/src/main/java/org/apache/qpid/jms/JmsConnection.java
+++ b/qpid-jms-client/src/main/java/org/apache/qpid/jms/JmsConnection.java
@@ -101,7 +101,7 @@ public class JmsConnection implements Connection, TopicConnection, QueueConnecti
     private boolean localMessagePriority;
     private boolean clientIdSet;
     private boolean sendAcksAsync;
-    private boolean consumerExpiryCheckEnabled;
+    private boolean localMessageExpiry;
     private ExceptionListener exceptionListener;
 
     private final ThreadPoolExecutor executor;
@@ -979,12 +979,12 @@ public class JmsConnection implements Connection, TopicConnection, QueueConnecti
         this.sendAcksAsync = sendAcksAsync;
     }
 
-    public boolean isConsumerExpiryCheckEnabled() {
-        return consumerExpiryCheckEnabled;
+    public boolean isLocalMessageExpiry() {
+        return localMessageExpiry;
     }
 
-    public void setConsumerExpiryCheckEnabled(boolean consumerExpiryCheckEnabled) {
-        this.consumerExpiryCheckEnabled = consumerExpiryCheckEnabled;
+    public void setLocalMessageExpiry(boolean localMessageExpiry) {
+        this.localMessageExpiry = localMessageExpiry;
     }
 
     //----- Async event handlers ---------------------------------------------//

http://git-wip-us.apache.org/repos/asf/qpid-jms/blob/11125ba2/qpid-jms-client/src/main/java/org/apache/qpid/jms/JmsConnectionFactory.java
----------------------------------------------------------------------
diff --git a/qpid-jms-client/src/main/java/org/apache/qpid/jms/JmsConnectionFactory.java b/qpid-jms-client/src/main/java/org/apache/qpid/jms/JmsConnectionFactory.java
index abd5f93..983545e 100644
--- a/qpid-jms-client/src/main/java/org/apache/qpid/jms/JmsConnectionFactory.java
+++ b/qpid-jms-client/src/main/java/org/apache/qpid/jms/JmsConnectionFactory.java
@@ -60,7 +60,7 @@ public class JmsConnectionFactory extends JNDIStorable implements ConnectionFact
     private boolean alwaysSyncSend;
     private boolean sendAcksAsync;
     private boolean localMessagePriority;
-    private boolean consumerExpiryCheckEnabled = true;
+    private boolean localMessageExpiry = true;
     private String queuePrefix = null;
     private String topicPrefix = null;
     private boolean validatePropertyNames = true;
@@ -650,21 +650,21 @@ public class JmsConnectionFactory extends JNDIStorable implements ConnectionFact
     }
 
     /**
-     * @return true if MessageConsumer instance will check for expired messages before dispatch.
+     * @return true if MessageConsumer instance will check for expired messages locally before dispatch.
      */
-    public boolean isConsumerExpiryCheckEnabled() {
-        return consumerExpiryCheckEnabled;
+    public boolean isLocalMessageExpiry() {
+        return localMessageExpiry;
     }
 
     /**
-     * Controls whether message expiration checking is done in each MessageConsumer
-     * prior to dispatching a message.  Disabling this check can lead to consumption
-     * of expired messages.
+     * Controls whether message expiration checking is done locally (in addition to any broker
+     * side checks) in each MessageConsumer prior to dispatching a message.  Disabling this check
+     * can lead to consumption of expired messages.
      *
-     * @param consumerExpiryCheckEnabled
+     * @param localMessageExpiry
      *        controls whether expiration checking is done prior to dispatch.
      */
-    public void setConsumerExpiryCheckEnabled(boolean consumerExpiryCheckEnabled) {
-        this.consumerExpiryCheckEnabled = consumerExpiryCheckEnabled;
+    public void setLocalMessageExpiry(boolean localMessageExpiry) {
+        this.localMessageExpiry = localMessageExpiry;
     }
 }

http://git-wip-us.apache.org/repos/asf/qpid-jms/blob/11125ba2/qpid-jms-client/src/main/java/org/apache/qpid/jms/JmsMessageConsumer.java
----------------------------------------------------------------------
diff --git a/qpid-jms-client/src/main/java/org/apache/qpid/jms/JmsMessageConsumer.java b/qpid-jms-client/src/main/java/org/apache/qpid/jms/JmsMessageConsumer.java
index 80f16fc..b8d5b8d 100644
--- a/qpid-jms-client/src/main/java/org/apache/qpid/jms/JmsMessageConsumer.java
+++ b/qpid-jms-client/src/main/java/org/apache/qpid/jms/JmsMessageConsumer.java
@@ -119,7 +119,7 @@ public class JmsMessageConsumer implements MessageConsumer, JmsMessageAvailableC
         consumerInfo.setBrowser(isBrowser());
         consumerInfo.setPrefetchSize(getConfiguredPrefetch(destination, policy));
         consumerInfo.setRedeliveryPolicy(redeliveryPolicy);
-        consumerInfo.setConsumerExpiryCheckEnabled(session.isConsumerExpiryCheckEnabled());
+        consumerInfo.setLocalMessageExpiry(connection.isLocalMessageExpiry());
 
         session.getConnection().createResource(consumerInfo);
     }
@@ -315,7 +315,7 @@ public class JmsMessageConsumer implements MessageConsumer, JmsMessageAvailableC
     }
 
     private boolean consumeExpiredMessage(JmsInboundMessageDispatch dispatch) {
-        if (!isBrowser() && consumerInfo.isConsumerExpiryCheckEnabled() && dispatch.getMessage().isExpired()) {
+        if (!isBrowser() && consumerInfo.isLocalMessageExpiry() && dispatch.getMessage().isExpired()) {
             return true;
         }
 

http://git-wip-us.apache.org/repos/asf/qpid-jms/blob/11125ba2/qpid-jms-client/src/main/java/org/apache/qpid/jms/JmsSession.java
----------------------------------------------------------------------
diff --git a/qpid-jms-client/src/main/java/org/apache/qpid/jms/JmsSession.java b/qpid-jms-client/src/main/java/org/apache/qpid/jms/JmsSession.java
index dea51ad..19d86e5 100644
--- a/qpid-jms-client/src/main/java/org/apache/qpid/jms/JmsSession.java
+++ b/qpid-jms-client/src/main/java/org/apache/qpid/jms/JmsSession.java
@@ -117,7 +117,6 @@ public class JmsSession implements Session, QueueSession, TopicSession, JmsMessa
         this.sessionInfo = new JmsSessionInfo(sessionId);
         this.sessionInfo.setAcknowledgementMode(acknowledgementMode);
         this.sessionInfo.setSendAcksAsync(connection.isSendAcksAsync());
-        this.sessionInfo.setConsumerExpiryCheckEnabled(connection.isConsumerExpiryCheckEnabled());
 
         connection.createResource(sessionInfo);
     }
@@ -806,14 +805,6 @@ public class JmsSession implements Session, QueueSession, TopicSession, JmsMessa
         return acknowledgementMode == Session.DUPS_OK_ACKNOWLEDGE;
     }
 
-    public boolean isConsumerExpiryCheckEnabled() {
-        return sessionInfo.isConsumerExpiryCheckEnabled();
-    }
-
-    public void setConsumerExpiryCheckEnabled(boolean consumerExpiryCheckEnabled) {
-        sessionInfo.setConsumerExpiryCheckEnabled(consumerExpiryCheckEnabled);
-    }
-
     protected void checkClosed() throws IllegalStateException {
         if (closed.get()) {
             IllegalStateException jmsEx = null;

http://git-wip-us.apache.org/repos/asf/qpid-jms/blob/11125ba2/qpid-jms-client/src/main/java/org/apache/qpid/jms/meta/JmsConsumerInfo.java
----------------------------------------------------------------------
diff --git a/qpid-jms-client/src/main/java/org/apache/qpid/jms/meta/JmsConsumerInfo.java b/qpid-jms-client/src/main/java/org/apache/qpid/jms/meta/JmsConsumerInfo.java
index 4504434..f772ba9 100644
--- a/qpid-jms-client/src/main/java/org/apache/qpid/jms/meta/JmsConsumerInfo.java
+++ b/qpid-jms-client/src/main/java/org/apache/qpid/jms/meta/JmsConsumerInfo.java
@@ -31,7 +31,7 @@ public final class JmsConsumerInfo implements JmsResource, Comparable<JmsConsume
     protected String subscriptionName;
     protected boolean noLocal;
     protected int acknowledgementMode;
-    protected boolean consumerExpiryCheckEnabled;
+    protected boolean localMessageExpiry;
 
     protected JmsRedeliveryPolicy redeliveryPolicy;
 
@@ -154,12 +154,12 @@ public final class JmsConsumerInfo implements JmsResource, Comparable<JmsConsume
         this.acknowledgementMode = acknowledgementMode;
     }
 
-    public boolean isConsumerExpiryCheckEnabled() {
-        return consumerExpiryCheckEnabled;
+    public boolean isLocalMessageExpiry() {
+        return localMessageExpiry;
     }
 
-    public void setConsumerExpiryCheckEnabled(boolean consumerExpiryCheckEnabled) {
-        this.consumerExpiryCheckEnabled = consumerExpiryCheckEnabled;
+    public void setLocalMessageExpiry(boolean localMessageExpiry) {
+        this.localMessageExpiry = localMessageExpiry;
     }
 
     public JmsRedeliveryPolicy getRedeliveryPolicy() {

http://git-wip-us.apache.org/repos/asf/qpid-jms/blob/11125ba2/qpid-jms-client/src/main/java/org/apache/qpid/jms/meta/JmsSessionInfo.java
----------------------------------------------------------------------
diff --git a/qpid-jms-client/src/main/java/org/apache/qpid/jms/meta/JmsSessionInfo.java b/qpid-jms-client/src/main/java/org/apache/qpid/jms/meta/JmsSessionInfo.java
index b23eefa..a88e5e7 100644
--- a/qpid-jms-client/src/main/java/org/apache/qpid/jms/meta/JmsSessionInfo.java
+++ b/qpid-jms-client/src/main/java/org/apache/qpid/jms/meta/JmsSessionInfo.java
@@ -25,7 +25,6 @@ public final class JmsSessionInfo implements JmsResource, Comparable<JmsSessionI
     private final JmsSessionId sessionId;
     private int acknowledgementMode;
     private boolean sendAcksAsync;
-    private boolean consumerExpiryCheckEnabled;
 
     public JmsSessionInfo(JmsConnectionInfo connectionInfo, long sessionId) {
         if (connectionInfo == null) {
@@ -82,14 +81,6 @@ public final class JmsSessionInfo implements JmsResource, Comparable<JmsSessionI
         this.sendAcksAsync = sendAcksAsync;
     }
 
-    public boolean isConsumerExpiryCheckEnabled() {
-        return consumerExpiryCheckEnabled;
-    }
-
-    public void setConsumerExpiryCheckEnabled(boolean consumerExpiryCheckEnabled) {
-        this.consumerExpiryCheckEnabled = consumerExpiryCheckEnabled;
-    }
-
     @Override
     public String toString() {
         return ToStringSupport.toString(this);

http://git-wip-us.apache.org/repos/asf/qpid-jms/blob/11125ba2/qpid-jms-client/src/test/java/org/apache/qpid/jms/integration/MessageIntegrationTest.java
----------------------------------------------------------------------
diff --git a/qpid-jms-client/src/test/java/org/apache/qpid/jms/integration/MessageIntegrationTest.java b/qpid-jms-client/src/test/java/org/apache/qpid/jms/integration/MessageIntegrationTest.java
index c63aa31..b7d7127 100644
--- a/qpid-jms-client/src/test/java/org/apache/qpid/jms/integration/MessageIntegrationTest.java
+++ b/qpid-jms-client/src/test/java/org/apache/qpid/jms/integration/MessageIntegrationTest.java
@@ -1277,7 +1277,7 @@ public class MessageIntegrationTest extends QpidJmsTestCase
     public void testReceivedMessageFromQueueWithAbsoluteExpiryReturnsJMSExpirationNonZero() throws Exception {
         try (TestAmqpPeer testPeer = new TestAmqpPeer();) {
             //Disable local expiration checking in consumer
-            Connection connection = testFixture.establishConnecton(testPeer, "?jms.consumerExpiryCheckEnabled=false");
+            Connection connection = testFixture.establishConnecton(testPeer, "?jms.localMessageExpiry=false");
             connection.start();
 
             testPeer.expectBegin();

http://git-wip-us.apache.org/repos/asf/qpid-jms/blob/11125ba2/qpid-jms-docs/Configuration.md
----------------------------------------------------------------------
diff --git a/qpid-jms-docs/Configuration.md b/qpid-jms-docs/Configuration.md
index ae5bb19..8b27b2d 100644
--- a/qpid-jms-docs/Configuration.md
+++ b/qpid-jms-docs/Configuration.md
@@ -79,7 +79,8 @@ The options apply to the behaviour of the JMS objects such as Connection, Sessio
 + **jms.forceAsyncSend** Configures whether all Messages sent from a MessageProducer are sent asynchronously or only those Message that qualify such as Messages inside a transaction or non-persistent messages.
 + **jms.alwaysSyncSend** Override all asynchronous send conditions and always sends every Message from a MessageProducer synchronously.
 + **jms.sendAcksAsync** Causes all Message acknowledgments to be sent asynchronously.
-+ **jms.localMessagePriority** If enabled prefetched messages are reordered locally based on their given Message priority value.
++ **jms.localMessageExpiry** Controls whether MessageConsumer instances will locally filter expired Messages or deliver them.  By default this value is set to true and expired messages will be filtered.
++ **jms.localMessagePriority** If enabled prefetched messages are reordered locally based on their given Message priority value. Default is false.
 + **jms.validatePropertyNames** If message property names should be validated as valid Java identifiers. Default is true.
 + **jms.queuePrefix** Optional prefix value added to the name of any Queue created from a JMS Session.
 + **jms.topicPrefix** Optional prefix value added to the name of any Topic created from a JMS Session.
@@ -87,8 +88,6 @@ The options apply to the behaviour of the JMS objects such as Connection, Sessio
 + **jms.connectTimeout** Timeout value that controls how long the client waits on Connection establishment before returning with an error. (By default the client waits 15 seconds for a connection to be established before failing).
 + **jms.clientIDPrefix** Optional prefix value that is used for generated Client ID values when a new Connection is created for the JMS ConnectionFactory.  The default prefix is 'ID:'.
 + **jms.connectionIDPrefix** Optional prefix value that is used for generated Connection ID values when a new Connection is created for the JMS ConnectionFactory.  This connection ID is used when logging some information from the JMS Connection object so a configurable prefix can make breadcrumbing the logs easier.  The default prefix is 'ID:'.
-+ **jms.consumerExpiryCheckEnabled** Controls whether a MessageConsumer instances will filter expired Messages
-or deliver them.  By default this value is set to true and expired messages will be filtered.
 
 These values control how many messages the remote peer can send to the client and be held in a prefetch buffer for each consumer instance.
 

http://git-wip-us.apache.org/repos/asf/qpid-jms/blob/11125ba2/qpid-jms-interop-tests/qpid-jms-activemq-tests/src/test/java/org/apache/qpid/jms/consumer/JmsExpiredMessageConsumptionTest.java
----------------------------------------------------------------------
diff --git a/qpid-jms-interop-tests/qpid-jms-activemq-tests/src/test/java/org/apache/qpid/jms/consumer/JmsExpiredMessageConsumptionTest.java b/qpid-jms-interop-tests/qpid-jms-activemq-tests/src/test/java/org/apache/qpid/jms/consumer/JmsExpiredMessageConsumptionTest.java
index 8bea583..d3258cf 100644
--- a/qpid-jms-interop-tests/qpid-jms-activemq-tests/src/test/java/org/apache/qpid/jms/consumer/JmsExpiredMessageConsumptionTest.java
+++ b/qpid-jms-interop-tests/qpid-jms-activemq-tests/src/test/java/org/apache/qpid/jms/consumer/JmsExpiredMessageConsumptionTest.java
@@ -154,7 +154,7 @@ public class JmsExpiredMessageConsumptionTest extends AmqpTestSupport {
         connection.start();
 
         JmsConnection jmsConnection = (JmsConnection) connection;
-        jmsConnection.setConsumerExpiryCheckEnabled(false);
+        jmsConnection.setLocalMessageExpiry(false);
 
         Session session = connection.createSession(false, Session.AUTO_ACKNOWLEDGE);
         Queue queue = session.createQueue(name.getMethodName());
@@ -188,7 +188,7 @@ public class JmsExpiredMessageConsumptionTest extends AmqpTestSupport {
         connection.start();
 
         JmsConnection jmsConnection = (JmsConnection) connection;
-        jmsConnection.setConsumerExpiryCheckEnabled(false);
+        jmsConnection.setLocalMessageExpiry(false);
 
         final CountDownLatch success = new CountDownLatch(1);
 


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@qpid.apache.org
For additional commands, e-mail: commits-help@qpid.apache.org