Merge branch 'develop' into stable

pom.xml

@@ -6,7 +6,7 @@
 	
 	<groupId>com.inteligr8</groupId>
 	<artifactId>common-rest-client</artifactId>
-	<version>2.0-SNAPSHOT</version>
+	<version>3.0.0</version>
 	<packaging>jar</packaging>
 
 	<name>ReST API Client for Java</name>
@@ -40,19 +40,19 @@
 
 	<properties>
 		<project.build.sourceEncoding>utf-8</project.build.sourceEncoding>
-		<maven.compiler.source>8</maven.compiler.source>
-		<maven.compiler.target>8</maven.compiler.target>
+		<maven.compiler.source>11</maven.compiler.source>
+		<maven.compiler.target>11</maven.compiler.target>
 
-		<junit.version>5.7.2</junit.version>
-		<spring.version>5.3.27</spring.version>
-		<jackson.version>2.15.1</jackson.version>
+		<junit.version>5.10.0</junit.version>
+		<spring.version>6.0.19</spring.version>
+		<jackson.version>2.17.2</jackson.version>
 	</properties>
 
 	<dependencies>
 		<dependency>
-			<groupId>javax.annotation</groupId>
-			<artifactId>javax.annotation-api</artifactId>
-			<version>1.3.2</version>
+			<groupId>jakarta.annotation</groupId>
+			<artifactId>jakarta.annotation-api</artifactId>
+			<version>2.1.1</version>
 		</dependency>
 		<dependency>
 			<groupId>org.springframework</groupId>
@@ -65,8 +65,8 @@
 			<version>${jackson.version}</version>
 		</dependency>
 		<dependency>
-			<groupId>com.fasterxml.jackson.jaxrs</groupId>
-			<artifactId>jackson-jaxrs-json-provider</artifactId>
+			<groupId>com.fasterxml.jackson.jakarta.rs</groupId>
+			<artifactId>jackson-jakarta-rs-json-provider</artifactId>
 			<version>${jackson.version}</version>
 		</dependency>
 		<dependency>
@@ -74,15 +74,20 @@
 			<artifactId>jackson-datatype-jsr310</artifactId>
 			<version>${jackson.version}</version>
 		</dependency>
+		<dependency>
+			<groupId>org.apache.commons</groupId>
+			<artifactId>commons-lang3</artifactId>
+			<version>3.14.0</version>
+		</dependency>
 		<dependency>
 			<groupId>org.slf4j</groupId>
 			<artifactId>slf4j-api</artifactId>
-			<version>1.7.36</version>
+			<version>2.0.13</version>
 		</dependency>
 		<dependency>
 			<groupId>jakarta.ws.rs</groupId>
 			<artifactId>jakarta.ws.rs-api</artifactId>
-			<version>2.1.6</version>
+			<version>3.1.0</version>
 		</dependency>
 		<dependency>
 			<groupId>org.junit.jupiter</groupId>

src/main/java/com/inteligr8/rs/AuthorizationFilter.java

@@ -14,7 +14,7 @@
  */
 package com.inteligr8.rs;
 
-import javax.ws.rs.client.ClientRequestFilter;
+import jakarta.ws.rs.client.ClientRequestFilter;
 
 /**
  * This is a marker that allows the developer to segregate, restrict, or limit

src/main/java/com/inteligr8/rs/BasicAuthorizationFilter.java

@@ -17,8 +17,10 @@ package com.inteligr8.rs;
 import java.io.UnsupportedEncodingException;
 import java.util.Base64;
 
-import javax.ws.rs.client.ClientRequestContext;
-import javax.ws.rs.core.HttpHeaders;
+import jakarta.ws.rs.client.ClientRequestContext;
+import jakarta.ws.rs.core.HttpHeaders;
+
+import org.apache.commons.lang3.StringUtils;
 
 /**
  * This class implements a simple 2-credential (username & password) based
@@ -36,8 +38,8 @@ public class BasicAuthorizationFilter implements AuthorizationFilter {
 	 * @param password A password or secret key.
 	 */
 	public BasicAuthorizationFilter(String username, String password) {
-		this.username = username;
-		this.password = password;
+		this.username = StringUtils.trimToNull(username);
+		this.password = StringUtils.trimToNull(password);
 	}
 	
 	/**

src/main/java/com/inteligr8/rs/BearerTokenAuthorizationFilter.java

@@ -14,8 +14,8 @@
  */
 package com.inteligr8.rs;
 
