v2.0.8-cxf pom

pom.xml

@@ -6,7 +6,7 @@
 	
 	<groupId>com.inteligr8</groupId>
 	<artifactId>common-rest-client</artifactId>
-	<version>2.0.4-cxf</version>
+	<version>2.0.8-cxf</version>
 	<packaging>jar</packaging>
 
 	<name>ReST API Client for Java</name>

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

@@ -14,6 +14,8 @@
  */
 package com.inteligr8.rs;
 
+import org.apache.cxf.jaxrs.client.WebClient;
+
 /**
  * This interface defines additional configurations specific to the Apache CXF
  * JAX-RS library and its nuances.
@@ -35,4 +37,12 @@ public interface ClientCxfConfiguration extends ClientConfiguration {
 		return true;
 	}
 
+    /**
+     * A Jackson provider, logging filter, and authentication filter are already registered.
+     * 
+     * @param client A CXF client to configure.
+     */
+	default void configureClient(WebClient client) {
+	}
+
 }

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

@@ -24,11 +24,15 @@ 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;
 import com.fasterxml.jackson.jaxrs.json.JacksonJaxbJsonProvider;
 
 /**
@@ -41,8 +45,10 @@ import com.fasterxml.jackson.jaxrs.json.JacksonJaxbJsonProvider;
 public class ClientCxfImpl extends Client {
 	
 	private final Logger logger = LoggerFactory.getLogger(ClientCxfImpl.class);
-	
+
+    private final Object sync = new Object();
 	private ClientCxfConfiguration config;
+    private WebClient client;
 	
 	/**
 	 * This constructor is for Spring or POJO use.
@@ -77,16 +83,40 @@ public class ClientCxfImpl extends Client {
 	 * @return A CXF client (not JAX-RS).
 	 */
 	public WebClient getCxfClient() {
-		return this.getCxfClient(null);
+        synchronized (this.sync) {
+            if (this.client == null)
+                this.client = this.buildCxfClient(null);
+        }
+
+        return this.client;
 	}
+    
+    /**
+     * @param authFilter A dynamic authorization filter.
+     * @return A pre-configured CXF client (no URL) with the specified authorization.
+     */
+    public WebClient getCxfClient(AuthorizationFilter authFilter) {
+        if (authFilter == null) {
+            return this.getCxfClient();
+        } else {
+            return this.buildCxfClient(authFilter);
+        }
+    }
 	
 	/**
 	 * @param authFilter A post-configuration authorization filter.
 	 * @return A CXF client (not JAX-RS).
 	 */
