Compare commits
9 Commits
Author | SHA1 | Date | |
---|---|---|---|
bd7413bb48 | |||
75c518801f | |||
556909f2e9 | |||
6fd42a8daf | |||
aea7a0d035 | |||
d3f10e4c00 | |||
b3bc04467b | |||
88c8657a34 | |||
2c4f4f7285 |
9
pom.xml
9
pom.xml
@@ -4,7 +4,7 @@
|
|||||||
<modelVersion>4.0.0</modelVersion>
|
<modelVersion>4.0.0</modelVersion>
|
||||||
<groupId>com.inteligr8</groupId>
|
<groupId>com.inteligr8</groupId>
|
||||||
<artifactId>common-rest-api</artifactId>
|
<artifactId>common-rest-api</artifactId>
|
||||||
<version>1.1.2</version>
|
<version>1.1.4</version>
|
||||||
<name>ReST API Client for Java</name>
|
<name>ReST API Client for Java</name>
|
||||||
|
|
||||||
<properties>
|
<properties>
|
||||||
@@ -14,7 +14,7 @@
|
|||||||
|
|
||||||
<junit.version>5.7.2</junit.version>
|
<junit.version>5.7.2</junit.version>
|
||||||
<spring.version>5.2.14.RELEASE</spring.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>
|
<cxf.version>3.3.2</cxf.version>
|
||||||
</properties>
|
</properties>
|
||||||
|
|
||||||
@@ -34,6 +34,11 @@
|
|||||||
<artifactId>jackson-jaxrs-json-provider</artifactId>
|
<artifactId>jackson-jaxrs-json-provider</artifactId>
|
||||||
<version>2.12.2</version>
|
<version>2.12.2</version>
|
||||||
</dependency>
|
</dependency>
|
||||||
|
<dependency>
|
||||||
|
<groupId>com.fasterxml.jackson.datatype</groupId>
|
||||||
|
<artifactId>jackson-datatype-jsr310</artifactId>
|
||||||
|
<version>2.12.2</version>
|
||||||
|
</dependency>
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>org.slf4j</groupId>
|
<groupId>org.slf4j</groupId>
|
||||||
<artifactId>slf4j-api</artifactId>
|
<artifactId>slf4j-api</artifactId>
|
||||||
|
@@ -3,7 +3,10 @@ package com.inteligr8.rs;
|
|||||||
import javax.ws.rs.client.ClientBuilder;
|
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.SerializationFeature;
|
||||||
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 & WebTarget objects.
|
* 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 {
|
public abstract class Client {
|
||||||
|
|
||||||
|
private final Object sync = new Object();
|
||||||
|
private javax.ws.rs.client.Client client;
|
||||||
|
|
||||||
protected abstract ClientConfiguration getConfig();
|
protected abstract ClientConfiguration getConfig();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @return A pre-configured JAX-RS client (no URL) with configured authorization.
|
* @return A pre-configured JAX-RS client (no URL) with configured authorization.
|
||||||
*/
|
*/
|
||||||
public final javax.ws.rs.client.Client getClient() {
|
public final javax.ws.rs.client.Client getClient() {
|
||||||
return this.getClient(null);
|
synchronized (this.sync) {
|
||||||
|
if (this.client == null)
|
||||||
|
this.client = this.buildClient(null);
|
||||||
|
}
|
||||||
|
|
||||||
|
return this.client;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -26,8 +37,28 @@ 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 javax.ws.rs.client.Client getClient(AuthorizationFilter authFilter) {
|
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 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()
|
ClientBuilder clientBuilder = ClientBuilder.newBuilder()
|
||||||
.register(new JacksonJaxbJsonProvider());
|
.register(provider)
|
||||||
|
.register(new LoggingFilter());
|
||||||
|
|
||||||
if (authFilter == null)
|
if (authFilter == null)
|
||||||
authFilter = this.getConfig().createAuthorizationFilter();
|
authFilter = this.getConfig().createAuthorizationFilter();
|
||||||
@@ -41,7 +72,8 @@ public abstract class Client {
|
|||||||
* @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.
|
||||||
*/
|
*/
|
||||||
public final WebTarget getTarget() {
|
public final WebTarget getTarget() {
|
||||||
return this.getTarget(null);
|
return this.getClient()
|
||||||
|
.target(this.getConfig().getBaseUrl());
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -49,9 +81,13 @@ public abstract class Client {
|
|||||||
* @return A pre-configured JAX-RS target (client w/ base URL) with the specified authorization.
|
* @return A pre-configured JAX-RS target (client w/ base URL) with the specified authorization.
|
||||||
*/
|
*/
|
||||||
public WebTarget getTarget(AuthorizationFilter authFilter) {
|
public WebTarget getTarget(AuthorizationFilter authFilter) {
|
||||||
|
if (authFilter == null) {
|
||||||
|
return this.getTarget();
|
||||||
|
} else {
|
||||||
return this.getClient(authFilter)
|
return this.getClient(authFilter)
|
||||||
.target(this.getConfig().getBaseUrl());
|
.target(this.getConfig().getBaseUrl());
|
||||||
}
|
}
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* This method retrieves a JAX-RS implementation of the specified API.
|
* This method retrieves a JAX-RS implementation of the specified API.
|
||||||
|
@@ -99,6 +99,24 @@ public interface ClientConfiguration {
|
|||||||
return null;
|
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
|
* This method creates an authorization filter based on the configuration
|
||||||
* available. A configuration element is considered to not be available
|
* available. A configuration element is considered to not be available
|
||||||
|
54
src/main/java/com/inteligr8/rs/LoggingFilter.java
Normal file
54
src/main/java/com/inteligr8/rs/LoggingFilter.java
Normal file
@@ -0,0 +1,54 @@
|
|||||||
|
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.databind.ObjectMapper;
|
||||||
|
|
||||||
|
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();
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public void filter(ClientRequestContext requestContext) throws IOException {
|
||||||
|
if (this.loggerRequest.isTraceEnabled()) {
|
||||||
|
if (MediaType.APPLICATION_JSON_TYPE.equals(requestContext.getMediaType())) {
|
||||||
|
this.loggerRequest.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(),
|
||||||
|
((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());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@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");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
Reference in New Issue
Block a user