-import javax.ws.rs.client.ClientRequestContext;
-import javax.ws.rs.core.HttpHeaders;
+import jakarta.ws.rs.client.ClientRequestContext;
+import jakarta.ws.rs.core.HttpHeaders;
 
 /**
  * This class implements a simple long living or proxied token-based

src/main/java/com/inteligr8/rs/Client.java

@@ -14,14 +14,16 @@
  */
 package com.inteligr8.rs;
 
-import javax.ws.rs.client.ClientBuilder;
-import javax.ws.rs.client.WebTarget;
+import java.util.concurrent.TimeUnit;
+
+import jakarta.ws.rs.client.ClientBuilder;
+import jakarta.ws.rs.client.WebTarget;
 
 import com.fasterxml.jackson.databind.DeserializationFeature;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.databind.SerializationFeature;
 import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule;
-import com.fasterxml.jackson.jaxrs.json.JacksonJaxbJsonProvider;
+import com.fasterxml.jackson.jakarta.rs.json.JacksonJsonProvider;
 
 /**
  * A class that provides pre-configured JAX-RS Client & WebTarget objects.
@@ -31,7 +33,7 @@ import com.fasterxml.jackson.jaxrs.json.JacksonJaxbJsonProvider;
 public abstract class Client {
 	
 	private final Object sync = new Object();
-	private javax.ws.rs.client.Client client;
+	private jakarta.ws.rs.client.Client client;
 	
 	/**
 	 * @return The client configuration.
@@ -41,7 +43,7 @@ public abstract class Client {
 	/**
 	 * @return A pre-configured JAX-RS client (no URL) with configured authorization.
 	 */
