v2.0.6 pom

README.md

@@ -1,7 +1,7 @@
 
 # Common ReST Client Library
 
-This project provides a library for Spring and POJO-based REST client instantiation.  It includes special classes for the Jersey JAXRS-based client frameworks.
+This project provides a library for Spring and POJO-based REST client instantiation.
 
 ## Usage
 
@@ -15,7 +15,7 @@ First, you will need to include the library in your project.
         <dependency>
             <groupId>com.inteligr8</groupId>
             <artifactId>common-rest-client</artifactId>
-            <version>...-jersey</version>
+            <version>...</version>
         </dependency>
         ...
     </dependencies>
@@ -23,65 +23,4 @@ First, you will need to include the library in your project.
 </project>
 ```
 
-### Spring Framework
-
-#### Single Client
-
-If you will only be declaring a single client in your Spring context, this is easy.  You will just need two things.  First, inject the single client into any of your Spring beans.  You may do inject it into more than one.  An example is below:
-
-```java
-@Component
-public class ... {
-    @Autowired
-    @Qualifier("client.jersey")  // may be optional
-    private Client client;
-}
-```
-
-Next, you need to configure that client.  You can do that by providing a single implementation of the `ClientConfiguration` (or `ClientJerseyConfiguration`) interface.
-
-```java
-@Configuration
-public class ... implements ClientJerseyConfiguration {
-    ...
-}
-```
-
-#### Multiple Clients
-
-If you will or may have multiple clients in your Spring context, there is an extra step.  You will still need to define a `ClientConfiguration` for each.  On top of that, you will need to create specialized implementations of each client.  That special implementation will reference the configuration directly.  An example is below.
-
-```java
-@Component("my.client")
-public class MyClient extends ClientJerseyImpl {
-    @Autowired
-    public MyClient(MyClientConfiguration config) {
-        super(config);
-    }
-}
-```
-
-You can then inject your client(s) into your Spring beans.  Like the example below:
-
-```java
-@Component
-public class ... {
-    @Autowired
-    private MyClient client;
-
-    @PostConstruct
-    public void init() {
-        MyJaxRsApi api = this.client.getApi(MyJaxRsApi.class);
-    }
-}
-
-### POJO
-
-You do not have to use the Spring framework to use these classes.  You can instantiate them directly.  But you wil still need to create a `ClientConfiguration` as mentioned above.
-
-```java
-MyClientConfiguration config = new MyClientConfiguration();
-...
-ClientJerseyImpl client = new ClientJerseyImpl(config);
-MyJaxRsApi api = client.getApi(MyJaxRsApi.class);
-```
+See the `cxf` and `jersey` branches for examples and more documentation.

pom.xml

@@ -6,11 +6,11 @@
 	
 	<groupId>com.inteligr8</groupId>
 	<artifactId>common-rest-client</artifactId>
-	<version>2.0.1-jersey</version>
+	<version>2.0.6</version>
 	<packaging>jar</packaging>
 
 	<name>ReST API Client for Java</name>
-	<description>A common library for building Jersey REST API clients</description>
+	<description>A common library for building REST API clients</description>
 	<url>https://bitbucket.org/inteligr8/common-rest-client</url>
 
 	<licenses>
@@ -44,11 +44,16 @@
 		<maven.compiler.target>8</maven.compiler.target>
 
 		<junit.version>5.7.2</junit.version>
-		<spring.version>5.2.14.RELEASE</spring.version>
-		<jersey.version>2.35</jersey.version>
+		<spring.version>5.3.27</spring.version>
+		<jackson.version>2.15.1</jackson.version>
 	</properties>
 
 	<dependencies>
+		<dependency>
+			<groupId>javax.annotation</groupId>
+			<artifactId>javax.annotation-api</artifactId>
+			<version>1.3.2</version>
+		</dependency>
 		<dependency>
 			<groupId>org.springframework</groupId>
 			<artifactId>spring-context</artifactId>
@@ -57,22 +62,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,70 +99,16 @@
 		<dependency>
 			<groupId>org.apache.httpcomponents</groupId>
 			<artifactId>httpclient</artifactId>
-			<version>4.5.9</version>
-			<scope>test</scope>
-		</dependency>
-		
-		<!-- Jersey libraries -->
-		<dependency>
-			<groupId>org.glassfish.jersey.ext</groupId>
-			<artifactId>jersey-proxy-client</artifactId>
-			<version>${jersey.version}</version>
-		</dependency>
-		<dependency>
-			<groupId>org.glassfish.jersey.core</groupId>
-			<artifactId>jersey-client</artifactId>
-			<version>${jersey.version}</version>
-		</dependency>
-		<dependency>
-			<groupId>org.glassfish.jersey.media</groupId>
-			<artifactId>jersey-media-multipart</artifactId>
-			<version>${jersey.version}</version>
-		</dependency>
-		<dependency>
-			<groupId>org.glassfish.jersey.inject</groupId>
-			<artifactId>jersey-hk2</artifactId>
-			<version>${jersey.version}</version>
-			<scope>test</scope>
-		</dependency>
-		<dependency>
-			<groupId>org.glassfish.jersey.media</groupId>
-			<artifactId>jersey-media-json-jackson</artifactId>
-			<version>${jersey.version}</version>
+			<version>4.5.14</version>
 			<scope>test</scope>
 		</dependency>
 	</dependencies>
 	
 	<build>
 		<plugins>
