Compare commits
22 Commits
v2.0.6-cxf
...
v3.0.0
| Author | SHA1 | Date | |
|---|---|---|---|
| eb7ac34f5e | |||
| b7ac0d25c9 | |||
| 271016dcf9 | |||
| 00ec8c972d | |||
| 2cd9cc9484 | |||
| d4cd2f248c | |||
| ac6f82a7f4 | |||
| eb654c5488 | |||
| 0258cfcb9a | |||
| 6fc43b85f7 | |||
| d29ccbef79 | |||
| 512f118354 | |||
| 21255bfb3d | |||
| f84279a148 | |||
| f10fd39e97 | |||
| eaed628f00 | |||
| cd278bcc81 | |||
| b64c408029 | |||
| ec6e7cc15d | |||
| 2451c634b7 | |||
| ed00346e71 | |||
| c001576b65 |
70
README.md
70
README.md
@@ -1,7 +1,7 @@
|
||||
|
||||
# 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
|
||||
|
||||
@@ -15,7 +15,6 @@ First, you will need to include the library in your project.
|
||||
<dependency>
|
||||
<groupId>com.inteligr8</groupId>
|
||||
<artifactId>common-rest-client</artifactId>
|
||||
<classifier>...</classifier>
|
||||
<version>...</version>
|
||||
</dependency>
|
||||
...
|
||||
@@ -24,69 +23,4 @@ First, you will need to include the library in your project.
|
||||
</project>
|
||||
```
|
||||
|
||||
Valid `classifier` values are `cxf` or `jersey`.
|
||||
|
||||
### 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);
|
||||
```
|
||||
See the `cxf` and `jersey` branches for examples and more documentation.
|
||||
|
||||
65
pom.xml
65
pom.xml
@@ -6,11 +6,11 @@
|
||||
|
||||
<groupId>com.inteligr8</groupId>
|
||||
<artifactId>common-rest-client</artifactId>
|
||||
<version>2.0.6-cxf</version>
|
||||
<version>3.0.0</version>
|
||||
<packaging>jar</packaging>
|
||||
|
||||
<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>
|
||||
|
||||
<licenses>
|
||||
@@ -40,16 +40,20 @@
|
||||
|
||||
<properties>
|
||||
<project.build.sourceEncoding>utf-8</project.build.sourceEncoding>
|
||||
<maven.compiler.source>8</maven.compiler.source>
|
||||
<maven.compiler.target>8</maven.compiler.target>
|
||||
<maven.compiler.source>11</maven.compiler.source>
|
||||
<maven.compiler.target>11</maven.compiler.target>
|
||||
|
||||
<junit.version>5.7.2</junit.version>
|
||||
<spring.version>5.3.27</spring.version>
|
||||
<jackson.version>2.15.1</jackson.version>
|
||||
<cxf.version>3.5.6</cxf.version>
|
||||
<junit.version>5.10.0</junit.version>
|
||||
<spring.version>6.0.19</spring.version>
|
||||
<jackson.version>2.17.2</jackson.version>
|
||||
</properties>
|
||||
|
||||
<dependencies>
|
||||
<dependency>
|
||||
<groupId>jakarta.annotation</groupId>
|
||||
<artifactId>jakarta.annotation-api</artifactId>
|
||||
<version>2.1.1</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.springframework</groupId>
|
||||
<artifactId>spring-context</artifactId>
|
||||
@@ -61,8 +65,8 @@
|
||||
<version>${jackson.version}</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>com.fasterxml.jackson.jaxrs</groupId>
|
||||
<artifactId>jackson-jaxrs-json-provider</artifactId>
|
||||
<groupId>com.fasterxml.jackson.jakarta.rs</groupId>
|
||||
<artifactId>jackson-jakarta-rs-json-provider</artifactId>
|
||||
<version>${jackson.version}</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
@@ -70,15 +74,20 @@
|
||||
<artifactId>jackson-datatype-jsr310</artifactId>
|
||||
<version>${jackson.version}</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.apache.commons</groupId>
|
||||
<artifactId>commons-lang3</artifactId>
|
||||
<version>3.14.0</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.slf4j</groupId>
|
||||
<artifactId>slf4j-api</artifactId>
|
||||
<version>1.7.36</version>
|
||||
<version>2.0.13</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>jakarta.ws.rs</groupId>
|
||||
<artifactId>jakarta.ws.rs-api</artifactId>
|
||||
<version>2.1.6</version>
|
||||
<version>3.1.0</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.junit.jupiter</groupId>
|
||||
@@ -98,42 +107,10 @@
|
||||
<version>4.5.14</version>
|
||||
<scope>test</scope>
|
||||
</dependency>
|
||||
|
||||
<!-- Apache CXF libraries -->
|
||||
<dependency>
|
||||
<groupId>org.apache.cxf</groupId>
|
||||
<artifactId>cxf-rt-rs-client</artifactId>
|
||||
<version>${cxf.version}</version>
|
||||
</dependency>
|
||||
</dependencies>
|
||||
|
||||
<build>
|
||||
<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>
|
||||
<artifactId>maven-surefire-plugin</artifactId>
|
||||
<version>3.1.0</version>
|
||||
|
||||
@@ -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) {
|
||||
}
|
||||
|
||||
}
|
||||
@@ -1,172 +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 javax.annotation.PostConstruct;
|
||||
import javax.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.slf4j.Logger;
|
||||
import org.slf4j.LoggerFactory;
|
||||
import org.springframework.beans.factory.annotation.Autowired;
|
||||
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;
|
||||
|
||||
/**
|
||||
* A class that provides pre-configured JAX-RS Client & WebTarget &
|
||||
* CXF WebClient objects.
|
||||
*
|
||||
* @author brian@inteligr8.com
|
||||
*/
|
||||
@Component("client.cxf")
|
||||
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.
|
||||
*/
|
||||
@Autowired
|
||||
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);
|
||||
|
||||
JacksonJaxbJsonProvider jacksonProvider = new JacksonJaxbJsonProvider(om, JacksonJaxbJsonProvider.DEFAULT_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().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);
|
||||
}
|
||||
|
||||
}
|
||||
@@ -1,52 +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 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;
|
||||
|
||||
/**
|
||||
* 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());
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
@@ -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 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;
|
||||
|
||||
/**
|
||||
* 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);
|
||||
}
|
||||
|
||||
}
|
||||
@@ -14,7 +14,7 @@
|
||||
*/
|
||||
package com.inteligr8.rs;
|
||||
|
||||
import javax.ws.rs.client.ClientRequestFilter;
|
||||
import jakarta.ws.rs.client.ClientRequestFilter;
|
||||
|
||||
/**
|
||||
* This is a marker that allows the developer to segregate, restrict, or limit
|
||||
|
||||
@@ -17,8 +17,10 @@ package com.inteligr8.rs;
|
||||
import java.io.UnsupportedEncodingException;
|
||||
import java.util.Base64;
|
||||
|
||||
import javax.ws.rs.client.ClientRequestContext;
|
||||
import javax.ws.rs.core.HttpHeaders;
|
||||
import jakarta.ws.rs.client.ClientRequestContext;
|
||||
import jakarta.ws.rs.core.HttpHeaders;
|
||||
|
||||
import org.apache.commons.lang3.StringUtils;
|
||||
|
||||
/**
|
||||
* This class implements a simple 2-credential (username & password) based
|
||||
@@ -36,8 +38,8 @@ public class BasicAuthorizationFilter implements AuthorizationFilter {
|
||||
* @param password A password or secret key.
|
||||
*/
|
||||
public BasicAuthorizationFilter(String username, String password) {
|
||||
this.username = username;
|
||||
this.password = password;
|
||||
this.username = StringUtils.trimToNull(username);
|
||||
this.password = StringUtils.trimToNull(password);
|
||||
}
|
||||
|
||||
/**
|
||||
|
||||
@@ -14,8 +14,8 @@
|
||||
*/
|
||||
package com.inteligr8.rs;
|
||||
|
||||
import javax.ws.rs.client.ClientRequestContext;
|
||||
import javax.ws.rs.core.HttpHeaders;
|
||||
import jakarta.ws.rs.client.ClientRequestContext;
|
||||
import jakarta.ws.rs.core.HttpHeaders;
|
||||
|
||||
/**
|
||||
* This class implements a simple long living or proxied token-based
|
||||
|
||||
@@ -14,14 +14,16 @@
|
||||
*/
|
||||
package com.inteligr8.rs;
|
||||
|
||||
import javax.ws.rs.client.ClientBuilder;
|
||||
import javax.ws.rs.client.WebTarget;
|
||||
import java.util.concurrent.TimeUnit;
|
||||
|
||||
import jakarta.ws.rs.client.ClientBuilder;
|
||||
import jakarta.ws.rs.client.WebTarget;
|
||||
|
||||
import com.fasterxml.jackson.databind.DeserializationFeature;
|
||||
import com.fasterxml.jackson.databind.ObjectMapper;
|
||||
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;
|
||||
|
||||
/**
|
||||
* A class that provides pre-configured JAX-RS Client & WebTarget objects.
|
||||
@@ -31,7 +33,7 @@ import com.fasterxml.jackson.jaxrs.json.JacksonJaxbJsonProvider;
|
||||
public abstract class Client {
|
||||
|
||||
private final Object sync = new Object();
|
||||
private javax.ws.rs.client.Client client;
|
||||
private jakarta.ws.rs.client.Client client;
|
||||
|
||||
/**
|
||||
* @return The client configuration.
|
||||
@@ -41,7 +43,7 @@ public abstract class Client {
|
||||
/**
|
||||
* @return A pre-configured JAX-RS client (no URL) with configured authorization.
|
||||
*/
|
||||
public final javax.ws.rs.client.Client getClient() {
|
||||
public final jakarta.ws.rs.client.Client getClient() {
|
||||
synchronized (this.sync) {
|
||||
if (this.client == null)
|
||||
this.client = this.buildClient((AuthorizationFilter)null);
|
||||
@@ -54,7 +56,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 getClient(AuthorizationFilter authFilter) {
|
||||
public jakarta.ws.rs.client.Client getClient(AuthorizationFilter authFilter) {
|
||||
if (authFilter == null) {
|
||||
return this.getClient();
|
||||
} else {
|
||||
@@ -66,12 +68,12 @@ public abstract class Client {
|
||||
* @param authFilter A dynamic authorization filter.
|
||||
* @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 jakarta.ws.rs.client.Client buildClient(AuthorizationFilter authFilter) {
|
||||
ObjectMapper om = new ObjectMapper();
|
||||
om.registerModules(new JavaTimeModule());
|
||||
this.getConfig().configureJacksonMapper(om);
|
||||
|
||||
JacksonJaxbJsonProvider provider = new JacksonJaxbJsonProvider(om, JacksonJaxbJsonProvider.DEFAULT_ANNOTATIONS);
|
||||
JacksonJsonProvider provider = new JacksonJsonProvider(om, JacksonJsonProvider.BASIC_ANNOTATIONS);
|
||||
this.getConfig().configureJacksonProvider(provider);
|
||||
|
||||
if (this.getConfig().isWrapRootValueEnabled())
|
||||
@@ -82,6 +84,11 @@ public abstract class Client {
|
||||
ClientBuilder clientBuilder = ClientBuilder.newBuilder()
|
||||
.register(provider)
|
||||
.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)
|
||||
authFilter = this.getConfig().createAuthorizationFilter();
|
||||
|
||||
@@ -16,10 +16,10 @@ package com.inteligr8.rs;
|
||||
|
||||
import java.net.URI;
|
||||
|
||||
import javax.ws.rs.client.ClientBuilder;
|
||||
|
||||
import com.fasterxml.jackson.databind.ObjectMapper;
|
||||
import com.fasterxml.jackson.jaxrs.json.JacksonJaxbJsonProvider;
|
||||
import com.fasterxml.jackson.jakarta.rs.json.JacksonJsonProvider;
|
||||
|
||||
import jakarta.ws.rs.client.ClientBuilder;
|
||||
|
||||
/**
|
||||
* This interface defines the configurable parameters of the clients; primarily
|
||||
@@ -119,6 +119,16 @@ public interface ClientConfiguration {
|
||||
}
|
||||
|
||||
|
||||
|
||||
default Integer getConnectTimeoutInMillis() {
|
||||
return null;
|
||||
}
|
||||
|
||||
default Integer getResponseTimeoutInMillis() {
|
||||
return null;
|
||||
}
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* @return true to enable Jackson UNWRAP_ROOT_VALUE feature; false otherwise.
|
||||
@@ -141,9 +151,9 @@ public interface ClientConfiguration {
|
||||
}
|
||||
|
||||
/**
|
||||
* @param provider A Jackson JAX-RS provider to configure.
|
||||
* @param provider A Jackson Jakarta RS provider to configure.
|
||||
*/
|
||||
default void configureJacksonProvider(JacksonJaxbJsonProvider provider) {
|
||||
default void configureJacksonProvider(JacksonJsonProvider provider) {
|
||||
}
|
||||
|
||||
|
||||
|
||||
@@ -14,7 +14,9 @@
|
||||
*/
|
||||
package com.inteligr8.rs;
|
||||
|
||||
import javax.ws.rs.client.ClientRequestContext;
|
||||
import jakarta.ws.rs.client.ClientRequestContext;
|
||||
|
||||
import org.apache.commons.lang3.StringUtils;
|
||||
|
||||
/**
|
||||
* This class is the base for implementations of client authorization similar
|
||||
@@ -45,8 +47,8 @@ public class ClientEnforcementAuthorizationFilter implements AuthorizationFilter
|
||||
* @param clientSecret A secret corresponding to the client ID.
|
||||
*/
|
||||
public ClientEnforcementAuthorizationFilter(String clientId, String clientSecret) {
|
||||
this.clientId = clientId;
|
||||
this.clientSecret = clientSecret;
|
||||
this.clientId = StringUtils.trimToNull(clientId);
|
||||
this.clientSecret = StringUtils.trimToNull(clientSecret);
|
||||
}
|
||||
|
||||
/**
|
||||
|
||||
@@ -14,13 +14,11 @@
|
||||
*/
|
||||
package com.inteligr8.rs;
|
||||
|
||||
import javax.annotation.PostConstruct;
|
||||
import javax.ws.rs.client.ClientBuilder;
|
||||
import jakarta.annotation.PostConstruct;
|
||||
import jakarta.ws.rs.client.ClientBuilder;
|
||||
|
||||
import org.slf4j.Logger;
|
||||
import org.slf4j.LoggerFactory;
|
||||
import org.springframework.beans.factory.annotation.Autowired;
|
||||
import org.springframework.stereotype.Component;
|
||||
|
||||
/**
|
||||
* A class that provides pre-configured JAX-RS Client & WebTarget objects
|
||||
@@ -28,7 +26,6 @@ import org.springframework.stereotype.Component;
|
||||
*
|
||||
* @author brian@inteligr8.com
|
||||
*/
|
||||
@Component("client.jaxrs")
|
||||
public class ClientImpl extends Client {
|
||||
|
||||
private final Logger logger = LoggerFactory.getLogger(ClientImpl.class);
|
||||
@@ -39,7 +36,6 @@ public class ClientImpl extends Client {
|
||||
* This constructor is for Spring or POJO use.
|
||||
* @param config The client configuration.
|
||||
*/
|
||||
@Autowired
|
||||
public ClientImpl(ClientConfiguration config) {
|
||||
this.config = config;
|
||||
}
|
||||
|
||||
@@ -14,8 +14,8 @@
|
||||
*/
|
||||
package com.inteligr8.rs;
|
||||
|
||||
import javax.ws.rs.client.ClientRequestContext;
|
||||
import javax.ws.rs.core.HttpHeaders;
|
||||
import jakarta.ws.rs.client.ClientRequestContext;
|
||||
import jakarta.ws.rs.core.HttpHeaders;
|
||||
|
||||
/**
|
||||
* This class implements a proxied or forwarded authorization header based
|
||||
|
||||
@@ -16,12 +16,12 @@ 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 jakarta.ws.rs.client.ClientRequestContext;
|
||||
import jakarta.ws.rs.client.ClientRequestFilter;
|
||||
import jakarta.ws.rs.client.ClientResponseContext;
|
||||
import jakarta.ws.rs.client.ClientResponseFilter;
|
||||
import jakarta.ws.rs.core.Form;
|
||||
import jakarta.ws.rs.core.MediaType;
|
||||
|
||||
import org.slf4j.Logger;
|
||||
import org.slf4j.LoggerFactory;
|
||||
|
||||
@@ -16,7 +16,11 @@ package com.inteligr8.rs;
|
||||
|
||||
import java.net.URI;
|
||||
|
||||
import javax.ws.rs.core.Form;
|
||||
import jakarta.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
|
||||
@@ -25,6 +29,8 @@ import javax.ws.rs.core.Form;
|
||||
* @author brian@inteligr8.com
|
||||
*/
|
||||
public class OAuthAuthorizationCodeAuthorizationFilter extends OAuthAuthorizationFilter {
|
||||
|
||||
private final Logger logger = LoggerFactory.getLogger(this.getClass());
|
||||
|
||||
private final String code;
|
||||
private final URI redirectUri;
|
||||
@@ -68,12 +74,13 @@ public class OAuthAuthorizationCodeAuthorizationFilter extends OAuthAuthorizatio
|
||||
public OAuthAuthorizationCodeAuthorizationFilter(String tokenUrl, String clientId, String clientSecret, String code, URI redirectUri) {
|
||||
super(tokenUrl, clientId, clientSecret);
|
||||
|
||||
this.code = code;
|
||||
this.code = StringUtils.trimToNull(code);
|
||||
this.redirectUri = redirectUri;
|
||||
}
|
||||
|
||||
@Override
|
||||
protected Form createForm() {
|
||||
this.logger.debug("Using OAuth grant_type 'authorization_code'");
|
||||
Form form = new Form().param("grant_type", "authorization_code");
|
||||
if (this.redirectUri != null)
|
||||
form.param("redirect_uri", this.redirectUri.toString());
|
||||
|
||||
@@ -16,21 +16,22 @@ package com.inteligr8.rs;
|
||||
|
||||
import java.util.Map;
|
||||
|
||||
import javax.ws.rs.WebApplicationException;
|
||||
import javax.ws.rs.client.Client;
|
||||
import javax.ws.rs.client.ClientBuilder;
|
||||
import javax.ws.rs.client.ClientRequestContext;
|
||||
import javax.ws.rs.client.Entity;
|
||||
import javax.ws.rs.client.WebTarget;
|
||||
import javax.ws.rs.core.Form;
|
||||
import javax.ws.rs.core.HttpHeaders;
|
||||
import javax.ws.rs.core.Response;
|
||||
import javax.ws.rs.core.Response.Status.Family;
|
||||
import jakarta.ws.rs.WebApplicationException;
|
||||
import jakarta.ws.rs.client.Client;
|
||||
import jakarta.ws.rs.client.ClientBuilder;
|
||||
import jakarta.ws.rs.client.ClientRequestContext;
|
||||
import jakarta.ws.rs.client.Entity;
|
||||
import jakarta.ws.rs.client.WebTarget;
|
||||
import jakarta.ws.rs.core.Form;
|
||||
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 org.slf4j.Logger;
|
||||
import org.slf4j.LoggerFactory;
|
||||
|
||||
import com.fasterxml.jackson.jaxrs.json.JacksonJaxbJsonProvider;
|
||||
import com.fasterxml.jackson.jakarta.rs.json.JacksonJsonProvider;
|
||||
|
||||
/**
|
||||
* This class is the base for implementations of OAuth authorization flows.
|
||||
@@ -48,6 +49,7 @@ public abstract class OAuthAuthorizationFilter implements AuthorizationFilter {
|
||||
private String accessToken;
|
||||
private long expiration;
|
||||
private String refreshToken;
|
||||
private Long refreshTokenExpiration;
|
||||
|
||||
/**
|
||||
* This constructor creates an OAuth-based authorization filter using the
|
||||
@@ -87,9 +89,9 @@ public abstract class OAuthAuthorizationFilter implements AuthorizationFilter {
|
||||
*/
|
||||
public OAuthAuthorizationFilter(String tokenUrl, String clientId, String clientSecret, String scope) {
|
||||
this.tokenUrl = tokenUrl;
|
||||
this.clientId = clientId;
|
||||
this.clientSecret = clientSecret;
|
||||
this.scope = scope;
|
||||
this.clientId = StringUtils.trimToNull(clientId);
|
||||
this.clientSecret = StringUtils.trimToNull(clientSecret);
|
||||
this.scope = StringUtils.trimToNull(scope);
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -99,8 +101,29 @@ public abstract class OAuthAuthorizationFilter implements AuthorizationFilter {
|
||||
*/
|
||||
@Override
|
||||
public void filter(ClientRequestContext requestContext) {
|
||||
if (this.accessToken == null || System.currentTimeMillis() > this.expiration)
|
||||
this.requestToken();
|
||||
if (this.accessToken == null) {
|
||||
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);
|
||||
}
|
||||
@@ -136,9 +159,11 @@ public abstract class OAuthAuthorizationFilter implements AuthorizationFilter {
|
||||
Entity<Form> entity = Entity.form(form);
|
||||
|
||||
Client client = ClientBuilder.newBuilder()
|
||||
.register(new JacksonJaxbJsonProvider())
|
||||
.register(new JacksonJsonProvider())
|
||||
.build();
|
||||
WebTarget target = client.target(this.tokenUrl);
|
||||
|
||||
long requestSendTime = System.currentTimeMillis();
|
||||
|
||||
Response response = target.request().post(entity);
|
||||
|
||||
@@ -160,8 +185,10 @@ public abstract class OAuthAuthorizationFilter implements AuthorizationFilter {
|
||||
}
|
||||
|
||||
this.accessToken = (String)responseMap.get("access_token");
|
||||
this.expiration = System.currentTimeMillis() + ((Number)responseMap.get("expires_in")).longValue() * 1000L;
|
||||
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() {
|
||||
|
||||
@@ -14,7 +14,10 @@
|
||||
*/
|
||||
package com.inteligr8.rs;
|
||||
|
||||
import javax.ws.rs.core.Form;
|
||||
import jakarta.ws.rs.core.Form;
|
||||
|
||||
import org.slf4j.Logger;
|
||||
import org.slf4j.LoggerFactory;
|
||||
|
||||
/**
|
||||
* This class implements the OAuth Client Credential flow as an authorization
|
||||
@@ -23,6 +26,8 @@ import javax.ws.rs.core.Form;
|
||||
* @author brian@inteligr8.com
|
||||
*/
|
||||
public class OAuthClientCredentialAuthorizationFilter extends OAuthAuthorizationFilter {
|
||||
|
||||
private final Logger logger = LoggerFactory.getLogger(this.getClass());
|
||||
|
||||
/**
|
||||
* @param tokenUrl The URL to the OAuth IdP token service.
|
||||
@@ -35,6 +40,7 @@ public class OAuthClientCredentialAuthorizationFilter extends OAuthAuthorization
|
||||
|
||||
@Override
|
||||
protected Form createForm() {
|
||||
this.logger.debug("Using OAuth grant_type 'client_credentials'");
|
||||
return new Form().param("grant_type", "client_credentials");
|
||||
}
|
||||
|
||||
|
||||
@@ -14,7 +14,11 @@
|
||||
*/
|
||||
package com.inteligr8.rs;
|
||||
|
||||
import javax.ws.rs.core.Form;
|
||||
import jakarta.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
|
||||
@@ -23,6 +27,8 @@ import javax.ws.rs.core.Form;
|
||||
* @author brian@inteligr8.com
|
||||
*/
|
||||
public class OAuthPasswordGrantAuthorizationFilter extends OAuthAuthorizationFilter {
|
||||
|
||||
private final Logger logger = LoggerFactory.getLogger(this.getClass());
|
||||
|
||||
private final String username;
|
||||
private final String password;
|
||||
@@ -46,12 +52,13 @@ public class OAuthPasswordGrantAuthorizationFilter extends OAuthAuthorizationFil
|
||||
*/
|
||||
public OAuthPasswordGrantAuthorizationFilter(String tokenUrl, String clientId, String clientSecret, String username, String password) {
|
||||
super(tokenUrl, clientId, clientSecret);
|
||||
this.username = username;
|
||||
this.password = password;
|
||||
this.username = StringUtils.trimToNull(username);
|
||||
this.password = StringUtils.trimToNull(password);
|
||||
}
|
||||
|
||||
@Override
|
||||
protected Form createForm() {
|
||||
this.logger.debug("Using OAuth grant_type 'password': {}", this.username);
|
||||
return new Form().param("grant_type", "password")
|
||||
.param("username", this.username);
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user