Compare commits

..

2 Commits

Author SHA1 Message Date
ed00346e71 v2.0.2 pom 2023-05-29 10:15:38 -04:00
c001576b65 Merge branch 'develop' into stable 2023-05-29 10:11:16 -04:00
19 changed files with 91 additions and 750 deletions

View File

@@ -1,7 +1,7 @@
# Common ReST Client Library # Common ReST Client Library
This project provides a library for Spring and POJO-based REST client instantiation. It includes special classes with classifiers for two popular JAXRS-based client frameworks: Apache CXF and Jersey. This project provides a library for Spring and POJO-based REST client instantiation.
## Usage ## Usage
@@ -15,7 +15,6 @@ First, you will need to include the library in your project.
<dependency> <dependency>
<groupId>com.inteligr8</groupId> <groupId>com.inteligr8</groupId>
<artifactId>common-rest-client</artifactId> <artifactId>common-rest-client</artifactId>
<classifier>...</classifier>
<version>...</version> <version>...</version>
</dependency> </dependency>
... ...
@@ -24,69 +23,4 @@ First, you will need to include the library in your project.
</project> </project>
``` ```
Valid `classifier` values are `cxf` or `jersey`. See the `cxf` and `jersey` branches for examples and more documentation.
### Spring Framework
#### Single Client
If you will only be declaring a single client in your Spring context, this is easy. You will just need two things. First, inject the single client into any of your Spring beans. You may do inject it into more than one. An example is below:
```java
@Component
public class ... {
@Autowired
@Qualifier("client.cxf") // may be optional
private Client client;
}
```
Next, you need to configure that client. You can do that by providing a single implementation of the `ClientConfiguration` (or `ClientCxfConfiguration`) interface.
```java
@Configuration
public class ... implements ClientCxfConfiguration {
...
}
```
For Jersey implementations, just use `client.jersey` and `ClientJerseyConfiguration`. If you want to provide one of each, then follow the instructions for multiple clients below.
#### Multiple Clients
If you will or may have multiple clients in your Spring context, there is an extra step. You will still need to define a `ClientConfiguration` for each. On top of that, you will need to create specialized implementations of each client. That special implementation will reference the configuration directly. An example is below.
```java
@Component("my.client")
public class MyClient extends ClientCxfImpl {
@Autowired
public MyClient(MyClientConfiguration config) {
super(config);
}
}
```
You can then inject your client(s) into your Spring beans. Like the example below:
```java
@Component
public class ... {
@Autowired
private MyClient client;
@PostConstruct
public void init() {
MyJaxRsApi api = this.client.getApi(MyJaxRsApi.class);
}
}
### POJO
You do not have to use the Spring framework to use these classes. You can instantiate them directly. But you wil still need to create a `ClientConfiguration` as mentioned above.
```java
MyClientConfiguration config = new MyClientConfiguration();
...
ClientCxfImpl client = new ClientCxfImpl(config);
MyJaxRsApi api = client.getApi(MyJaxRsApi.class);
```

65
pom.xml
View File

@@ -6,11 +6,11 @@
<groupId>com.inteligr8</groupId> <groupId>com.inteligr8</groupId>
<artifactId>common-rest-client</artifactId> <artifactId>common-rest-client</artifactId>
<version>3.0.1-cxf</version> <version>2.0.2</version>
<packaging>jar</packaging> <packaging>jar</packaging>
<name>ReST API Client for Java</name> <name>ReST API Client for Java</name>
<description>A common library for building CXF REST API clients</description> <description>A common library for building REST API clients</description>
<url>https://bitbucket.org/inteligr8/common-rest-client</url> <url>https://bitbucket.org/inteligr8/common-rest-client</url>
<licenses> <licenses>
@@ -40,21 +40,15 @@
<properties> <properties>
<project.build.sourceEncoding>utf-8</project.build.sourceEncoding> <project.build.sourceEncoding>utf-8</project.build.sourceEncoding>
<maven.compiler.source>11</maven.compiler.source> <maven.compiler.source>8</maven.compiler.source>
<maven.compiler.target>11</maven.compiler.target> <maven.compiler.target>8</maven.compiler.target>
<junit.version>5.10.0</junit.version> <junit.version>5.7.2</junit.version>
<spring.version>6.0.19</spring.version> <spring.version>5.3.27</spring.version>
<jackson.version>2.17.2</jackson.version> <jackson.version>2.15.1</jackson.version>
<cxf.version>4.0.5</cxf.version>
</properties> </properties>
<dependencies> <dependencies>
<dependency>
<groupId>jakarta.annotation</groupId>
<artifactId>jakarta.annotation-api</artifactId>
<version>2.1.1</version>
</dependency>
<dependency> <dependency>
<groupId>org.springframework</groupId> <groupId>org.springframework</groupId>
<artifactId>spring-context</artifactId> <artifactId>spring-context</artifactId>
@@ -66,8 +60,8 @@
<version>${jackson.version}</version> <version>${jackson.version}</version>
</dependency> </dependency>
<dependency> <dependency>
<groupId>com.fasterxml.jackson.jakarta.rs</groupId> <groupId>com.fasterxml.jackson.jaxrs</groupId>
<artifactId>jackson-jakarta-rs-json-provider</artifactId> <artifactId>jackson-jaxrs-json-provider</artifactId>
<version>${jackson.version}</version> <version>${jackson.version}</version>
</dependency> </dependency>
<dependency> <dependency>
@@ -75,20 +69,15 @@
<artifactId>jackson-datatype-jsr310</artifactId> <artifactId>jackson-datatype-jsr310</artifactId>
<version>${jackson.version}</version> <version>${jackson.version}</version>
</dependency> </dependency>
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-lang3</artifactId>
<version>3.14.0</version>
</dependency>
<dependency> <dependency>
<groupId>org.slf4j</groupId> <groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId> <artifactId>slf4j-api</artifactId>
<version>2.0.13</version> <version>1.7.36</version>
</dependency> </dependency>
<dependency> <dependency>
<groupId>jakarta.ws.rs</groupId> <groupId>jakarta.ws.rs</groupId>
<artifactId>jakarta.ws.rs-api</artifactId> <artifactId>jakarta.ws.rs-api</artifactId>
<version>3.1.0</version> <version>2.1.6</version>
</dependency> </dependency>
<dependency> <dependency>
<groupId>org.junit.jupiter</groupId> <groupId>org.junit.jupiter</groupId>
@@ -108,42 +97,10 @@
<version>4.5.14</version> <version>4.5.14</version>
<scope>test</scope> <scope>test</scope>
</dependency> </dependency>
<!-- Apache CXF libraries -->
<dependency>
<groupId>org.apache.cxf</groupId>
<artifactId>cxf-rt-rs-client</artifactId>
<version>${cxf.version}</version>
</dependency>
</dependencies> </dependencies>
<build> <build>
<plugins> <plugins>
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>build-helper-maven-plugin</artifactId>
<version>3.4.0</version>
<executions>
<execution>
<id>add-jaxrs-src</id>
<goals><goal>add-source</goal></goals>
<configuration>
<sources>
<source>src/main/cxf</source>
</sources>
</configuration>
</execution>
<execution>
<id>add-test-src</id>
<goals><goal>add-test-source</goal></goals>
<configuration>
<sources>
<source>src/test/cxf</source>
</sources>
</configuration>
</execution>
</executions>
</plugin>
<plugin> <plugin>
<artifactId>maven-surefire-plugin</artifactId> <artifactId>maven-surefire-plugin</artifactId>
<version>3.1.0</version> <version>3.1.0</version>

View File

@@ -1,48 +0,0 @@
/*
* This program is free software: you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or (at your
* option) any later version.
*
* This program is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
* more details.
*
* You should have received a copy of the GNU General Public License along
* with this program. If not, see <https://www.gnu.org/licenses/>.
*/
package com.inteligr8.rs;
import org.apache.cxf.jaxrs.client.WebClient;
/**
* This interface defines additional configurations specific to the Apache CXF
* JAX-RS library and its nuances.
*
* @author brian@inteligr8.com
*/
public interface ClientCxfConfiguration extends ClientConfiguration {
/**
* Apache CXF uses a global bus configuration where interceptors could
* wreck havoc on your implementation. This method allows you to
* explicitly by-pass the default bus.
*
* See https://cxf.apache.org/docs/bus-configuration.html.
*
* @return true to use the default bus; false otherwise.
*/
default boolean isDefaultBusEnabled() {
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

@@ -1,181 +0,0 @@
/*
* This program is free software: you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or (at your
* option) any later version.
*
* This program is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
* more details.
*
* You should have received a copy of the GNU General Public License along
* with this program. If not, see <https://www.gnu.org/licenses/>.
*/
package com.inteligr8.rs;
import java.util.LinkedList;
import java.util.List;
import jakarta.annotation.PostConstruct;
import jakarta.ws.rs.ext.RuntimeDelegate;
import org.apache.cxf.BusFactory;
import org.apache.cxf.jaxrs.client.JAXRSClientFactory;
import org.apache.cxf.jaxrs.client.WebClient;
import org.apache.cxf.jaxrs.impl.RuntimeDelegateImpl;
import org.apache.cxf.transport.http.HTTPConduit;
import org.apache.cxf.transports.http.configuration.HTTPClientPolicy;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule;
import com.fasterxml.jackson.jakarta.rs.json.JacksonJsonProvider;
/**
* A class that provides pre-configured JAX-RS Client &amp; WebTarget &amp;
* CXF WebClient objects.
*
* @author brian@inteligr8.com
*/
public class ClientCxfImpl extends Client {
private final Logger logger = LoggerFactory.getLogger(ClientCxfImpl.class);
private final Object sync = new Object();
private ClientCxfConfiguration config;
private WebClient client;
/**
* This constructor is for Spring or POJO use.
* @param config The client configuration.
*/
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");
RuntimeDelegate.setInstance(new RuntimeDelegateImpl());
} else if (RuntimeDelegate.getInstance() instanceof RuntimeDelegateImpl) {
this.logger.info("JAX-RS runtime delegate already the CXF library");
} else {
this.logger.warn("Setting JAX-RS runtime delegate to the CXF library; was: " + RuntimeDelegate.getInstance().getClass().getName());
RuntimeDelegate.setInstance(new RuntimeDelegateImpl());
}
if (this.logger.isInfoEnabled())
this.logger.info("API Base URL: " + this.getConfig().getBaseUrl());
}
/**
* @return A CXF client (not JAX-RS).
*/
public WebClient getCxfClient() {
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.
* @return A CXF client (not JAX-RS).
*/
public WebClient buildCxfClient(AuthorizationFilter authFilter) {
ObjectMapper om = new ObjectMapper();
om.registerModules(new JavaTimeModule());
this.getConfig().configureJacksonMapper(om);
JacksonJsonProvider jacksonProvider = new JacksonJsonProvider(om, JacksonJsonProvider.BASIC_ANNOTATIONS);
this.getConfig().configureJacksonProvider(jacksonProvider);
List<Object> providersAndFilters = new LinkedList<Object>();
providersAndFilters.add(jacksonProvider);
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);
if (this.getConfig().getConnectTimeoutInMillis() != null || this.getConfig().getResponseTimeoutInMillis() != null) {
HTTPConduit conduit = client.getConfiguration().getHttpConduit();
HTTPClientPolicy policy = conduit.getClient();
if (policy == null)
conduit.setClient(policy = new HTTPClientPolicy());
if (this.getConfig().getConnectTimeoutInMillis() != null)
policy.setConnectionTimeout(this.getConfig().getConnectTimeoutInMillis());
if (this.getConfig().getResponseTimeoutInMillis() != null)
policy.setReceiveTimeout(this.getConfig().getResponseTimeoutInMillis());
}
if (!this.getConfig().isDefaultBusEnabled()) {
// Some applications (like ACS) add interceptors to the default bus
// those interceptors may treat all messages as SOAP messages (like ACS), resulting in ClassCastExceptions
// we need to ignore the default bus
org.apache.cxf.jaxrs.client.ClientConfiguration config = WebClient.getConfig(client);
config.setBus(BusFactory.newInstance().createBus());
}
this.config.configureClient(client);
return client;
}
/**
* @param providersAndFilters A list of JAX-RS and CXF providers.
*/
public void addProvidersAndFilters(List<Object> providersAndFilters) {
// for extension purposes
}
/**
* @return The client configuration.
*/
public ClientCxfConfiguration getConfig() {
return this.config;
}
/**
* This method retrieves a JAX-RS implementation of the specified API with
* the specified authorization.
*
* @param authFilter A dynamic authorization filter.
* @param apiClass A JAX-RS annotation API class.
* @return An instance of the API class.
*/
@Override
public <T> T getApi(AuthorizationFilter authFilter, Class<T> apiClass) {
return JAXRSClientFactory.fromClient(this.getCxfClient(authFilter), apiClass);
}
}

View File

@@ -1,54 +0,0 @@
/*
* This program is free software: you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or (at your
* option) any later version.
*
* This program is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
* more details.
*
* You should have received a copy of the GNU General Public License along
* with this program. If not, see <https://www.gnu.org/licenses/>.
*/
package com.inteligr8.rs;
import java.io.IOException;
import java.util.LinkedList;
import java.util.List;
import jakarta.ws.rs.client.ClientRequestContext;
import jakarta.ws.rs.core.MediaType;
import org.apache.cxf.jaxrs.ext.multipart.Attachment;
import org.apache.cxf.jaxrs.ext.multipart.MultipartBody;
import org.slf4j.Logger;
/**
* This is a CXF specific handling of the logging of multipart requests, which
* would otherwise be ignored by the base LoggingFilter. It is meant to be
* used for debugging purposes. When used, it will write to 'jaxrs.request' and
* 'jaxrs.response' loggers at the 'trace' level.
*
* @author brian@inteligr8.com
*/
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());
}
} else {
super.logUnhandledRequest(requestContext, logger);
}
}
}

View File

@@ -1,49 +0,0 @@
/*
* This program is free software: you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or (at your
* option) any later version.
*
* This program is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
* more details.
*
* You should have received a copy of the GNU General Public License along
* with this program. If not, see <https://www.gnu.org/licenses/>.
*/
package com.inteligr8.rs;
import java.lang.annotation.Annotation;
import java.lang.reflect.Type;
import jakarta.ws.rs.Consumes;
import jakarta.ws.rs.Produces;
import jakarta.ws.rs.core.MediaType;
import jakarta.ws.rs.ext.Provider;
import org.apache.cxf.jaxrs.ext.multipart.MultipartBody;
import org.apache.cxf.jaxrs.provider.MultipartProvider;
/**
* This implements a JAX-RS provider that adds support for the handling of CXF
* MultipartBody.
*
* @author brian@inteligr8.com
*/
@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) || super.isReadable(type, genericType, annotations, mediaType);
}
@Override
public boolean isWriteable(Class<?> type, Type genericType, Annotation[] annotations, MediaType mediaType) {
return MultipartBody.class.isAssignableFrom(type) || super.isWriteable(type, genericType, annotations, mediaType);
}
}

View File

@@ -14,7 +14,7 @@
*/ */
package com.inteligr8.rs; package com.inteligr8.rs;
import jakarta.ws.rs.client.ClientRequestFilter; import javax.ws.rs.client.ClientRequestFilter;
/** /**
* This is a marker that allows the developer to segregate, restrict, or limit * This is a marker that allows the developer to segregate, restrict, or limit

View File

@@ -17,10 +17,8 @@ package com.inteligr8.rs;
import java.io.UnsupportedEncodingException; import java.io.UnsupportedEncodingException;
import java.util.Base64; import java.util.Base64;
import jakarta.ws.rs.client.ClientRequestContext; import javax.ws.rs.client.ClientRequestContext;
import jakarta.ws.rs.core.HttpHeaders; import javax.ws.rs.core.HttpHeaders;
import org.apache.commons.lang3.StringUtils;
/** /**
* This class implements a simple 2-credential (username &amp; password) based * This class implements a simple 2-credential (username &amp; password) based
@@ -38,8 +36,8 @@ public class BasicAuthorizationFilter implements AuthorizationFilter {
* @param password A password or secret key. * @param password A password or secret key.
*/ */
public BasicAuthorizationFilter(String username, String password) { public BasicAuthorizationFilter(String username, String password) {
this.username = StringUtils.trimToNull(username); this.username = username;
this.password = StringUtils.trimToNull(password); this.password = password;
} }
/** /**

View File

@@ -14,8 +14,8 @@
*/ */
package com.inteligr8.rs; package com.inteligr8.rs;
import jakarta.ws.rs.client.ClientRequestContext; import javax.ws.rs.client.ClientRequestContext;
import jakarta.ws.rs.core.HttpHeaders; import javax.ws.rs.core.HttpHeaders;
/** /**
* This class implements a simple long living or proxied token-based * This class implements a simple long living or proxied token-based

View File

@@ -14,16 +14,13 @@
*/ */
package com.inteligr8.rs; package com.inteligr8.rs;
import java.util.concurrent.TimeUnit; import javax.ws.rs.client.ClientBuilder;
import javax.ws.rs.client.WebTarget;
import jakarta.ws.rs.client.ClientBuilder;
import jakarta.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.jakarta.rs.json.JacksonJsonProvider; 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.
@@ -33,7 +30,7 @@ import com.fasterxml.jackson.jakarta.rs.json.JacksonJsonProvider;
public abstract class Client { public abstract class Client {
private final Object sync = new Object(); private final Object sync = new Object();
private jakarta.ws.rs.client.Client client; private javax.ws.rs.client.Client client;
/** /**
* @return The client configuration. * @return The client configuration.
@@ -43,7 +40,7 @@ public abstract class Client {
/** /**
* @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 jakarta.ws.rs.client.Client getClient() { public final javax.ws.rs.client.Client getClient() {
synchronized (this.sync) { synchronized (this.sync) {
if (this.client == null) if (this.client == null)
this.client = this.buildClient((AuthorizationFilter)null); this.client = this.buildClient((AuthorizationFilter)null);
@@ -56,7 +53,7 @@ public abstract class Client {
* @param authFilter A dynamic authorization filter. * @param authFilter A dynamic authorization filter.
* @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 jakarta.ws.rs.client.Client getClient(AuthorizationFilter authFilter) { public javax.ws.rs.client.Client getClient(AuthorizationFilter authFilter) {
if (authFilter == null) { if (authFilter == null) {
return this.getClient(); return this.getClient();
} else { } else {
@@ -68,14 +65,9 @@ public abstract class Client {
* @param authFilter A dynamic authorization filter. * @param authFilter A dynamic authorization filter.
* @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 jakarta.ws.rs.client.Client buildClient(AuthorizationFilter authFilter) { public final javax.ws.rs.client.Client buildClient(AuthorizationFilter authFilter) {
ObjectMapper om = new ObjectMapper(); JacksonJsonProvider provider = new JacksonJaxbJsonProvider();
om.registerModules(new JavaTimeModule());
this.getConfig().configureJacksonMapper(om);
JacksonJsonProvider provider = new JacksonJsonProvider(om, JacksonJsonProvider.BASIC_ANNOTATIONS);
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())
@@ -84,28 +76,22 @@ public abstract class Client {
ClientBuilder clientBuilder = ClientBuilder.newBuilder() ClientBuilder clientBuilder = ClientBuilder.newBuilder()
.register(provider) .register(provider)
.register(new LoggingFilter()); .register(new LoggingFilter());
if (this.getConfig().getConnectTimeoutInMillis() != null)
clientBuilder.connectTimeout(this.getConfig().getConnectTimeoutInMillis(), TimeUnit.MILLISECONDS);
if (this.getConfig().getResponseTimeoutInMillis() != null)
clientBuilder.readTimeout(this.getConfig().getResponseTimeoutInMillis(), TimeUnit.MILLISECONDS);
if (authFilter == null) if (authFilter == null)
authFilter = this.getConfig().createAuthorizationFilter(); authFilter = this.getConfig().createAuthorizationFilter();
if (authFilter != null) if (authFilter != null)
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,11 +16,6 @@ package com.inteligr8.rs;
import java.net.URI; import java.net.URI;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.jakarta.rs.json.JacksonJsonProvider;
import jakarta.ws.rs.client.ClientBuilder;
/** /**
* 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.
@@ -119,16 +114,6 @@ public interface ClientConfiguration {
} }
default Integer getConnectTimeoutInMillis() {
return null;
}
default Integer getResponseTimeoutInMillis() {
return null;
}
/** /**
* @return true to enable Jackson UNWRAP_ROOT_VALUE feature; false otherwise. * @return true to enable Jackson UNWRAP_ROOT_VALUE feature; false otherwise.
@@ -143,18 +128,6 @@ 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 Jakarta RS provider to configure.
*/
default void configureJacksonProvider(JacksonJsonProvider provider) {
}
@@ -196,13 +169,5 @@ 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) {
}
} }

View File

@@ -14,9 +14,7 @@
*/ */
package com.inteligr8.rs; package com.inteligr8.rs;
import jakarta.ws.rs.client.ClientRequestContext; import javax.ws.rs.client.ClientRequestContext;
import org.apache.commons.lang3.StringUtils;
/** /**
* This class is the base for implementations of client authorization similar * This class is the base for implementations of client authorization similar
@@ -47,8 +45,8 @@ public class ClientEnforcementAuthorizationFilter implements AuthorizationFilter
* @param clientSecret A secret corresponding to the client ID. * @param clientSecret A secret corresponding to the client ID.
*/ */
public ClientEnforcementAuthorizationFilter(String clientId, String clientSecret) { public ClientEnforcementAuthorizationFilter(String clientId, String clientSecret) {
this.clientId = StringUtils.trimToNull(clientId); this.clientId = clientId;
this.clientSecret = StringUtils.trimToNull(clientSecret); this.clientSecret = clientSecret;
} }
/** /**

View File

@@ -1,79 +0,0 @@
/*
* This program is free software: you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or (at your
* option) any later version.
*
* This program is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
* more details.
*
* You should have received a copy of the GNU General Public License along
* with this program. If not, see <https://www.gnu.org/licenses/>.
*/
package com.inteligr8.rs;
import jakarta.annotation.PostConstruct;
import jakarta.ws.rs.client.ClientBuilder;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* A class that provides pre-configured JAX-RS Client &amp; WebTarget objects
* for Jersey.
*
* @author brian@inteligr8.com
*/
public class ClientImpl extends Client {
private final Logger logger = LoggerFactory.getLogger(ClientImpl.class);
private ClientConfiguration config;
/**
* This constructor is for Spring or POJO use.
* @param config The client configuration.
*/
public ClientImpl(ClientConfiguration config) {
this.config = config;
}
/**
* This method registers the Jersey library as the default provider for the
* JAX-RS specification.
*/
@PostConstruct
public void register() {
this.logger.info("API Base URL: {}", this.getConfig().getBaseUrl());
}
/**
* @param clientBuilder A client builder.
*/
@Override
public void buildClient(ClientBuilder clientBuilder) {
}
/**
* @return The client configuration.
*/
public ClientConfiguration getConfig() {
return this.config;
}
/**
* This method retrieves a JAX-RS implementation of the specified API with
* the specified authorization.
*
* @param authFilter A dynamic authorization filter.
* @param apiClass A JAX-RS annotation API class.
* @return An instance of the API class.
*/
@Override
public <T> T getApi(AuthorizationFilter authFilter, Class<T> apiClass) {
throw new UnsupportedOperationException();
}
}

View File

@@ -14,8 +14,8 @@
*/ */
package com.inteligr8.rs; package com.inteligr8.rs;
import jakarta.ws.rs.client.ClientRequestContext; import javax.ws.rs.client.ClientRequestContext;
import jakarta.ws.rs.core.HttpHeaders; import javax.ws.rs.core.HttpHeaders;
/** /**
* This class implements a proxied or forwarded authorization header based * This class implements a proxied or forwarded authorization header based

View File

@@ -16,12 +16,12 @@ package com.inteligr8.rs;
import java.io.IOException; import java.io.IOException;
import jakarta.ws.rs.client.ClientRequestContext; import javax.ws.rs.client.ClientRequestContext;
import jakarta.ws.rs.client.ClientRequestFilter; import javax.ws.rs.client.ClientRequestFilter;
import jakarta.ws.rs.client.ClientResponseContext; import javax.ws.rs.client.ClientResponseContext;
import jakarta.ws.rs.client.ClientResponseFilter; import javax.ws.rs.client.ClientResponseFilter;
import jakarta.ws.rs.core.Form; import javax.ws.rs.core.Form;
import jakarta.ws.rs.core.MediaType; import javax.ws.rs.core.MediaType;
import org.slf4j.Logger; import org.slf4j.Logger;
import org.slf4j.LoggerFactory; import org.slf4j.LoggerFactory;
@@ -58,7 +58,7 @@ public class LoggingFilter implements ClientRequestFilter, ClientResponseFilter
logger.trace("request: {} {}: {}", requestContext.getMethod(), requestContext.getUri(), logger.trace("request: {} {}: {}", requestContext.getMethod(), requestContext.getUri(),
((Form)requestContext.getEntity()).asMap()); ((Form)requestContext.getEntity()).asMap());
} else { } else {
logger.trace("request: {} {}: failed to output form", requestContext.getMethod(), requestContext.getUri()); this.loggerRequest.trace("request: {} {}: failed to output form", requestContext.getMethod(), requestContext.getUri());
} }
} else { } else {
this.logUnhandledRequest(requestContext, logger); this.logUnhandledRequest(requestContext, logger);

View File

@@ -16,11 +16,7 @@ package com.inteligr8.rs;
import java.net.URI; import java.net.URI;
import jakarta.ws.rs.core.Form; import javax.ws.rs.core.Form;
import org.apache.commons.lang3.StringUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/** /**
* This class implements the OAuth Authorization Code flow as an authorization * This class implements the OAuth Authorization Code flow as an authorization
@@ -29,8 +25,6 @@ import org.slf4j.LoggerFactory;
* @author brian@inteligr8.com * @author brian@inteligr8.com
*/ */
public class OAuthAuthorizationCodeAuthorizationFilter extends OAuthAuthorizationFilter { public class OAuthAuthorizationCodeAuthorizationFilter extends OAuthAuthorizationFilter {
private final Logger logger = LoggerFactory.getLogger(this.getClass());
private final String code; private final String code;
private final URI redirectUri; private final URI redirectUri;
@@ -74,22 +68,17 @@ public class OAuthAuthorizationCodeAuthorizationFilter extends OAuthAuthorizatio
public OAuthAuthorizationCodeAuthorizationFilter(String tokenUrl, String clientId, String clientSecret, String code, URI redirectUri) { public OAuthAuthorizationCodeAuthorizationFilter(String tokenUrl, String clientId, String clientSecret, String code, URI redirectUri) {
super(tokenUrl, clientId, clientSecret); super(tokenUrl, clientId, clientSecret);
this.code = StringUtils.trimToNull(code); this.code = code;
this.redirectUri = redirectUri; this.redirectUri = redirectUri;
} }
@Override @Override
protected Form createForm() { protected Form createForm() {
this.logger.debug("Using OAuth grant_type 'authorization_code'"); Form form = new Form().param("grant_type", "authorization_code")
Form form = new Form().param("grant_type", "authorization_code"); .param("code", this.code);
if (this.redirectUri != null) if (this.redirectUri != null)
form.param("redirect_uri", this.redirectUri.toString()); form.param("redirect_uri", this.redirectUri.toString());
return form; return form;
} }
@Override
protected void extendFormSensitive(Form form) {
form.param("code", this.code);
}
} }

View File

@@ -16,22 +16,15 @@ package com.inteligr8.rs;
import java.util.Map; import java.util.Map;
import jakarta.ws.rs.WebApplicationException; import javax.ws.rs.WebApplicationException;
import jakarta.ws.rs.client.Client; import javax.ws.rs.client.ClientBuilder;
import jakarta.ws.rs.client.ClientBuilder; import javax.ws.rs.client.ClientRequestContext;
import jakarta.ws.rs.client.ClientRequestContext; import javax.ws.rs.client.Entity;
import jakarta.ws.rs.client.Entity; import javax.ws.rs.client.WebTarget;
import jakarta.ws.rs.client.WebTarget; import javax.ws.rs.core.Form;
import jakarta.ws.rs.core.Form; import javax.ws.rs.core.HttpHeaders;
import jakarta.ws.rs.core.HttpHeaders;
import jakarta.ws.rs.core.Response;
import jakarta.ws.rs.core.Response.Status.Family;
import org.apache.commons.lang3.StringUtils; import com.fasterxml.jackson.jaxrs.json.JacksonJaxbJsonProvider;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.fasterxml.jackson.jakarta.rs.json.JacksonJsonProvider;
/** /**
* This class is the base for implementations of OAuth authorization flows. * This class is the base for implementations of OAuth authorization flows.
@@ -40,8 +33,6 @@ import com.fasterxml.jackson.jakarta.rs.json.JacksonJsonProvider;
*/ */
public abstract class OAuthAuthorizationFilter implements AuthorizationFilter { public abstract class OAuthAuthorizationFilter implements AuthorizationFilter {
private final Logger logger = LoggerFactory.getLogger(this.getClass());
private final String tokenUrl; private final String tokenUrl;
private final String clientId; private final String clientId;
private final String clientSecret; private final String clientSecret;
@@ -49,7 +40,6 @@ public abstract class OAuthAuthorizationFilter implements AuthorizationFilter {
private String accessToken; private String accessToken;
private long expiration; private long expiration;
private String refreshToken; private String refreshToken;
private Long refreshTokenExpiration;
/** /**
* This constructor creates an OAuth-based authorization filter using the * This constructor creates an OAuth-based authorization filter using the
@@ -89,9 +79,9 @@ public abstract class OAuthAuthorizationFilter implements AuthorizationFilter {
*/ */
public OAuthAuthorizationFilter(String tokenUrl, String clientId, String clientSecret, String scope) { public OAuthAuthorizationFilter(String tokenUrl, String clientId, String clientSecret, String scope) {
this.tokenUrl = tokenUrl; this.tokenUrl = tokenUrl;
this.clientId = StringUtils.trimToNull(clientId); this.clientId = clientId;
this.clientSecret = StringUtils.trimToNull(clientSecret); this.clientSecret = clientSecret;
this.scope = StringUtils.trimToNull(scope); this.scope = scope;
} }
/** /**
@@ -101,29 +91,8 @@ public abstract class OAuthAuthorizationFilter implements AuthorizationFilter {
*/ */
@Override @Override
public void filter(ClientRequestContext requestContext) { public void filter(ClientRequestContext requestContext) {
if (this.accessToken == null) { if (this.accessToken == null || System.currentTimeMillis() > this.expiration)
this.requestToken(); this.requestToken();
} else if (System.currentTimeMillis() >= this.expiration) {
this.logger.trace("Access token expired; retrieving new one with refresh token");
if (this.refreshTokenExpiration != null && System.currentTimeMillis() >= this.refreshTokenExpiration.longValue()) {
this.logger.debug("Refresh token expired; performing full authentication");
this.refreshToken = null;
this.requestToken();
} else {
try {
this.requestToken();
} catch (WebApplicationException wae) {
if (wae.getResponse().getStatusInfo().getFamily() == Family.CLIENT_ERROR) {
this.logger.debug("Received OAuth response {} using refresh token; performing full authentication", wae.getResponse().getStatus());
this.refreshToken = null;
this.requestToken();
} else {
throw wae;
}
}
}
}
requestContext.getHeaders().add(HttpHeaders.AUTHORIZATION, "Bearer " + this.accessToken); requestContext.getHeaders().add(HttpHeaders.AUTHORIZATION, "Bearer " + this.accessToken);
} }
@@ -142,53 +111,29 @@ public abstract class OAuthAuthorizationFilter implements AuthorizationFilter {
} }
form.param("client_id", this.clientId); form.param("client_id", this.clientId);
if (this.clientSecret != null)
form.param("client_secret", this.clientSecret);
if (this.scope != null) if (this.scope != null)
form.param("scope", this.scope); form.param("scope", this.scope);
this.extendRefreshTokenForm(form);
this.logger.trace("Sending OAuth request: {}", form);
if (this.refreshToken != null) {
this.extendRefreshFormSensitive(form);
} else {
this.extendFormSensitive(form);
}
if (this.clientSecret != null)
form.param("client_secret", this.clientSecret);
Entity<Form> entity = Entity.form(form); Entity<Form> entity = Entity.form(form);
Client client = ClientBuilder.newBuilder() WebTarget target = ClientBuilder.newBuilder()
.register(new JacksonJsonProvider()) .register(new JacksonJaxbJsonProvider())
.build(); .build()
WebTarget target = client.target(this.tokenUrl); .target(this.tokenUrl);
long requestSendTime = System.currentTimeMillis();
Response response = target.request().post(entity); @SuppressWarnings("unchecked")
Map<String, Object> response = target.request().post(entity, Map.class);
this.logger.debug("Received OAuth response: {}", response.getStatus()); if (response.containsKey("error"))
throw new WebApplicationException((String)response.get("error"), 400);
@SuppressWarnings("unchecked")
Map<String, Object> responseMap = response.readEntity(Map.class);
this.logger.trace("Received OAuth response: {}", responseMap);
if (response.getStatusInfo().getFamily() != Family.SUCCESSFUL) { this.accessToken = (String)response.get("access_token");
String code = (String) responseMap.get("error"); this.expiration = System.currentTimeMillis() + ((Number)response.get("expires_in")).longValue() * 1000L;
if (code != null) { this.refreshToken = (String)response.get("refresh_token");
String description = (String) responseMap.get("error_description"); this.extendRefreshTokenResponse(response);
throw new WebApplicationException(code + ": " + description, response.getStatus());
} else {
throw new WebApplicationException(response);
}
}
this.accessToken = (String)responseMap.get("access_token");
this.expiration = requestSendTime + ((Number)responseMap.get("expires_in")).longValue() * 1000L;
this.refreshToken = (String)responseMap.get("refresh_token");
if (responseMap.containsKey("refresh_token_expires_in"))
this.refreshTokenExpiration = requestSendTime + ((Number)responseMap.get("refresh_token_expires_in")).longValue() * 1000L;
} }
protected Form createRefreshForm() { protected Form createRefreshForm() {
@@ -198,9 +143,10 @@ public abstract class OAuthAuthorizationFilter implements AuthorizationFilter {
protected abstract Form createForm(); protected abstract Form createForm();
protected void extendRefreshFormSensitive(Form form) { protected void extendRefreshTokenForm(Form form) {
}
protected void extendRefreshTokenResponse(Map<String, Object> response) {
} }
protected abstract void extendFormSensitive(Form form);
} }

View File

@@ -14,10 +14,7 @@
*/ */
package com.inteligr8.rs; package com.inteligr8.rs;
import jakarta.ws.rs.core.Form; import javax.ws.rs.core.Form;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/** /**
* This class implements the OAuth Client Credential flow as an authorization * This class implements the OAuth Client Credential flow as an authorization
@@ -26,8 +23,6 @@ import org.slf4j.LoggerFactory;
* @author brian@inteligr8.com * @author brian@inteligr8.com
*/ */
public class OAuthClientCredentialAuthorizationFilter extends OAuthAuthorizationFilter { public class OAuthClientCredentialAuthorizationFilter extends OAuthAuthorizationFilter {
private final Logger logger = LoggerFactory.getLogger(this.getClass());
/** /**
* @param tokenUrl The URL to the OAuth IdP token service. * @param tokenUrl The URL to the OAuth IdP token service.
@@ -40,12 +35,7 @@ public class OAuthClientCredentialAuthorizationFilter extends OAuthAuthorization
@Override @Override
protected Form createForm() { protected Form createForm() {
this.logger.debug("Using OAuth grant_type 'client_credentials'");
return new Form().param("grant_type", "client_credentials"); return new Form().param("grant_type", "client_credentials");
} }
@Override
protected void extendFormSensitive(Form form) {
}
} }

View File

@@ -14,11 +14,7 @@
*/ */
package com.inteligr8.rs; package com.inteligr8.rs;
import jakarta.ws.rs.core.Form; import javax.ws.rs.core.Form;
import org.apache.commons.lang3.StringUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/** /**
* This class implements the OAuth Password Grant flow as an authorization * This class implements the OAuth Password Grant flow as an authorization
@@ -27,8 +23,6 @@ import org.slf4j.LoggerFactory;
* @author brian@inteligr8.com * @author brian@inteligr8.com
*/ */
public class OAuthPasswordGrantAuthorizationFilter extends OAuthAuthorizationFilter { public class OAuthPasswordGrantAuthorizationFilter extends OAuthAuthorizationFilter {
private final Logger logger = LoggerFactory.getLogger(this.getClass());
private final String username; private final String username;
private final String password; private final String password;
@@ -52,20 +46,15 @@ public class OAuthPasswordGrantAuthorizationFilter extends OAuthAuthorizationFil
*/ */
public OAuthPasswordGrantAuthorizationFilter(String tokenUrl, String clientId, String clientSecret, String username, String password) { public OAuthPasswordGrantAuthorizationFilter(String tokenUrl, String clientId, String clientSecret, String username, String password) {
super(tokenUrl, clientId, clientSecret); super(tokenUrl, clientId, clientSecret);
this.username = StringUtils.trimToNull(username); this.username = username;
this.password = StringUtils.trimToNull(password); this.password = password;
} }
@Override @Override
protected Form createForm() { protected Form createForm() {
this.logger.debug("Using OAuth grant_type 'password': {}", this.username);
return new Form().param("grant_type", "password") return new Form().param("grant_type", "password")
.param("username", this.username); .param("username", this.username)
} .param("password", this.password);
@Override
protected void extendFormSensitive(Form form) {
form.param("password", this.password);
} }
} }