v2.0.10-cxf pom

pom.xml

@@ -6,7 +6,7 @@
 	
 	<groupId>com.inteligr8</groupId>
 	<artifactId>common-rest-client</artifactId>
-	<version>2.0.6-cxf</version>
+	<version>2.0.10-cxf</version>
 	<packaging>jar</packaging>
 
 	<name>ReST API Client for Java</name>
@@ -70,6 +70,11 @@
 			<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>

src/main/cxf/com/inteligr8/rs/ClientCxfImpl.java

@@ -24,10 +24,10 @@ import org.apache.cxf.BusFactory;
 import org.apache.cxf.jaxrs.client.JAXRSClientFactory;
 import org.apache.cxf.jaxrs.client.WebClient;
 import org.apache.cxf.jaxrs.impl.RuntimeDelegateImpl;
+import org.apache.cxf.transport.http.HTTPConduit;
+import org.apache.cxf.transports.http.configuration.HTTPClientPolicy;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
-import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.stereotype.Component;
 
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule;
@@ -39,7 +39,6 @@ import com.fasterxml.jackson.jaxrs.json.JacksonJaxbJsonProvider;
  * 
  * @author brian@inteligr8.com
  */
-@Component("client.cxf")
 public class ClientCxfImpl extends Client {
 	
 	private final Logger logger = LoggerFactory.getLogger(ClientCxfImpl.class);
@@ -52,7 +51,6 @@ public class ClientCxfImpl extends Client {
 	 * This constructor is for Spring or POJO use.
 	 * @param config The client configuration.
 	 */
-	@Autowired
 	public ClientCxfImpl(ClientCxfConfiguration config) {
 		this.config = config;
 	}
@@ -129,6 +127,17 @@ public class ClientCxfImpl extends Client {
 		// so we need to create a CXF client
 		WebClient client = WebClient.create(this.getConfig().getBaseUrl(), providersAndFilters);
 
+        if (this.getConfig().getConnectTimeoutInMillis() != null || this.getConfig().getResponseTimeoutInMillis() != null) {
+            HTTPConduit conduit = client.getConfiguration().getHttpConduit();
+    		HTTPClientPolicy policy = conduit.getClient();
+    		if (policy == null)
+    		    conduit.setClient(policy = new HTTPClientPolicy());
+    		if (this.getConfig().getConnectTimeoutInMillis() != null)
+    		    policy.setConnectionTimeout(this.getConfig().getConnectTimeoutInMillis());
+            if (this.getConfig().getResponseTimeoutInMillis() != null)
+                policy.setReceiveTimeout(this.getConfig().getResponseTimeoutInMillis());
+        }
+
 		if (!this.getConfig().isDefaultBusEnabled()) {
 			// Some applications (like ACS) add interceptors to the default bus
 			// those interceptors may treat all messages as SOAP messages (like ACS), resulting in ClassCastExceptions

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

@@ -20,6 +20,8 @@ import java.util.Base64;
 import javax.ws.rs.client.ClientRequestContext;
 import javax.ws.rs.core.HttpHeaders;
 
+import org.apache.commons.lang3.StringUtils;
+
 /**
  * This class implements a simple 2-credential (username & password) based
  * authorization filter.
@@ -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/Client.java

@@ -14,6 +14,8 @@
  */
 package com.inteligr8.rs;
 
+import java.util.concurrent.TimeUnit;
+
 import javax.ws.rs.client.ClientBuilder;
 import javax.ws.rs.client.WebTarget;
 
@@ -82,6 +84,11 @@ public abstract class Client {
 		ClientBuilder clientBuilder = ClientBuilder.newBuilder()
 				.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();

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

@@ -119,6 +119,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.

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

@@ -16,6 +16,8 @@ package com.inteligr8.rs;
 
 import javax.ws.rs.client.ClientRequestContext;
 
+import org.apache.commons.lang3.StringUtils;
+
 /**
  * This class is the base for implementations of client authorization similar
  * to OAuth-based flows.
@@ -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

@@ -19,8 +19,6 @@ import javax.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/OAuthAuthorizationCodeAuthorizationFilter.java

@@ -18,6 +18,10 @@ import java.net.URI;
 
 import javax.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
  * filter.
@@ -25,6 +29,8 @@ import javax.ws.rs.core.Form;
  * @author brian@inteligr8.com
  */
 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

@@ -27,6 +27,7 @@ import javax.ws.rs.core.HttpHeaders;
 import javax.ws.rs.core.Response;
 import javax.ws.rs.core.Response.Status.Family;
 
+import org.apache.commons.lang3.StringUtils;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -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)
-			this.requestToken();
+		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);
 	}
@@ -139,6 +162,8 @@ public abstract class OAuthAuthorizationFilter implements AuthorizationFilter {
                 .register(new JacksonJaxbJsonProvider())
                 .build();
 		WebTarget target = client.target(this.tokenUrl);
+		
+		long requestSendTime = System.currentTimeMillis();
 
 		Response response = target.request().post(entity);
 		
@@ -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

@@ -16,6 +16,9 @@ package com.inteligr8.rs;
 
 import javax.ws.rs.core.Form;
 
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
 /**
  * This class implements the OAuth Client Credential flow as an authorization
  * filter.
@@ -23,6 +26,8 @@ import javax.ws.rs.core.Form;
  * @author brian@inteligr8.com
  */
 public class OAuthClientCredentialAuthorizationFilter extends OAuthAuthorizationFilter {
+    
+    private final Logger logger = LoggerFactory.getLogger(this.getClass());
 
 	/**
 	 * @param tokenUrl The URL to the OAuth IdP token service.
@@ -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

@@ -16,6 +16,10 @@ package com.inteligr8.rs;
 
 import javax.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
  * filter.
@@ -23,6 +27,8 @@ import javax.ws.rs.core.Form;
  * @author brian@inteligr8.com
  */
 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);
 	}