-	public WebClient getCxfClient(AuthorizationFilter authFilter) {
+	public WebClient buildCxfClient(AuthorizationFilter authFilter) {
+        ObjectMapper om = new ObjectMapper();
+        om.registerModules(new JavaTimeModule());
+        this.getConfig().configureJacksonMapper(om);
+
+        JacksonJaxbJsonProvider jacksonProvider = new JacksonJaxbJsonProvider(om, JacksonJaxbJsonProvider.DEFAULT_ANNOTATIONS);
+        this.getConfig().configureJacksonProvider(jacksonProvider);
+        
 		List<Object> providersAndFilters = new LinkedList<Object>();
-		providersAndFilters.add(new JacksonJaxbJsonProvider());
+		providersAndFilters.add(jacksonProvider);
 		providersAndFilters.add(new CxfLoggingFilter());
 		providersAndFilters.add(new CxfMultipartProvider());
 		
@@ -101,6 +131,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
@@ -109,6 +150,8 @@ public class ClientCxfImpl extends Client {
 			config.setBus(BusFactory.newInstance().createBus());
 		}
 		
+		this.config.configureClient(client);
+		
 		return client;
 	}
 	

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;
 
@@ -72,9 +74,6 @@ public abstract class Client {
 	    this.getConfig().configureJacksonMapper(om);
 	    
 	    JacksonJaxbJsonProvider provider = new JacksonJaxbJsonProvider(om, JacksonJaxbJsonProvider.DEFAULT_ANNOTATIONS);
-        provider.enable(DeserializationFeature.READ_UNKNOWN_ENUM_VALUES_AS_NULL);
-	    provider.disable(DeserializationFeature.READ_UNKNOWN_ENUM_VALUES_USING_DEFAULT_VALUE);
-	    
 		this.getConfig().configureJacksonProvider(provider);
         
 		if (this.getConfig().isWrapRootValueEnabled())
@@ -85,13 +84,17 @@ 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();
 		if (authFilter != null)
 			clientBuilder.register(authFilter);
 		this.buildClient(clientBuilder);
-		
 		this.getConfig().configureClient(clientBuilder);
 		
 		return clientBuilder.build();

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/ClientImpl.java

@@ -0,0 +1,83 @@
+/*
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or (at your
+ * option) any later version.
+ * 
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
+ * more details.
+ * 
+ * You should have received a copy of the GNU General Public License along
+ * with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+package com.inteligr8.rs;
+
+import javax.annotation.PostConstruct;
+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 &amp; WebTarget objects
+ * for Jersey.
+ * 
+ * @author brian@inteligr8.com
+ */
+@Component("client.jaxrs")
+public class ClientImpl extends Client {
+	
+	private final Logger logger = LoggerFactory.getLogger(ClientImpl.class);
+	
+	private ClientConfiguration config;
+	
+	/**
+	 * This constructor is for Spring or POJO use.
+	 * @param config The client configuration.
+	 */
+	@Autowired
+	public ClientImpl(ClientConfiguration config) {
+		this.config = config;
+	}
+
+	/**
+	 * This method registers the Jersey library as the default provider for the
+	 * JAX-RS specification.
+	 */
+	@PostConstruct
+	public void register() {
+		this.logger.info("API Base URL: {}", this.getConfig().getBaseUrl());
+	}
+	
+	/**
+	 * @param clientBuilder A client builder.
+	 */
+	@Override
+	public void buildClient(ClientBuilder clientBuilder) {
+	}
+	
+	/**
+	 * @return The client configuration.
+	 */
+	public ClientConfiguration getConfig() {
+		return this.config;
+	}
+
+	/**
+	 * This method retrieves a JAX-RS implementation of the specified API with
+	 * the specified authorization.
+	 * 
+	 * @param authFilter A dynamic authorization filter.
+	 * @param apiClass A JAX-RS annotation API class.
+	 * @return An instance of the API class.
+	 */
+	@Override
+	public <T> T getApi(AuthorizationFilter authFilter, Class<T> apiClass) {
+		throw new UnsupportedOperationException();
+	}
+
+}

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

@@ -58,7 +58,7 @@ public class LoggingFilter implements ClientRequestFilter, ClientResponseFilter
 				logger.trace("request: {} {}: {}", requestContext.getMethod(), requestContext.getUri(),
 						((Form)requestContext.getEntity()).asMap());
 			} else {
-				this.loggerRequest.trace("request: {} {}: failed to output form", requestContext.getMethod(), requestContext.getUri());
+				logger.trace("request: {} {}: failed to output form", requestContext.getMethod(), requestContext.getUri());
 			}
 		} else {
 			this.logUnhandledRequest(requestContext, logger);

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

@@ -74,11 +74,15 @@ public class OAuthAuthorizationCodeAuthorizationFilter extends OAuthAuthorizatio
 	
 	@Override
 	protected Form createForm() {
-		Form form = new Form().param("grant_type", "authorization_code")
-				.param("code", this.code);
+		Form form = new Form().param("grant_type", "authorization_code");
 		if (this.redirectUri != null)
 			form.param("redirect_uri", this.redirectUri.toString());
 		return form;
 	}
+	
+	@Override
+	protected void extendFormSensitive(Form form) {
+	    form.param("code", this.code);
+	}
 
 }

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

@@ -17,12 +17,18 @@ 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 org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 import com.fasterxml.jackson.jaxrs.json.JacksonJaxbJsonProvider;
 
