v1.1.6 pom

pom.xml

@@ -4,7 +4,7 @@
 	<modelVersion>4.0.0</modelVersion>
 	<groupId>com.inteligr8</groupId>
 	<artifactId>common-rest-api</artifactId>
-	<version>1.1.4</version>
+	<version>1.1.6</version>
 	<name>ReST API Client for Java</name>
 
 	<properties>
@@ -39,6 +39,11 @@
 			<artifactId>jackson-datatype-jsr310</artifactId>
 			<version>2.12.2</version>
 		</dependency>
+		<dependency>
+			<groupId>org.glassfish.jersey.media</groupId>
+			<artifactId>jersey-media-multipart</artifactId>
+			<version>${jersey.version}</version>
+		</dependency>
 		<dependency>
 			<groupId>org.slf4j</groupId>
 			<artifactId>slf4j-api</artifactId>

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

@@ -26,7 +26,7 @@ public abstract class Client {
 	public final javax.ws.rs.client.Client getClient() {
 		synchronized (this.sync) {
 			if (this.client == null)
-				this.client = this.buildClient(null);
+				this.client = this.buildClient((AuthorizationFilter)null);
 		}
 
 		return this.client;
@@ -48,7 +48,7 @@ public abstract class Client {
 	 * @param authFilter A dynamic authorization filter.
 	 * @return A pre-configured JAX-RS client (no URL) with the specified authorization.
 	 */
-	public javax.ws.rs.client.Client buildClient(AuthorizationFilter authFilter) {
+	public final javax.ws.rs.client.Client buildClient(AuthorizationFilter authFilter) {
 		JacksonJsonProvider provider = new JacksonJaxbJsonProvider();
 
 		if (this.getConfig().isWrapRootValueEnabled())
@@ -64,10 +64,15 @@ public abstract class Client {
 			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.
 	 */

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

@@ -66,12 +66,16 @@ 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
 		WebClient client = WebClient.create(this.getConfig().getBaseUrl(), providersAndFilters);
@@ -87,6 +91,10 @@ public abstract class ClientCxfImpl extends Client implements InitializingBean {
 		return client;
 	}
 	
+	public void addProvidersAndFilters(List<Object> providersAndFilters) {
+		// for extension purposes
+	}
+
 	/**
 	 * This method retrieves a JAX-RS implementation of the specified API with
 	 * the specified authorization.

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

@@ -1,10 +1,12 @@
 package com.inteligr8.rs;
 
+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;
@@ -46,20 +48,14 @@ 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;
 	}
 
 	/**

src/main/java/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/java/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/LoggingFilter.java

@@ -12,6 +12,7 @@ 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 {
@@ -19,27 +20,37 @@ public class LoggingFilter implements ClientRequestFilter, ClientResponseFilter
 	private final Logger loggerRequest = LoggerFactory.getLogger("jaxrs.request");
 	private final Logger loggerResponse = LoggerFactory.getLogger("jaxrs.response");
 	
-	private final ObjectMapper om = new ObjectMapper();
+	protected final ObjectMapper om = new ObjectMapper().setSerializationInclusion(Include.NON_NULL);
 	
 	@Override
 	public void filter(ClientRequestContext requestContext) throws IOException {
-		if (this.loggerRequest.isTraceEnabled()) {
+		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())) {
-				this.loggerRequest.trace("request: {} {}: {}", requestContext.getMethod(), requestContext.getUri(),
+			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) {
-					this.loggerRequest.trace("request: {} {}: {}", requestContext.getMethod(), requestContext.getUri(),
+				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 if (requestContext.getMediaType() != null) {
-				this.loggerRequest.trace("request '{}': {} {}", requestContext.getMediaType(), requestContext.getMethod(), requestContext.getUri());
 		} else {
-				this.loggerRequest.trace("request: {} {}", requestContext.getMethod(), requestContext.getUri());
+			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

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() {
@@ -127,4 +129,10 @@ public abstract class OAuthAuthorizationFilter implements AuthorizationFilter {
 	
 	protected abstract Form createForm();
 	
+	protected void extendRefreshTokenForm(Form form) {
+	}
+	
+	protected void extendRefreshTokenResponse(Map<String, Object> response) {
+	}
+
 }