-	public final javax.ws.rs.client.Client getClient() {
+	public final jakarta.ws.rs.client.Client getClient() {
 		synchronized (this.sync) {
 			if (this.client == null)
 				this.client = this.buildClient((AuthorizationFilter)null);
@@ -54,7 +56,7 @@ public abstract class Client {
 	 * @param authFilter A dynamic authorization filter.
 	 * @return A pre-configured JAX-RS client (no URL) with the specified authorization.
 	 */
-	public javax.ws.rs.client.Client getClient(AuthorizationFilter authFilter) {
+	public jakarta.ws.rs.client.Client getClient(AuthorizationFilter authFilter) {
 		if (authFilter == null) {
 			return this.getClient();
 		} else {
@@ -66,12 +68,12 @@ public abstract class Client {
 	 * @param authFilter A dynamic authorization filter.
 	 * @return A pre-configured JAX-RS client (no URL) with the specified authorization.
 	 */
-	public final javax.ws.rs.client.Client buildClient(AuthorizationFilter authFilter) {
+	public final jakarta.ws.rs.client.Client buildClient(AuthorizationFilter authFilter) {
 	    ObjectMapper om = new ObjectMapper();
 	    om.registerModules(new JavaTimeModule());
 	    this.getConfig().configureJacksonMapper(om);
 	    
-	    JacksonJaxbJsonProvider provider = new JacksonJaxbJsonProvider(om, JacksonJaxbJsonProvider.DEFAULT_ANNOTATIONS);
+	    JacksonJsonProvider provider = new JacksonJsonProvider(om, JacksonJsonProvider.BASIC_ANNOTATIONS);
 		this.getConfig().configureJacksonProvider(provider);
         
 		if (this.getConfig().isWrapRootValueEnabled())
@@ -83,6 +85,11 @@ public abstract class Client {
 				.register(provider)
 				.register(new LoggingFilter());
 		
+		if (this.getConfig().getConnectTimeoutInMillis() != null)
+		    clientBuilder.connectTimeout(this.getConfig().getConnectTimeoutInMillis(), TimeUnit.MILLISECONDS);
+        if (this.getConfig().getResponseTimeoutInMillis() != null)
+            clientBuilder.readTimeout(this.getConfig().getResponseTimeoutInMillis(), TimeUnit.MILLISECONDS);
+
 		if (authFilter == null)
 			authFilter = this.getConfig().createAuthorizationFilter();
 		if (authFilter != null)

src/main/java/com/inteligr8/rs/ClientConfiguration.java

@@ -16,10 +16,10 @@ package com.inteligr8.rs;
 
 import java.net.URI;
 
-import javax.ws.rs.client.ClientBuilder;
-
 import com.fasterxml.jackson.databind.ObjectMapper;
-import com.fasterxml.jackson.jaxrs.json.JacksonJaxbJsonProvider;
+import com.fasterxml.jackson.jakarta.rs.json.JacksonJsonProvider;
+
+import jakarta.ws.rs.client.ClientBuilder;
 
 /**
  * This interface defines the configurable parameters of the clients; primarily
@@ -120,6 +120,16 @@ public interface ClientConfiguration {
 	
 	
 	
+	default Integer getConnectTimeoutInMillis() {
+	    return null;
+	}
+	
+	default Integer getResponseTimeoutInMillis() {
+	    return null;
+	}
+	
+	
+
 	/**
 	 * @return true to enable Jackson UNWRAP_ROOT_VALUE feature; false otherwise.
 	 */
@@ -141,9 +151,9 @@ public interface ClientConfiguration {
     }
 	
 	/**
-	 * @param provider A Jackson JAX-RS provider to configure.
+	 * @param provider A Jackson Jakarta RS provider to configure.
 	 */
-	default void configureJacksonProvider(JacksonJaxbJsonProvider provider) {
+	default void configureJacksonProvider(JacksonJsonProvider provider) {
 	}
 	
 	

src/main/java/com/inteligr8/rs/ClientEnforcementAuthorizationFilter.java

@@ -14,7 +14,9 @@
  */
 package com.inteligr8.rs;
 
-import javax.ws.rs.client.ClientRequestContext;
+import jakarta.ws.rs.client.ClientRequestContext;
+
+import org.apache.commons.lang3.StringUtils;
 
 /**
  * This class is the base for implementations of client authorization similar
@@ -45,8 +47,8 @@ public class ClientEnforcementAuthorizationFilter implements AuthorizationFilter
 	 * @param clientSecret A secret corresponding to the client ID.
 	 */
 	public ClientEnforcementAuthorizationFilter(String clientId, String clientSecret) {
-		this.clientId = clientId;
-		this.clientSecret = clientSecret;
+		this.clientId = StringUtils.trimToNull(clientId);
+		this.clientSecret = StringUtils.trimToNull(clientSecret);
 	}
 
 	/**

src/main/java/com/inteligr8/rs/ClientImpl.java

@@ -14,13 +14,11 @@
  */
 package com.inteligr8.rs;
 
-import javax.annotation.PostConstruct;
-import javax.ws.rs.client.ClientBuilder;
+import jakarta.annotation.PostConstruct;
+import jakarta.ws.rs.client.ClientBuilder;
 
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
-import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.stereotype.Component;
 
 /**
  * A class that provides pre-configured JAX-RS Client & WebTarget objects
@@ -28,7 +26,6 @@ import org.springframework.stereotype.Component;
  * 
  * @author brian@inteligr8.com
  */
-@Component("client.jaxrs")
 public class ClientImpl extends Client {
 	
 	private final Logger logger = LoggerFactory.getLogger(ClientImpl.class);
@@ -39,7 +36,6 @@ public class ClientImpl extends Client {
 	 * This constructor is for Spring or POJO use.
 	 * @param config The client configuration.
 	 */
-	@Autowired
 	public ClientImpl(ClientConfiguration config) {
 		this.config = config;
 	}

src/main/java/com/inteligr8/rs/ForwardingAuthorizationFilter.java

@@ -14,8 +14,8 @@
  */
 package com.inteligr8.rs;
 
-import javax.ws.rs.client.ClientRequestContext;
-import javax.ws.rs.core.HttpHeaders;
+import jakarta.ws.rs.client.ClientRequestContext;
+import jakarta.ws.rs.core.HttpHeaders;
 
 /**
  * This class implements a proxied or forwarded authorization header based

src/main/java/com/inteligr8/rs/LoggingFilter.java

@@ -16,12 +16,12 @@ package com.inteligr8.rs;
 
 import java.io.IOException;
 
-import javax.ws.rs.client.ClientRequestContext;
-import javax.ws.rs.client.ClientRequestFilter;
-import javax.ws.rs.client.ClientResponseContext;
-import javax.ws.rs.client.ClientResponseFilter;
-import javax.ws.rs.core.Form;
-import javax.ws.rs.core.MediaType;
+import jakarta.ws.rs.client.ClientRequestContext;
+import jakarta.ws.rs.client.ClientRequestFilter;
+import jakarta.ws.rs.client.ClientResponseContext;
+import jakarta.ws.rs.client.ClientResponseFilter;
+import jakarta.ws.rs.core.Form;
+import jakarta.ws.rs.core.MediaType;
 
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;

src/main/java/com/inteligr8/rs/OAuthAuthorizationCodeAuthorizationFilter.java

@@ -16,7 +16,11 @@ package com.inteligr8.rs;
 
 import java.net.URI;
 
-import javax.ws.rs.core.Form;
+import jakarta.ws.rs.core.Form;
+
+import org.apache.commons.lang3.StringUtils;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 /**
  * This class implements the OAuth Authorization Code flow as an authorization
@@ -26,6 +30,8 @@ import javax.ws.rs.core.Form;
  */
 public class OAuthAuthorizationCodeAuthorizationFilter extends OAuthAuthorizationFilter {
     
+    private final Logger logger = LoggerFactory.getLogger(this.getClass());
+	
 	private final String code;
 	private final URI redirectUri;
 	
@@ -68,12 +74,13 @@ public class OAuthAuthorizationCodeAuthorizationFilter extends OAuthAuthorizatio
 	public OAuthAuthorizationCodeAuthorizationFilter(String tokenUrl, String clientId, String clientSecret, String code, URI redirectUri) {
 		super(tokenUrl, clientId, clientSecret);
 		
-		this.code = code;
+		this.code = StringUtils.trimToNull(code);
 		this.redirectUri = redirectUri;
 	}
 	
 	@Override
 	protected Form createForm() {
+        this.logger.debug("Using OAuth grant_type 'authorization_code'");
 		Form form = new Form().param("grant_type", "authorization_code");
 		if (this.redirectUri != null)
 			form.param("redirect_uri", this.redirectUri.toString());

src/main/java/com/inteligr8/rs/OAuthAuthorizationFilter.java

@@ -16,21 +16,22 @@ package com.inteligr8.rs;
 
 import java.util.Map;
 
-import javax.ws.rs.WebApplicationException;
-import javax.ws.rs.client.Client;
-import javax.ws.rs.client.ClientBuilder;
-import javax.ws.rs.client.ClientRequestContext;
-import javax.ws.rs.client.Entity;
-import javax.ws.rs.client.WebTarget;
-import javax.ws.rs.core.Form;
-import javax.ws.rs.core.HttpHeaders;
-import javax.ws.rs.core.Response;
-import javax.ws.rs.core.Response.Status.Family;
+import jakarta.ws.rs.WebApplicationException;
+import jakarta.ws.rs.client.Client;
+import jakarta.ws.rs.client.ClientBuilder;
+import jakarta.ws.rs.client.ClientRequestContext;
+import jakarta.ws.rs.client.Entity;
+import jakarta.ws.rs.client.WebTarget;
+import jakarta.ws.rs.core.Form;
+import jakarta.ws.rs.core.HttpHeaders;
+import jakarta.ws.rs.core.Response;
+import jakarta.ws.rs.core.Response.Status.Family;
 
+import org.apache.commons.lang3.StringUtils;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-import com.fasterxml.jackson.jaxrs.json.JacksonJaxbJsonProvider;
+import com.fasterxml.jackson.jakarta.rs.json.JacksonJsonProvider;
 
 /**
  * This class is the base for implementations of OAuth authorization flows.
@@ -48,6 +49,7 @@ public abstract class OAuthAuthorizationFilter implements AuthorizationFilter {
 	private String accessToken;
 	private long expiration;
 	private String refreshToken;
+	private Long refreshTokenExpiration;
 	
 	/**
 	 * This constructor creates an OAuth-based authorization filter using the
@@ -87,9 +89,9 @@ public abstract class OAuthAuthorizationFilter implements AuthorizationFilter {
 	 */
 	public OAuthAuthorizationFilter(String tokenUrl, String clientId, String clientSecret, String scope) {
 		this.tokenUrl = tokenUrl;
-		this.clientId = clientId;
-		this.clientSecret = clientSecret;
-		this.scope = scope;
+		this.clientId = StringUtils.trimToNull(clientId);
+		this.clientSecret = StringUtils.trimToNull(clientSecret);
+		this.scope = StringUtils.trimToNull(scope);
 	}
 
 	/**
@@ -99,8 +101,29 @@ public abstract class OAuthAuthorizationFilter implements AuthorizationFilter {
 	 */
 	@Override
 	public void filter(ClientRequestContext requestContext) {
-		if (this.accessToken == null || System.currentTimeMillis() > this.expiration)
+		if (this.accessToken == null) {
 		    this.requestToken();
+		} else if (System.currentTimeMillis() >= this.expiration) {
+            this.logger.trace("Access token expired; retrieving new one with refresh token");
+            
+		    if (this.refreshTokenExpiration != null && System.currentTimeMillis() >= this.refreshTokenExpiration.longValue()) {
+                this.logger.debug("Refresh token expired; performing full authentication");
+                this.refreshToken = null;
+                this.requestToken();
+		    } else {
+    		    try {
+    		        this.requestToken();
+                } catch (WebApplicationException wae) {
+                    if (wae.getResponse().getStatusInfo().getFamily() == Family.CLIENT_ERROR) {
+                        this.logger.debug("Received OAuth response {} using refresh token; performing full authentication", wae.getResponse().getStatus());
+                        this.refreshToken = null;
+                        this.requestToken();
+                    } else {
+                        throw wae;
+                    }
+                }
+		    }
+		}
 		
 		requestContext.getHeaders().add(HttpHeaders.AUTHORIZATION, "Bearer " + this.accessToken);
 	}
@@ -136,10 +159,12 @@ public abstract class OAuthAuthorizationFilter implements AuthorizationFilter {
 		Entity<Form> entity = Entity.form(form);
 		
 		Client client = ClientBuilder.newBuilder()
-                .register(new JacksonJaxbJsonProvider())
+                .register(new JacksonJsonProvider())
                 .build();
 		WebTarget target = client.target(this.tokenUrl);
 		
+		long requestSendTime = System.currentTimeMillis();
+
 		Response response = target.request().post(entity);
 		
         this.logger.debug("Received OAuth response: {}", response.getStatus());
@@ -160,8 +185,10 @@ public abstract class OAuthAuthorizationFilter implements AuthorizationFilter {
 		}
 		
 		this.accessToken = (String)responseMap.get("access_token");
-		this.expiration = System.currentTimeMillis() + ((Number)responseMap.get("expires_in")).longValue() * 1000L;
+		this.expiration = requestSendTime + ((Number)responseMap.get("expires_in")).longValue() * 1000L;
 		this.refreshToken = (String)responseMap.get("refresh_token");
+		if (responseMap.containsKey("refresh_token_expires_in"))
+		    this.refreshTokenExpiration = requestSendTime + ((Number)responseMap.get("refresh_token_expires_in")).longValue() * 1000L;
 	}
 	
 	protected Form createRefreshForm() {

src/main/java/com/inteligr8/rs/OAuthClientCredentialAuthorizationFilter.java

@@ -14,7 +14,10 @@
  */
 package com.inteligr8.rs;
 
-import javax.ws.rs.core.Form;
+import jakarta.ws.rs.core.Form;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 /**
  * This class implements the OAuth Client Credential flow as an authorization
@@ -24,6 +27,8 @@ import javax.ws.rs.core.Form;
  */
 public class OAuthClientCredentialAuthorizationFilter extends OAuthAuthorizationFilter {
     
+    private final Logger logger = LoggerFactory.getLogger(this.getClass());
+
 	/**
 	 * @param tokenUrl The URL to the OAuth IdP token service.
 	 * @param clientId The ID provided by the OAuth IdP administrator.
@@ -35,6 +40,7 @@ public class OAuthClientCredentialAuthorizationFilter extends OAuthAuthorization
 	
 	@Override
 	protected Form createForm() {
+        this.logger.debug("Using OAuth grant_type 'client_credentials'");
 		return new Form().param("grant_type", "client_credentials");
 	}
 	

src/main/java/com/inteligr8/rs/OAuthPasswordGrantAuthorizationFilter.java

@@ -14,7 +14,11 @@
  */
 package com.inteligr8.rs;
 
-import javax.ws.rs.core.Form;
+import jakarta.ws.rs.core.Form;
+
+import org.apache.commons.lang3.StringUtils;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 /**
  * This class implements the OAuth Password Grant flow as an authorization
@@ -24,6 +28,8 @@ import javax.ws.rs.core.Form;
  */
 public class OAuthPasswordGrantAuthorizationFilter extends OAuthAuthorizationFilter {
     
+    private final Logger logger = LoggerFactory.getLogger(this.getClass());
+	
 	private final String username;
 	private final String password;
 
@@ -46,12 +52,13 @@ public class OAuthPasswordGrantAuthorizationFilter extends OAuthAuthorizationFil
 	 */
 	public OAuthPasswordGrantAuthorizationFilter(String tokenUrl, String clientId, String clientSecret, String username, String password) {
 		super(tokenUrl, clientId, clientSecret);
-		this.username = username;
-		this.password = password;
+		this.username = StringUtils.trimToNull(username);
+		this.password = StringUtils.trimToNull(password);
 	}
 	
 	@Override
 	protected Form createForm() {
+        this.logger.debug("Using OAuth grant_type 'password': {}", this.username);
 		return new Form().param("grant_type", "password")
 				.param("username", this.username);
 	}