Compare commits

...

11 Commits

5 changed files with 91 additions and 15 deletions

View File

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

View File

@@ -14,6 +14,8 @@
*/ */
package com.inteligr8.rs; package com.inteligr8.rs;
import org.apache.cxf.jaxrs.client.WebClient;
/** /**
* This interface defines additional configurations specific to the Apache CXF * This interface defines additional configurations specific to the Apache CXF
* JAX-RS library and its nuances. * JAX-RS library and its nuances.
@@ -35,4 +37,12 @@ public interface ClientCxfConfiguration extends ClientConfiguration {
return true; 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) {
}
} }

View File

@@ -29,6 +29,8 @@ import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired; import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component; 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; import com.fasterxml.jackson.jaxrs.json.JacksonJaxbJsonProvider;
/** /**
@@ -41,8 +43,10 @@ import com.fasterxml.jackson.jaxrs.json.JacksonJaxbJsonProvider;
public class ClientCxfImpl extends Client { public class ClientCxfImpl extends Client {
private final Logger logger = LoggerFactory.getLogger(ClientCxfImpl.class); private final Logger logger = LoggerFactory.getLogger(ClientCxfImpl.class);
private final Object sync = new Object();
private ClientCxfConfiguration config; private ClientCxfConfiguration config;
private WebClient client;
/** /**
* This constructor is for Spring or POJO use. * This constructor is for Spring or POJO use.
@@ -77,16 +81,40 @@ public class ClientCxfImpl extends Client {
* @return A CXF client (not JAX-RS). * @return A CXF client (not JAX-RS).
*/ */
public WebClient getCxfClient() { 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. * @param authFilter A post-configuration authorization filter.
* @return A CXF client (not JAX-RS). * @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>(); List<Object> providersAndFilters = new LinkedList<Object>();
providersAndFilters.add(new JacksonJaxbJsonProvider()); providersAndFilters.add(jacksonProvider);
providersAndFilters.add(new CxfLoggingFilter()); providersAndFilters.add(new CxfLoggingFilter());
providersAndFilters.add(new CxfMultipartProvider()); providersAndFilters.add(new CxfMultipartProvider());
@@ -109,6 +137,8 @@ public class ClientCxfImpl extends Client {
config.setBus(BusFactory.newInstance().createBus()); config.setBus(BusFactory.newInstance().createBus());
} }
this.config.configureClient(client);
return client; return client;
} }

View File

@@ -18,9 +18,10 @@ import javax.ws.rs.client.ClientBuilder;
import javax.ws.rs.client.WebTarget; import javax.ws.rs.client.WebTarget;
import com.fasterxml.jackson.databind.DeserializationFeature; import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.SerializationFeature; 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.JacksonJaxbJsonProvider;
import com.fasterxml.jackson.jaxrs.json.JacksonJsonProvider;
/** /**
* A class that provides pre-configured JAX-RS Client &amp; WebTarget objects. * A class that provides pre-configured JAX-RS Client &amp; WebTarget objects.
@@ -66,8 +67,16 @@ public abstract class Client {
* @return A pre-configured JAX-RS client (no URL) with the specified authorization. * @return A pre-configured JAX-RS client (no URL) with the specified authorization.
*/ */
public final javax.ws.rs.client.Client buildClient(AuthorizationFilter authFilter) { 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);
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()) if (this.getConfig().isWrapRootValueEnabled())
provider.enable(SerializationFeature.WRAP_ROOT_VALUE); provider.enable(SerializationFeature.WRAP_ROOT_VALUE);
if (this.getConfig().isUnwrapRootValueEnabled()) if (this.getConfig().isUnwrapRootValueEnabled())
@@ -83,15 +92,17 @@ public abstract class Client {
clientBuilder.register(authFilter); clientBuilder.register(authFilter);
this.buildClient(clientBuilder); this.buildClient(clientBuilder);
this.getConfig().configureClient(clientBuilder);
return clientBuilder.build(); return clientBuilder.build();
} }
/** /**
* @param clientBuilder A client builder * @param clientBuilder A client builder
*/ */
public void buildClient(ClientBuilder clientBuilder) { public void buildClient(ClientBuilder clientBuilder) {
// for extension purposes // for extension purposes
} }
/** /**
* @return A pre-configured JAX-RS target (client w/ base URL) with configured authorization. * @return A pre-configured JAX-RS target (client w/ base URL) with configured authorization.

View File

@@ -16,6 +16,11 @@ package com.inteligr8.rs;
import java.net.URI; 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 * This interface defines the configurable parameters of the clients; primarily
* their default authentication and authorization. * their default authentication and authorization.
@@ -128,6 +133,18 @@ public interface ClientConfiguration {
default boolean isWrapRootValueEnabled() { default boolean isWrapRootValueEnabled() {
return false; 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; 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) {
}
} }