v2.0.6-cxf

pom.xml

@@ -6,7 +6,7 @@
 	
 	<groupId>com.inteligr8</groupId>
 	<artifactId>common-rest-client</artifactId>
-	<version>2.0.1-cxf</version>
+	<version>2.0.6-cxf</version>
 	<packaging>jar</packaging>
 
 	<name>ReST API Client for Java</name>
@@ -44,8 +44,9 @@
 		<maven.compiler.target>8</maven.compiler.target>
 
 		<junit.version>5.7.2</junit.version>
-		<spring.version>5.2.14.RELEASE</spring.version>
-		<cxf.version>3.3.2</cxf.version>
+		<spring.version>5.3.27</spring.version>
+		<jackson.version>2.15.1</jackson.version>
+		<cxf.version>3.5.6</cxf.version>
 	</properties>
 
 	<dependencies>
@@ -57,22 +58,22 @@
 		<dependency>
 			<groupId>com.fasterxml.jackson.core</groupId>
 			<artifactId>jackson-databind</artifactId>
-			<version>2.12.2</version>
+			<version>${jackson.version}</version>
 		</dependency>
 		<dependency>
 			<groupId>com.fasterxml.jackson.jaxrs</groupId>
 			<artifactId>jackson-jaxrs-json-provider</artifactId>
-			<version>2.12.2</version>
+			<version>${jackson.version}</version>
 		</dependency>
 		<dependency>
 			<groupId>com.fasterxml.jackson.datatype</groupId>
 			<artifactId>jackson-datatype-jsr310</artifactId>
-			<version>2.12.2</version>
+			<version>${jackson.version}</version>
 		</dependency>
 		<dependency>
 			<groupId>org.slf4j</groupId>
 			<artifactId>slf4j-api</artifactId>
-			<version>1.7.29</version>
+			<version>1.7.36</version>
 		</dependency>
 		<dependency>
 			<groupId>jakarta.ws.rs</groupId>
@@ -94,7 +95,7 @@
 		<dependency>
 			<groupId>org.apache.httpcomponents</groupId>
 			<artifactId>httpclient</artifactId>
-			<version>4.5.9</version>
+			<version>4.5.14</version>
 			<scope>test</scope>
 		</dependency>
 		
@@ -111,7 +112,7 @@
 			<plugin>
 				<groupId>org.codehaus.mojo</groupId>
 				<artifactId>build-helper-maven-plugin</artifactId>
-				<version>3.2.0</version>
+				<version>3.4.0</version>
 				<executions>
 					<execution>
 						<id>add-jaxrs-src</id>
@@ -135,7 +136,7 @@
 			</plugin>
 			<plugin>
 				<artifactId>maven-surefire-plugin</artifactId>
-				<version>3.0.0-M5</version>
+				<version>3.1.0</version>
 				<dependencies>
 					<dependency>
 						<groupId>org.junit.jupiter</groupId>
@@ -146,7 +147,7 @@
 			</plugin>
 			<plugin>
 				<artifactId>maven-failsafe-plugin</artifactId>
-				<version>3.0.0-M5</version>
+				<version>3.1.0</version>
 				<dependencies>
 					<dependency>
 						<groupId>org.junit.jupiter</groupId>
@@ -155,29 +156,6 @@
 					</dependency>
 				</dependencies>
 			</plugin>
-			<plugin>
-				<artifactId>maven-source-plugin</artifactId>
-				<executions>
-					<execution>
-						<id>source</id>
-						<phase>package</phase>
-						<goals><goal>jar-no-fork</goal></goals>
-					</execution>
-				</executions>
-			</plugin>
-			<plugin>
-				<artifactId>maven-javadoc-plugin</artifactId>
-				<executions>
-					<execution>
-						<id>javadoc</id>
-						<phase>package</phase>
-						<goals><goal>jar</goal></goals>
-						<configuration>
-							<show>public</show>
-						</configuration>
-					</execution>
-				</executions>
-			</plugin>
 		</plugins>
 	</build>
 
@@ -189,6 +167,29 @@
 			</properties>
 			<build>
 				<plugins>
