Merge branch 'develop' into stable

pom.xml

@@ -3,8 +3,8 @@
 		xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
 	<modelVersion>4.0.0</modelVersion>
 	<groupId>com.inteligr8</groupId>
-	<artifactId>common-rest-api</artifactId>
-	<version>1.1.2</version>
+	<artifactId>common-rest-client</artifactId>
+	<version>2.0.0</version>
 	<name>ReST API Client for Java</name>
 
 	<properties>
@@ -14,7 +14,7 @@
 
 		<junit.version>5.7.2</junit.version>
 		<spring.version>5.2.14.RELEASE</spring.version>
-		<jersey.version>2.34</jersey.version>
+		<jersey.version>2.35</jersey.version>
 		<cxf.version>3.3.2</cxf.version>
 	</properties>
 
@@ -34,6 +34,11 @@
 			<artifactId>jackson-jaxrs-json-provider</artifactId>
 			<version>2.12.2</version>
 		</dependency>
+		<dependency>
+			<groupId>com.fasterxml.jackson.datatype</groupId>
+			<artifactId>jackson-datatype-jsr310</artifactId>
+			<version>2.12.2</version>
+		</dependency>
 		<dependency>
 			<groupId>org.slf4j</groupId>
 			<artifactId>slf4j-api</artifactId>
@@ -44,36 +49,6 @@
 			<artifactId>jakarta.ws.rs-api</artifactId>
 			<version>2.1.6</version>
 		</dependency>
-		<dependency>
-			<groupId>org.glassfish.jersey.ext</groupId>
-			<artifactId>jersey-proxy-client</artifactId>
-			<version>${jersey.version}</version>
-			<scope>provided</scope>
-		</dependency>
-		<dependency>
-			<groupId>org.glassfish.jersey.core</groupId>
-			<artifactId>jersey-client</artifactId>
-			<version>${jersey.version}</version>
-			<scope>provided</scope>
-		</dependency>
-		<dependency>
-			<groupId>org.apache.cxf</groupId>
-			<artifactId>cxf-rt-rs-client</artifactId>
-			<version>${cxf.version}</version>
-			<scope>provided</scope>
-		</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>
-			<scope>test</scope>
-		</dependency>
 		<dependency>
 			<groupId>org.junit.jupiter</groupId>
 			<artifactId>junit-jupiter-api</artifactId>
@@ -96,6 +71,37 @@
 	
 	<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/${jaxrs.impl}</source>
+							</sources>
+						</configuration>
+					</execution>
+					<execution>
+						<id>add-test-src</id>
+						<goals><goal>add-test-source</goal></goals>
+						<configuration>
+							<sources>
+								<source>src/test/${jaxrs.impl}</source>
+							</sources>
+						</configuration>
+					</execution>
+				</executions>
+			</plugin>
+			<plugin>
+				<artifactId>maven-jar-plugin</artifactId>
+				<configuration>
+					<classifier>${jaxrs.impl}</classifier>
+				</configuration>
+			</plugin>
 			<plugin>
 				<artifactId>maven-surefire-plugin</artifactId>
 				<version>3.0.0-M5</version>
@@ -134,6 +140,70 @@
 		</plugins>
 	</build>
 	
+	<profiles>
+		<profile>
+			<id>jaxrs-jersey</id>
+			<activation>
+				<activeByDefault>true</activeByDefault>
+				<property>
+					<name>jaxrs.impl</name>
+					<value>jersey</value>
+				</property>
+			</activation>
+			<properties>
+				<jaxrs.impl>jersey</jaxrs.impl>
+			</properties>
+			<dependencies>
+				<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>
+					<scope>test</scope>
+				</dependency>
+			</dependencies>
+		</profile>
+		<profile>
+			<id>jaxrs-cxf</id>
+			<activation>
+				<property>
+					<name>jaxrs.impl</name>
+					<value>cxf</value>
+				</property>
+			</activation>
+			<properties>
+				<jaxrs.impl>cxf</jaxrs.impl>
+			</properties>
+			<dependencies>
+				<dependency>
+					<groupId>org.apache.cxf</groupId>
+					<artifactId>cxf-rt-rs-client</artifactId>
+					<version>${cxf.version}</version>
+				</dependency>
+			</dependencies>
+		</profile>
+	</profiles>
+	
 	<pluginRepositories>
 		<pluginRepository>
 			<id>inteligr8-public</id>

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

