Use Duration to track token expiration

Easier to work with than a Date.

(cherry picked from commit 6277348)

Author: acogoluegnes

src/main/java/com/rabbitmq/client/impl/AMQConnection.java

@@ -1,4 +1,4 @@
-// Copyright (c) 2007-Present Pivotal Software, Inc.  All rights reserved.
+// Copyright (c) 2007-2019 Pivotal Software, Inc.  All rights reserved.
 //
 // This software, the RabbitMQ Java client library, is triple-licensed under the
 // Mozilla Public License 1.1 ("MPL"), the GNU General Public License version 2
@@ -341,8 +341,8 @@ public void start()
             String username = credentialsProvider.getUsername();
             String password = credentialsProvider.getPassword();
 
-            if (credentialsProvider.getExpiration() != null) {
-                if (this.credentialsRefreshService.needRefresh(credentialsProvider.getExpiration())) {
+            if (credentialsProvider.getTimeBeforeExpiration() != null) {
+                if (this.credentialsRefreshService.needRefresh(credentialsProvider.getTimeBeforeExpiration())) {
                     credentialsProvider.refresh();
                     username = credentialsProvider.getUsername();
                     password = credentialsProvider.getPassword();
@@ -426,7 +426,7 @@ public void start()
             throw AMQChannel.wrap(sse);
         }
 
-        if (this.credentialsProvider.getExpiration() != null) {
+        if (this.credentialsProvider.getTimeBeforeExpiration() != null) {
             String registrationId = this.credentialsRefreshService.register(credentialsProvider, () -> {
                 // return false if connection is closed, so refresh service can get rid of this registration
                 if (!isOpen()) {

src/main/java/com/rabbitmq/client/impl/CredentialsProvider.java

@@ -15,7 +15,7 @@
 
 package com.rabbitmq.client.impl;
 
-import java.util.Date;
+import java.time.Duration;
 
 /**
  * Provider interface for establishing credentials for connecting to the broker. Especially useful
@@ -42,16 +42,15 @@ public interface CredentialsProvider {
     String getPassword();
 
     /**
-     * The expiration date of the credentials, if any.
+     * The time before the credentials expire, if they do expire.
      * <p>
      * If credentials do not expire, must return null. Default
      * behavior is to return null, assuming credentials never
      * expire.
      *
-     * @return credentials expiration date
+     * @return time before expiration
      */
-    default Date getExpiration() {
-        // no expiration by default
+    default Duration getTimeBeforeExpiration() {
         return null;
     }
 

src/main/java/com/rabbitmq/client/impl/CredentialsRefreshService.java

@@ -15,7 +15,7 @@
 
 package com.rabbitmq.client.impl;
 
-import java.util.Date;
+import java.time.Duration;
 import java.util.concurrent.Callable;
 
 /**
@@ -65,9 +65,9 @@ public interface CredentialsRefreshService {
     /**
      * Provide a hint about whether credentials should be renewed.
      *
-     * @param expiration
+     * @param timeBeforeExpiration
      * @return true if credentials should be renewed, false otherwise
      */
-    boolean needRefresh(Date expiration);
+    boolean needRefresh(Duration timeBeforeExpiration);
 
 }

src/main/java/com/rabbitmq/client/impl/DefaultCredentialsRefreshService.java

@@ -19,7 +19,6 @@
 import org.slf4j.LoggerFactory;
 
 import java.time.Duration;
-import java.util.Date;
 import java.util.Iterator;
 import java.util.Map;
 import java.util.UUID;
@@ -35,7 +34,7 @@
  * <p>
  * This implementation keeps track of entities (typically AMQP connections) that need
  * to renew credentials. Token renewal is scheduled based on token expiration, using
- * a <code>Function<Date, Long> refreshDelayStrategy</code>. Once credentials
+ * a <code>Function<Duration, Long> refreshDelayStrategy</code>. Once credentials
  * for a {@link CredentialsProvider} have been renewed, the callback registered
  * by each entity/connection is performed. This callback typically propagates
  * the new credentials in the entity state, e.g. sending the new password to the
@@ -51,11 +50,11 @@ public class DefaultCredentialsRefreshService implements CredentialsRefreshServi
 
     private final boolean privateScheduler;
 
-    private final Function<Date, Long> refreshDelayStrategy;
+    private final Function<Duration, Long> refreshDelayStrategy;
 
-    private final Function<Date, Boolean> needRefreshStrategy;
+    private final Function<Duration, Boolean> needRefreshStrategy;
 
-    public DefaultCredentialsRefreshService(ScheduledExecutorService scheduler, Function<Date, Long> refreshDelayStrategy, Function<Date, Boolean> needRefreshStrategy) {
+    public DefaultCredentialsRefreshService(ScheduledExecutorService scheduler, Function<Duration, Long> refreshDelayStrategy, Function<Duration, Boolean> needRefreshStrategy) {
         this.refreshDelayStrategy = refreshDelayStrategy;
         this.needRefreshStrategy = needRefreshStrategy;
         if (scheduler == null) {
@@ -76,7 +75,7 @@ public DefaultCredentialsRefreshService(ScheduledExecutorService scheduler, Func
      * @param duration
      * @return
      */
-    public static Function<Date, Long> fixedDelayBeforeExpirationRefreshDelayStrategy(Duration duration) {
+    public static Function<Duration, Long> fixedDelayBeforeExpirationRefreshDelayStrategy(Duration duration) {
         return new FixedDelayBeforeExpirationRefreshDelayStrategy(duration.toMillis());
     }
 
@@ -86,20 +85,21 @@ public static Function<Date, Long> fixedDelayBeforeExpirationRefreshDelayStrateg
      * @param limitBeforeExpiration
      * @return
      */
-    public static Function<Date, Boolean> fixedTimeNeedRefreshStrategy(Duration limitBeforeExpiration) {
+    public static Function<Duration, Boolean> fixedTimeNeedRefreshStrategy(Duration limitBeforeExpiration) {
         return new FixedTimeNeedRefreshStrategy(limitBeforeExpiration.toMillis());
     }
 
     // TODO add a delay refresh strategy that bases the time on a percentage of the TTL, use it as default with 80% TTL
 
     private static Runnable refresh(ScheduledExecutorService scheduler, CredentialsProviderState credentialsProviderState,
-                                    Function<Date, Long> refreshDelayStrategy) {
+                                    Function<Duration, Long> refreshDelayStrategy) {
         return () -> {
             LOGGER.debug("Refreshing token");
             credentialsProviderState.refresh();
 
-            Date expirationAfterRefresh = credentialsProviderState.credentialsProvider.getExpiration();
-            long newDelay = refreshDelayStrategy.apply(expirationAfterRefresh);
+            Duration timeBeforeExpiration = credentialsProviderState.credentialsProvider.getTimeBeforeExpiration();
+
+            long newDelay = refreshDelayStrategy.apply(timeBeforeExpiration);
 
             LOGGER.debug("Scheduling refresh in {} milliseconds", newDelay);
 
@@ -122,8 +122,7 @@ public String register(CredentialsProvider credentialsProvider, Callable<Boolean
         credentialsProviderState.add(registration);
 
         credentialsProviderState.maybeSetRefreshTask(() -> {
-            Date expiration = credentialsProvider.getExpiration();
-            long delay = refreshDelayStrategy.apply(expiration);
+            long delay = refreshDelayStrategy.apply(credentialsProvider.getTimeBeforeExpiration());
             LOGGER.debug("Scheduling refresh in {} milliseconds", delay);
             return scheduler.schedule(refresh(scheduler, credentialsProviderState, refreshDelayStrategy), delay, TimeUnit.MILLISECONDS);
         });
@@ -140,8 +139,8 @@ public void unregister(CredentialsProvider credentialsProvider, String registrat
     }
 
     @Override
-    public boolean needRefresh(Date expiration) {
-        return this.needRefreshStrategy.apply(expiration);
+    public boolean needRefresh(Duration timeBeforeExpiration) {
+        return this.needRefreshStrategy.apply(timeBeforeExpiration);
     }
 
     public void close() {
@@ -150,7 +149,7 @@ public void close() {
         }
     }
 
-    private static class FixedTimeNeedRefreshStrategy implements Function<Date, Boolean> {
+    private static class FixedTimeNeedRefreshStrategy implements Function<Duration, Boolean> {
 
         private final long limitBeforeExpiration;
 
@@ -159,13 +158,12 @@ private FixedTimeNeedRefreshStrategy(long limitBeforeExpiration) {
         }
 
         @Override
-        public Boolean apply(Date expiration) {
-            long ttl = expiration.getTime() - new Date().getTime();
-            return ttl <= limitBeforeExpiration;
+        public Boolean apply(Duration timeBeforeExpiration) {
+            return timeBeforeExpiration.toMillis() <= limitBeforeExpiration;
         }
     }
 
-    private static class FixedDelayBeforeExpirationRefreshDelayStrategy implements Function<Date, Long> {
+    private static class FixedDelayBeforeExpirationRefreshDelayStrategy implements Function<Duration, Long> {
 
         private final long delay;
 
@@ -174,11 +172,10 @@ private FixedDelayBeforeExpirationRefreshDelayStrategy(long delay) {
         }
 
         @Override
-        public Long apply(Date expiration) {
-            long ttl = expiration.getTime() - new Date().getTime();
-            long refreshTimeBeforeExpiration = ttl - delay;
+        public Long apply(Duration timeBeforeExpiration) {
+            long refreshTimeBeforeExpiration = timeBeforeExpiration.toMillis() - delay;
             if (refreshTimeBeforeExpiration < 0) {
-                return ttl;
+                return timeBeforeExpiration.toMillis();
             } else {
                 return refreshTimeBeforeExpiration;
             }
@@ -279,21 +276,21 @@ public static class DefaultCredentialsRefreshServiceBuilder {
 
         private ScheduledExecutorService scheduler;
 
-        private Function<Date, Long> refreshDelayStrategy = fixedDelayBeforeExpirationRefreshDelayStrategy(Duration.ofSeconds(60));
+        private Function<Duration, Long> refreshDelayStrategy = fixedDelayBeforeExpirationRefreshDelayStrategy(Duration.ofSeconds(60));
 
-        private Function<Date, Boolean> needRefreshStrategy = fixedTimeNeedRefreshStrategy(Duration.ofSeconds(60));
+        private Function<Duration, Boolean> needRefreshStrategy = fixedTimeNeedRefreshStrategy(Duration.ofSeconds(60));
 
         public DefaultCredentialsRefreshServiceBuilder scheduler(ScheduledThreadPoolExecutor scheduler) {
             this.scheduler = scheduler;
             return this;
         }
 
-        public DefaultCredentialsRefreshServiceBuilder refreshDelayStrategy(Function<Date, Long> refreshDelayStrategy) {
+        public DefaultCredentialsRefreshServiceBuilder refreshDelayStrategy(Function<Duration, Long> refreshDelayStrategy) {
             this.refreshDelayStrategy = refreshDelayStrategy;
             return this;
         }
 
-        public DefaultCredentialsRefreshServiceBuilder needRefreshStrategy(Function<Date, Boolean> needRefreshStrategy) {
+        public DefaultCredentialsRefreshServiceBuilder needRefreshStrategy(Function<Duration, Boolean> needRefreshStrategy) {
             this.needRefreshStrategy = needRefreshStrategy;
             return this;
         }

src/main/java/com/rabbitmq/client/impl/OAuth2ClientCredentialsGrantCredentialsProvider.java

@@ -25,6 +25,9 @@
 import java.net.URL;
 import java.net.URLEncoder;
 import java.nio.charset.StandardCharsets;
+import java.time.Duration;
+import java.time.Instant;
+import java.time.temporal.ChronoUnit;
 import java.util.*;
 
 /**
@@ -107,9 +110,8 @@ protected Token parseToken(String response) {
         try {
             Map<?, ?> map = objectMapper.readValue(response, Map.class);
             int expiresIn = ((Number) map.get("expires_in")).intValue();
-            Calendar calendar = Calendar.getInstance();
-            calendar.add(Calendar.SECOND, expiresIn);
-            return new Token(map.get("access_token").toString(), calendar.getTime());
+            Instant receivedAt = Instant.now();
+            return new Token(map.get("access_token").toString(), expiresIn, receivedAt);
         } catch (IOException e) {
             throw new OAuthTokenManagementException("Error while parsing OAuth 2 token", e);
         }
@@ -177,8 +179,8 @@ protected String passwordFromToken(Token token) {
     }
 
     @Override
-    protected Date expirationFromToken(Token token) {
-        return token.getExpiration();
+    protected Duration timeBeforeExpiration(Token token) {
+        return token.getTimeBeforeExpiration();
     }
 
     protected void configureHttpConnection(HttpURLConnection connection) {
@@ -212,20 +214,33 @@ public static class Token {
 
         private final String access;
 
-        private final Date expiration;
+        private final int expiresIn;
 
-        public Token(String access, Date expiration) {
-            this.access = access;
-            this.expiration = expiration;
-        }
+        private final Instant receivedAt;
 
-        public Date getExpiration() {
-            return expiration;
+        public Token(String access, int expiresIn, Instant receivedAt) {
+            this.access = access;
+            this.expiresIn = expiresIn;
+            this.receivedAt = receivedAt;
         }
 
         public String getAccess() {
             return access;
         }
+
+        public int getExpiresIn() {
+            return expiresIn;
+        }
+
+        public Instant getReceivedAt() {
+            return receivedAt;
+        }
+
+        public Duration getTimeBeforeExpiration() {
+            Instant now = Instant.now();
+            long age = receivedAt.until(now, ChronoUnit.SECONDS);
+            return Duration.ofSeconds(expiresIn - age);
+        }
     }
 
     public static class OAuth2ClientCredentialsGrantCredentialsProviderBuilder {

src/main/java/com/rabbitmq/client/impl/RefreshProtectedCredentialsProvider.java

@@ -18,7 +18,7 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-import java.util.Date;
+import java.time.Duration;
 import java.util.concurrent.CountDownLatch;
 import java.util.concurrent.atomic.AtomicBoolean;
 import java.util.concurrent.atomic.AtomicReference;
@@ -35,8 +35,8 @@
  * is already being renewed.
  * <p>
  * Subclasses need to provide the actual token retrieval (whether is a first retrieval or a renewal is
- * a implementation detail) and how to extract information (username, password, expiration date) from the retrieved
- * token.
+ * a implementation detail) and how to extract information (username, password, time before expiration)
+ * from the retrieved token.
  *
  * @param <T> the type of token (usually specified by the subclass)
  */
@@ -67,11 +67,11 @@ public String getPassword() {
     }
 
     @Override
-    public Date getExpiration() {
+    public Duration getTimeBeforeExpiration() {
         if (token.get() == null) {
             refresh();
         }
-        return expirationFromToken(token.get());
+        return timeBeforeExpiration(token.get());
     }
 
     @Override
@@ -109,5 +109,5 @@ public void refresh() {
 
     protected abstract String passwordFromToken(T token);
 
-    protected abstract Date expirationFromToken(T token);
+    protected abstract Duration timeBeforeExpiration(T token);
 }

src/test/java/com/rabbitmq/client/impl/DefaultCredentialsRefreshServiceTest.java

@@ -23,8 +23,6 @@
 import org.mockito.stubbing.Answer;
 
 import java.time.Duration;
-import java.util.Calendar;
-import java.util.Date;
 import java.util.List;
 import java.util.concurrent.Callable;
 import java.util.concurrent.CopyOnWriteArrayList;
@@ -63,11 +61,7 @@ public void scheduling() throws Exception {
         AtomicInteger passwordSequence = new AtomicInteger(0);
         when(credentialsProvider.getPassword()).thenAnswer(
                 (Answer<String>) invocation -> "password-" + passwordSequence.get());
-        when(credentialsProvider.getExpiration()).thenAnswer((Answer<Date>) invocation -> {
-            Calendar calendar = Calendar.getInstance();
-            calendar.add(Calendar.SECOND, 5);
-            return calendar.getTime();
-        });
+        when(credentialsProvider.getTimeBeforeExpiration()).thenAnswer((Answer<Duration>) invocation -> Duration.ofSeconds(5));
         doAnswer(invocation -> {
             passwordSequence.incrementAndGet();
             return null;
@@ -88,11 +82,7 @@ public void scheduling() throws Exception {
         AtomicInteger passwordSequence2 = new AtomicInteger(0);
         CredentialsProvider credentialsProvider2 = mock(CredentialsProvider.class);
         when(credentialsProvider2.getPassword()).thenAnswer((Answer<String>) invocation -> "password2-" + passwordSequence2.get());
-        when(credentialsProvider2.getExpiration()).thenAnswer((Answer<Date>) invocation -> {
-            Calendar calendar = Calendar.getInstance();
-            calendar.add(Calendar.SECOND, 4);
-            return calendar.getTime();
-        });
+        when(credentialsProvider2.getTimeBeforeExpiration()).thenAnswer((Answer<Duration>) invocation -> Duration.ofSeconds(4));
         doAnswer(invocation -> {
             passwordSequence2.incrementAndGet();
             return null;