Compare commits

..

6 Commits

Author SHA1 Message Date
bd7413bb48 v1.1.4 pom 2022-02-02 13:34:16 -05:00
75c518801f Merge branch 'develop' into stable 2022-02-02 13:33:47 -05:00
556909f2e9 caching underlying client 2022-02-02 13:33:36 -05:00
6fd42a8daf added minor response trace logging 2022-02-02 13:33:09 -05:00
aea7a0d035 updated jersey version 2021-12-28 14:55:01 -05:00
d3f10e4c00 added trace logging for requests 2021-12-28 14:54:36 -05:00
3 changed files with 87 additions and 7 deletions

View File

@@ -4,7 +4,7 @@
<modelVersion>4.0.0</modelVersion>
<groupId>com.inteligr8</groupId>
<artifactId>common-rest-api</artifactId>
<version>1.1.3</version>
<version>1.1.4</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>

View File

@@ -15,13 +15,21 @@ import com.fasterxml.jackson.jaxrs.json.JacksonJsonProvider;
*/
public abstract class Client {
private final Object sync = new Object();
private javax.ws.rs.client.Client client;
protected 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(null);
}
return this.client;
}
/**
@@ -29,6 +37,18 @@ 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 javax.ws.rs.client.Client buildClient(AuthorizationFilter authFilter) {
JacksonJsonProvider provider = new JacksonJaxbJsonProvider();
if (this.getConfig().isWrapRootValueEnabled())
@@ -37,7 +57,8 @@ public abstract class Client {
provider.enable(DeserializationFeature.UNWRAP_ROOT_VALUE);
ClientBuilder clientBuilder = ClientBuilder.newBuilder()
.register(provider);
.register(provider)
.register(new LoggingFilter());
if (authFilter == null)
authFilter = this.getConfig().createAuthorizationFilter();
@@ -51,7 +72,8 @@ public abstract class Client {
* @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());
}
/**
@@ -59,8 +81,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());
}
}
/**

View 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");
}
}
}