+					<plugin>
+						<artifactId>maven-source-plugin</artifactId>
+						<executions>
+							<execution>
+								<id>source</id>
+								<phase>package</phase>
+								<goals><goal>jar-no-fork</goal></goals>
+							</execution>
+						</executions>
+					</plugin>
+					<plugin>
+						<artifactId>maven-javadoc-plugin</artifactId>
+						<executions>
+							<execution>
+								<id>javadoc</id>
+								<phase>package</phase>
+								<goals><goal>jar</goal></goals>
+								<configuration>
+									<show>public</show>
+								</configuration>
+							</execution>
+						</executions>
+					</plugin>
 					<plugin>
 						<artifactId>maven-gpg-plugin</artifactId>
 						<executions>

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

@@ -29,6 +29,8 @@ 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 +43,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 +81,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());
 		
@@ -109,6 +137,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

@@ -18,9 +18,10 @@ import javax.ws.rs.client.ClientBuilder;
 import javax.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.jaxrs.json.JacksonJsonProvider;
 
 /**
  * A class that provides pre-configured JAX-RS Client & WebTarget objects.
@@ -66,8 +67,13 @@ public abstract class Client {
 	 * @return A pre-configured JAX-RS client (no URL) with the specified authorization.
 	 */
 	public final javax.ws.rs.client.Client buildClient(AuthorizationFilter authFilter) {
-		JacksonJsonProvider provider = new JacksonJaxbJsonProvider();
-
+	    ObjectMapper om = new ObjectMapper();
+	    om.registerModules(new JavaTimeModule());
+	    this.getConfig().configureJacksonMapper(om);
+	    
+	    JacksonJaxbJsonProvider provider = new JacksonJaxbJsonProvider(om, JacksonJaxbJsonProvider.DEFAULT_ANNOTATIONS);
+		this.getConfig().configureJacksonProvider(provider);
+        
 		if (this.getConfig().isWrapRootValueEnabled())
 			provider.enable(SerializationFeature.WRAP_ROOT_VALUE);
 		if (this.getConfig().isUnwrapRootValueEnabled())
@@ -82,16 +88,17 @@ public abstract class Client {
 		if (authFilter != null)
 			clientBuilder.register(authFilter);
 		this.buildClient(clientBuilder);
+		this.getConfig().configureClient(clientBuilder);
 		
 		return clientBuilder.build();
 	}
-	
-	/**
-	 * @param clientBuilder A client builder
-	 */
-	public void buildClient(ClientBuilder clientBuilder) {
-		// for extension purposes
-	}
+    
+    /**
+     * @param clientBuilder A client builder
+     */
+    public void buildClient(ClientBuilder clientBuilder) {
+        // for extension purposes
+    }
 
 	/**
 	 * @return A pre-configured JAX-RS target (client w/ base URL) with configured authorization.

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

@@ -16,6 +16,11 @@ 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;
+
 /**
  * This interface defines the configurable parameters of the clients; primarily
  * their default authentication and authorization.
@@ -128,6 +133,18 @@ public interface ClientConfiguration {
 	default boolean isWrapRootValueEnabled() {
 		return false;
 	}
+    
+    /**
+     * @param mapper A Jackson object mapper to configure.
+     */
+    default void configureJacksonMapper(ObjectMapper mapper) {
+    }
+	
+	/**
+	 * @param provider A Jackson JAX-RS provider to configure.
+	 */
+	default void configureJacksonProvider(JacksonJaxbJsonProvider provider) {
+	}
 	
 	
 
@@ -169,5 +186,13 @@ public interface ClientConfiguration {
 			return null;
 		}
 	}
+    
+    /**
+     * A Jackson provider, logging filter, and authentication filter are already registered.
+     * 
+     * @param clientBuilder A JAX-RS client builder to configure.
+     */
+    default void configureClient(ClientBuilder clientBuilder) {
+    }
 
 }

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;
@@ -111,29 +119,49 @@ 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);
 
-		@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 = System.currentTimeMillis() + ((Number)responseMap.get("expires_in")).longValue() * 1000L;
+		this.refreshToken = (String)responseMap.get("refresh_token");
 	}
 	
 	protected Form createRefreshForm() {
@@ -143,10 +171,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);
 	}
 
 }