-			<plugin>
-				<groupId>org.codehaus.mojo</groupId>
-				<artifactId>build-helper-maven-plugin</artifactId>
-				<version>3.2.0</version>
-				<executions>
-					<execution>
-						<id>add-jaxrs-src</id>
-						<goals><goal>add-source</goal></goals>
-						<configuration>
-							<sources>
-								<source>src/main/jersey</source>
-							</sources>
-						</configuration>
-					</execution>
-					<execution>
-						<id>add-test-src</id>
-						<goals><goal>add-test-source</goal></goals>
-						<configuration>
-							<sources>
-								<source>src/test/jersey</source>
-							</sources>
-						</configuration>
-					</execution>
-				</executions>
-			</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>
@@ -168,7 +119,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>
@@ -177,29 +128,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>
 
@@ -211,6 +139,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/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

@@ -16,12 +16,7 @@ package com.inteligr8.rs;
 
 import javax.annotation.PostConstruct;
 import javax.ws.rs.client.ClientBuilder;
-import javax.ws.rs.ext.RuntimeDelegate;
 
-import org.glassfish.jersey.client.ClientProperties;
-import org.glassfish.jersey.client.proxy.WebResourceFactory;
-import org.glassfish.jersey.internal.RuntimeDelegateImpl;
-import org.glassfish.jersey.media.multipart.MultiPartFeature;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.annotation.Autowired;
@@ -33,19 +28,19 @@ import org.springframework.stereotype.Component;
  * 
  * @author brian@inteligr8.com
  */
-@Component("client.jersey")
-public class ClientJerseyImpl extends Client {
+@Component("client.jaxrs")
+public class ClientImpl extends Client {
 	
-	private final Logger logger = LoggerFactory.getLogger(ClientJerseyImpl.class);
+	private final Logger logger = LoggerFactory.getLogger(ClientImpl.class);
 	
-	private ClientJerseyConfiguration config;
+	private ClientConfiguration config;
 	
 	/**
 	 * This constructor is for Spring or POJO use.
 	 * @param config The client configuration.
 	 */
 	@Autowired
-	public ClientJerseyImpl(ClientJerseyConfiguration config) {
+	public ClientImpl(ClientConfiguration config) {
 		this.config = config;
 	}
 
@@ -55,18 +50,7 @@ public class ClientJerseyImpl extends Client {
 	 */
 	@PostConstruct
 	public void register() {
-		if (RuntimeDelegate.getInstance() == null) {
-			this.logger.info("Setting JAX-RS runtime delegate to the Jersey library");
-			RuntimeDelegate.setInstance(new RuntimeDelegateImpl());
-		} else if (RuntimeDelegate.getInstance() instanceof RuntimeDelegateImpl) {
-			this.logger.info("JAX-RS runtime delegate already the Jersey library");
-		} else {
-			this.logger.warn("Setting JAX-RS runtime delegate to the Jersey library; was: " + RuntimeDelegate.getInstance().getClass().getName());
-			RuntimeDelegate.setInstance(new RuntimeDelegateImpl());
-		}
-		
-		if (this.logger.isInfoEnabled())
-			this.logger.info("API Base URL: " + this.getConfig().getBaseUrl());
+		this.logger.info("API Base URL: {}", this.getConfig().getBaseUrl());
 	}
 	
 	/**
@@ -74,18 +58,12 @@ public class ClientJerseyImpl extends Client {
 	 */
 	@Override
 	public void buildClient(ClientBuilder clientBuilder) {
-		clientBuilder.register(MultiPartFeature.class);
-
-		if (!this.getConfig().isPutBodyRequired()) {
-			// allow PUT operations without body data
-			clientBuilder.property(ClientProperties.SUPPRESS_HTTP_COMPLIANCE_VALIDATION, true);
-		}
 	}
 	
 	/**
 	 * @return The client configuration.
 	 */
-	public ClientJerseyConfiguration getConfig() {
+	public ClientConfiguration getConfig() {
 		return this.config;
 	}
 
@@ -99,7 +77,7 @@ public class ClientJerseyImpl extends Client {
 	 */
 	@Override
 	public <T> T getApi(AuthorizationFilter authFilter, Class<T> apiClass) {
-		return WebResourceFactory.newResource(apiClass, this.getTarget(authFilter));
+		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);
 	}
 
 }

src/main/jersey/com/inteligr8/rs/ClientJerseyConfiguration.java

@@ -1,35 +0,0 @@
-/*
- * 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;
-
-/**
- * This interface defines additional configurations specific to the Jersey
- * JAX-RS library and its nuances.
- * 
- * @author brian@inteligr8.com
- */
-public interface ClientJerseyConfiguration extends ClientConfiguration {
-	
-	/**
-	 * Jersey is automatically strict in its adherence to the ReST API
-	 * specifications.  It requires a body to PUT calls by default.
-	 * 
-	 * @return true to require body in PUT calls; false to make it optional
-	 */
-	default boolean isPutBodyRequired() {
-		return true;
-	}
-
-}