@@ -3,6 +3,7 @@ package com.inteligr8.rs;
 import java.util.LinkedList;
 import java.util.List;
 
+import javax.annotation.PostConstruct;
 import javax.ws.rs.ext.RuntimeDelegate;
 
 import org.apache.cxf.BusFactory;
@@ -11,7 +12,8 @@ import org.apache.cxf.jaxrs.client.WebClient;
 import org.apache.cxf.jaxrs.impl.RuntimeDelegateImpl;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
-import org.springframework.beans.factory.InitializingBean;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.stereotype.Component;
 
 import com.fasterxml.jackson.jaxrs.json.JacksonJaxbJsonProvider;
 
@@ -21,22 +23,26 @@ import com.fasterxml.jackson.jaxrs.json.JacksonJaxbJsonProvider;
  * 
  * @author brian@inteligr8.com
  */
-public abstract class ClientCxfImpl extends Client implements InitializingBean {
+@Component("client.cxf")
+public class ClientCxfImpl extends Client {
 	
 	private final Logger logger = LoggerFactory.getLogger(ClientCxfImpl.class);
 	
-	@Override
-	protected abstract ClientCxfConfiguration getConfig();
+	private ClientCxfConfiguration config;
 	
-	@Override
-	public void afterPropertiesSet() {
-		this.register();
+	/**
+	 * This constructor is for Spring or POJO use
+	 */
+	@Autowired
+	public ClientCxfImpl(ClientCxfConfiguration config) {
+		this.config = config;
 	}
 	
 	/**
 	 * This method registers the Apache CXF library as the default provider for
 	 * the JAX-RS specification.
 	 */
+	@PostConstruct
 	public void register() {
 		if (RuntimeDelegate.getInstance() == null) {
 			this.logger.info("Setting JAX-RS runtime delegate to the CXF library");
@@ -66,11 +72,15 @@ public abstract class ClientCxfImpl extends Client implements InitializingBean {
 	public WebClient getCxfClient(AuthorizationFilter authFilter) {
 		List<Object> providersAndFilters = new LinkedList<Object>();
 		providersAndFilters.add(new JacksonJaxbJsonProvider());
+		providersAndFilters.add(new CxfLoggingFilter());
+		providersAndFilters.add(new CxfMultipartProvider());
 		
 		if (authFilter == null)
 			authFilter = this.getConfig().createAuthorizationFilter();
 		if (authFilter != null)
 			providersAndFilters.add(authFilter);
+		
+		this.addProvidersAndFilters(providersAndFilters);
 
 		// we can't use JAXRSClientFactory with a JAXRS client (duh!)
 		// so we need to create a CXF client
@@ -86,6 +96,14 @@ public abstract class ClientCxfImpl extends Client implements InitializingBean {
 		
 		return client;
 	}
+	
+	public void addProvidersAndFilters(List<Object> providersAndFilters) {
+		// for extension purposes
+	}
+	
+	public ClientCxfConfiguration getConfig() {
+		return this.config;
+	}
 
 	/**
 	 * This method retrieves a JAX-RS implementation of the specified API with

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

@@ -0,0 +1,30 @@
+package com.inteligr8.rs;
+
+import java.io.IOException;
+import java.util.LinkedList;
+import java.util.List;
+
+import javax.ws.rs.client.ClientRequestContext;
+import javax.ws.rs.core.MediaType;
+
+import org.apache.cxf.jaxrs.ext.multipart.Attachment;
+import org.apache.cxf.jaxrs.ext.multipart.MultipartBody;
+import org.slf4j.Logger;
+
+public class CxfLoggingFilter extends LoggingFilter {
+	
+	@Override
+	protected void logUnhandledRequest(ClientRequestContext requestContext, Logger logger) throws IOException {
+		if (MediaType.MULTIPART_FORM_DATA_TYPE.equals(requestContext.getMediaType())) {
+			if (requestContext.getEntity() instanceof MultipartBody) {
+				List<String> attIds = new LinkedList<>();
+				for (Attachment att : ((MultipartBody)requestContext.getEntity()).getAllAttachments())
+					attIds.add(att.getContentId());
+				logger.trace("request: {} {}: {}", requestContext.getMethod(), requestContext.getUri(), attIds);
+			} else {
+				logger.trace("request: {} {}: failed to output form", requestContext.getMethod(), requestContext.getUri());
+			}
+		}
+	}
+
+}

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

@@ -0,0 +1,29 @@
+package com.inteligr8.rs;
+
+import java.lang.annotation.Annotation;
+import java.lang.reflect.Type;
+
+import javax.ws.rs.Consumes;
+import javax.ws.rs.Produces;
+import javax.ws.rs.core.MediaType;
+import javax.ws.rs.ext.Provider;
+
+import org.apache.cxf.jaxrs.ext.multipart.MultipartBody;
+import org.apache.cxf.jaxrs.provider.MultipartProvider;
+
+@Consumes(MediaType.MULTIPART_FORM_DATA)
+@Produces(MediaType.MULTIPART_FORM_DATA)
+@Provider
+public class CxfMultipartProvider extends MultipartProvider {
+	
+	@Override
+	public boolean isReadable(Class<?> type, Type genericType, Annotation[] annotations, MediaType mediaType) {
+		return MultipartBody.class.isAssignableFrom(type) || this.isReadable(type, genericType, annotations, mediaType);
+	}
+	
+	@Override
+	public boolean isWriteable(Class<?> type, Type genericType, Annotation[] annotations, MediaType mediaType) {
+		return MultipartBody.class.isAssignableFrom(type) || this.isWriteable(type, genericType, annotations, mediaType);
+	}
+
+}

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

@@ -3,7 +3,10 @@ package com.inteligr8.rs;
 import javax.ws.rs.client.ClientBuilder;
 import javax.ws.rs.client.WebTarget;
 
+import com.fasterxml.jackson.databind.DeserializationFeature;
+import com.fasterxml.jackson.databind.SerializationFeature;
 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.
@@ -12,13 +15,21 @@ import com.fasterxml.jackson.jaxrs.json.JacksonJaxbJsonProvider;
  */
 public abstract class Client {
 	
-	protected abstract ClientConfiguration getConfig();
+	private final Object sync = new Object();
+	private javax.ws.rs.client.Client client;
+	
+	public abstract ClientConfiguration getConfig();
 	
 	/**
 	 * @return A pre-configured JAX-RS client (no URL) with configured authorization.
 	 */
 	public final javax.ws.rs.client.Client getClient() {
-		return this.getClient(null);
+		synchronized (this.sync) {
+			if (this.client == null)
+				this.client = this.buildClient((AuthorizationFilter)null);
+		}
+
+		return this.client;
 	}
 	
 	/**
@@ -26,22 +37,48 @@ public abstract class Client {
 	 * @return A pre-configured JAX-RS client (no URL) with the specified authorization.
 	 */
 	public javax.ws.rs.client.Client getClient(AuthorizationFilter authFilter) {
+		if (authFilter == null) {
+			return this.getClient();
+		} else {
+			return this.buildClient(authFilter);
+		}
+	}
+	
+	/**
+	 * @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) {
+		JacksonJsonProvider provider = new JacksonJaxbJsonProvider();
+
+		if (this.getConfig().isWrapRootValueEnabled())
+			provider.enable(SerializationFeature.WRAP_ROOT_VALUE);
+		if (this.getConfig().isUnwrapRootValueEnabled())
+			provider.enable(DeserializationFeature.UNWRAP_ROOT_VALUE);
+		
 		ClientBuilder clientBuilder = ClientBuilder.newBuilder()
-				.register(new JacksonJaxbJsonProvider());
+				.register(provider)
+				.register(new LoggingFilter());
 
 		if (authFilter == null)
 			authFilter = this.getConfig().createAuthorizationFilter();
 		if (authFilter != null)
 			clientBuilder.register(authFilter);
+		this.buildClient(clientBuilder);
 		
 		return clientBuilder.build();
 	}
+	
+	public void buildClient(ClientBuilder clientBuilder) {
+		// for extension purposes
+	}
 
 	/**
 	 * @return A pre-configured JAX-RS target (client w/ base URL) with configured authorization.
 	 */
 	public final WebTarget getTarget() {
-		return this.getTarget(null);
+		return this.getClient()
+				.target(this.getConfig().getBaseUrl());
 	}
 
 	/**
@@ -49,8 +86,12 @@ public abstract class Client {
 	 * @return A pre-configured JAX-RS target (client w/ base URL) with the specified authorization.
 	 */
 	public WebTarget getTarget(AuthorizationFilter authFilter) {
-		return this.getClient(authFilter)
-				.target(this.getConfig().getBaseUrl());
+		if (authFilter == null) {
+			return this.getTarget();
+		} else {
+			return this.getClient(authFilter)
+					.target(this.getConfig().getBaseUrl());
+		}
 	}
 	
 	/**

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

@@ -98,6 +98,24 @@ public interface ClientConfiguration {
 	default String getOAuthPassword() {
 		return null;
 	}
+	
+	
+
+	/**
+	 * @return true to enable Jackson UNWRAP_ROOT_VALUE feature; false otherwise.
+	 */
+	default boolean isUnwrapRootValueEnabled() {
+		return false;
+	}
+
+	/**
+	 * @return true to enable Jackson WRAP_ROOT_VALUE feature; false otherwise.
+	 */
+	default boolean isWrapRootValueEnabled() {
+		return false;
+	}
+	
+	
 
 	/**
 	 * This method creates an authorization filter based on the configuration

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

@@ -0,0 +1,65 @@
+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 org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import com.fasterxml.jackson.annotation.JsonInclude.Include;
+import com.fasterxml.jackson.databind.ObjectMapper;
+
+public class LoggingFilter implements ClientRequestFilter, ClientResponseFilter {
+	
+	private final Logger loggerRequest = LoggerFactory.getLogger("jaxrs.request");
+	private final Logger loggerResponse = LoggerFactory.getLogger("jaxrs.response");
+	
+	protected final ObjectMapper om = new ObjectMapper().setSerializationInclusion(Include.NON_NULL);
+	
+	@Override
+	public void filter(ClientRequestContext requestContext) throws IOException {
+		if (this.loggerRequest.isTraceEnabled())
+			this.logAnyRequest(requestContext, this.loggerRequest);
+	}
+	
+	protected void logAnyRequest(ClientRequestContext requestContext, Logger logger) throws IOException {
+		if (MediaType.APPLICATION_JSON_TYPE.equals(requestContext.getMediaType())) {
+			logger.trace("request: {} {}: {}", requestContext.getMethod(), requestContext.getUri(),
+					this.om.writeValueAsString(requestContext.getEntity()));
+		} else if (MediaType.APPLICATION_FORM_URLENCODED_TYPE.equals(requestContext.getMediaType())) {
+			if (requestContext.getEntity() instanceof Form) {
+				logger.trace("request: {} {}: {}", requestContext.getMethod(), requestContext.getUri(),
+						((Form)requestContext.getEntity()).asMap());
+			} else {
+				this.loggerRequest.trace("request: {} {}: failed to output form", requestContext.getMethod(), requestContext.getUri());
+			}
+		} else {
+			this.logUnhandledRequest(requestContext, logger);
+		}
+	}
+	
+	protected void logUnhandledRequest(ClientRequestContext requestContext, Logger logger) throws IOException {
+		if (requestContext.getMediaType() != null) {
+			logger.trace("request '{}': {} {}", requestContext.getMediaType(), requestContext.getMethod(), requestContext.getUri());
+		} else {
+			logger.trace("request: {} {}", requestContext.getMethod(), requestContext.getUri());
+		}
+		
+	}
+	
+	@Override
+	public void filter(ClientRequestContext requestContext, ClientResponseContext responseContext) throws IOException {
+		if (this.loggerResponse.isTraceEnabled()) {
+			this.loggerResponse.trace("response: {} ", this.om.writeValueAsString(responseContext.getStatus()));
+			// WARN body is stream, which would need to be replaced after read
+			this.loggerResponse.warn("response: NOT YET SUPPORTED");
+		}
+	}
+
+}

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

@@ -101,6 +101,7 @@ public abstract class OAuthAuthorizationFilter implements AuthorizationFilter {
 			form.param("client_secret", this.clientSecret);
 		if (this.scope != null)
 			form.param("scope", this.scope);
+		this.extendRefreshTokenForm(form);
 		
 		Entity<Form> entity = Entity.form(form);
 		
@@ -118,6 +119,7 @@ public abstract class OAuthAuthorizationFilter implements AuthorizationFilter {
 		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);
 	}
 	
 	protected Form createRefreshForm() {
@@ -126,5 +128,11 @@ public abstract class OAuthAuthorizationFilter implements AuthorizationFilter {
 	}
 	
 	protected abstract Form createForm();
+	
+	protected void extendRefreshTokenForm(Form form) {
+	}
+	
+	protected void extendRefreshTokenResponse(Map<String, Object> response) {
+	}
 
 }

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

@@ -1,13 +1,17 @@
 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.InitializingBean;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.stereotype.Component;
 
 /**
  * A class that provides pre-configured JAX-RS Client & WebTarget objects
@@ -15,22 +19,26 @@ import org.springframework.beans.factory.InitializingBean;
  * 
  * @author brian@inteligr8.com
  */
-public abstract class ClientJerseyImpl extends Client implements InitializingBean {
+@Component("client.jersey")
+public class ClientJerseyImpl extends Client {
 	
 	private final Logger logger = LoggerFactory.getLogger(ClientJerseyImpl.class);
 	
-	@Override
-	protected abstract ClientJerseyConfiguration getConfig();
+	private ClientJerseyConfiguration config;
 	
-	@Override
-	public void afterPropertiesSet() {
-		this.register();
+	/**
+	 * This constructor is for Spring or POJO use
+	 */
+	@Autowired
+	public ClientJerseyImpl(ClientJerseyConfiguration config) {
+		this.config = config;
 	}
 
 	/**
 	 * This method registers the Jersey library as the default provider for the
 	 * JAX-RS specification.
 	 */
+	@PostConstruct
 	public void register() {
 		if (RuntimeDelegate.getInstance() == null) {
 			this.logger.info("Setting JAX-RS runtime delegate to the Jersey library");
@@ -46,20 +54,18 @@ public abstract class ClientJerseyImpl extends Client implements InitializingBea
 			this.logger.info("API Base URL: " + this.getConfig().getBaseUrl());
 	}
 	
-	/**
-	 * @param authFilter A post-configuration authorization filter.
-	 * @return A JAX-RS client.
-	 */
 	@Override
-	public javax.ws.rs.client.Client getClient(AuthorizationFilter authFilter) {
-		javax.ws.rs.client.Client client = super.getClient(authFilter);
-		
+	public void buildClient(ClientBuilder clientBuilder) {
+		clientBuilder.register(MultiPartFeature.class);
+
 		if (!this.getConfig().isPutBodyRequired()) {
 			// allow PUT operations without body data
-			client.property(ClientProperties.SUPPRESS_HTTP_COMPLIANCE_VALIDATION, true);
+			clientBuilder.property(ClientProperties.SUPPRESS_HTTP_COMPLIANCE_VALIDATION, true);
 		}
-		
-		return client;
+	}
+	
+	public ClientJerseyConfiguration getConfig() {
+		return this.config;
 	}
 
 	/**