@@ -33,6 +39,8 @@ import com.fasterxml.jackson.jaxrs.json.JacksonJaxbJsonProvider;
  */
 public abstract class OAuthAuthorizationFilter implements AuthorizationFilter {
 	
+    private final Logger logger = LoggerFactory.getLogger(this.getClass());
+    
 	private final String tokenUrl;
 	private final String clientId;
 	private final String clientSecret;
@@ -40,6 +48,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
@@ -91,8 +100,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);
 	}
@@ -111,29 +141,53 @@ public abstract class OAuthAuthorizationFilter implements AuthorizationFilter {
 		}
 
 		form.param("client_id", this.clientId);
-		if (this.clientSecret != null)
-			form.param("client_secret", this.clientSecret);
 		if (this.scope != null)
 			form.param("scope", this.scope);
-		this.extendRefreshTokenForm(form);
+		
+		this.logger.trace("Sending OAuth request: {}", form);
+		
+		if (this.refreshToken != null) {
+		    this.extendRefreshFormSensitive(form);
+		} else {
+            this.extendFormSensitive(form);
+		}
+
+        if (this.clientSecret != null)
+            form.param("client_secret", this.clientSecret);
 		
 		Entity<Form> entity = Entity.form(form);
 		
-		WebTarget target = ClientBuilder.newBuilder()
-				.register(new JacksonJaxbJsonProvider())
-				.build()
-				.target(this.tokenUrl);
+		Client client = ClientBuilder.newBuilder()
+                .register(new JacksonJaxbJsonProvider())
+                .build();
+		WebTarget target = client.target(this.tokenUrl);
+		
+		long requestSendTime = System.currentTimeMillis();
 
-		@SuppressWarnings("unchecked")
-		Map<String, Object> response = target.request().post(entity, Map.class);
+		Response response = target.request().post(entity);
 		
-		if (response.containsKey("error"))
-			throw new WebApplicationException((String)response.get("error"), 400);
+        this.logger.debug("Received OAuth response: {}", response.getStatus());
+
+        @SuppressWarnings("unchecked")
+        Map<String, Object> responseMap = response.readEntity(Map.class);
+
+        this.logger.trace("Received OAuth response: {}", responseMap);
 		
-		this.accessToken = (String)response.get("access_token");
-		this.expiration = System.currentTimeMillis() + ((Number)response.get("expires_in")).longValue() * 1000L;
-		this.refreshToken = (String)response.get("refresh_token");
-		this.extendRefreshTokenResponse(response);
+		if (response.getStatusInfo().getFamily() != Family.SUCCESSFUL) {
+            String code = (String) responseMap.get("error");
+            if (code != null) {
+                String description = (String) responseMap.get("error_description");
+    			throw new WebApplicationException(code + ": " + description, response.getStatus());
+            } else {
+                throw new WebApplicationException(response);
+            }
+		}
+		
+		this.accessToken = (String)responseMap.get("access_token");
+		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() {
@@ -143,10 +197,9 @@ public abstract class OAuthAuthorizationFilter implements AuthorizationFilter {
 	
 	protected abstract Form createForm();
 	
-	protected void extendRefreshTokenForm(Form form) {
-	}
-	
-	protected void extendRefreshTokenResponse(Map<String, Object> response) {
+	protected void extendRefreshFormSensitive(Form form) {
 	}
 
+    protected abstract void extendFormSensitive(Form form);
+
 }

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

@@ -37,5 +37,9 @@ public class OAuthClientCredentialAuthorizationFilter extends OAuthAuthorization
 	protected Form createForm() {
 		return new Form().param("grant_type", "client_credentials");
 	}
+	
+	@Override
+	protected void extendFormSensitive(Form form) {
+	}
 
 }

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

@@ -53,8 +53,12 @@ public class OAuthPasswordGrantAuthorizationFilter extends OAuthAuthorizationFil
 	@Override
 	protected Form createForm() {
 		return new Form().param("grant_type", "password")
-				.param("username", this.username)
-				.param("password", this.password);
+				.param("username", this.username);
+	}
+	
+	@Override
+	protected void extendFormSensitive(Form form) {
+	    form.param("password", this.password);
 	}
 
 }