Compare commits
18 Commits
v2.0.1-jer
...
v2.0.4-cxf
Author | SHA1 | Date | |
---|---|---|---|
00f25ff054 | |||
003afc208e | |||
85df5d3ea4 | |||
9a9a958913 | |||
37e8b63179 | |||
255a9c8e85 | |||
c9833bb4b1 | |||
bcb7d4a7ed | |||
23b9c4ccb2 | |||
6bb1561825 | |||
0ce2369452 | |||
ae82bc4ec7 | |||
8b13f06667 | |||
964cec0fb5 | |||
fe2e04f3af | |||
cc8d9e9d13 | |||
93a2eaa34e | |||
1a1cbb1246 |
19
README.md
19
README.md
@@ -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 for the Jersey JAXRS-based client frameworks.
|
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.
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
@@ -15,7 +15,8 @@ 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>
|
||||||
<version>...-jersey</version>
|
<classifier>...</classifier>
|
||||||
|
<version>...</version>
|
||||||
</dependency>
|
</dependency>
|
||||||
...
|
...
|
||||||
</dependencies>
|
</dependencies>
|
||||||
@@ -23,6 +24,8 @@ First, you will need to include the library in your project.
|
|||||||
</project>
|
</project>
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Valid `classifier` values are `cxf` or `jersey`.
|
||||||
|
|
||||||
### Spring Framework
|
### Spring Framework
|
||||||
|
|
||||||
#### Single Client
|
#### Single Client
|
||||||
@@ -33,27 +36,29 @@ If you will only be declaring a single client in your Spring context, this is ea
|
|||||||
@Component
|
@Component
|
||||||
public class ... {
|
public class ... {
|
||||||
@Autowired
|
@Autowired
|
||||||
@Qualifier("client.jersey") // may be optional
|
@Qualifier("client.cxf") // may be optional
|
||||||
private Client client;
|
private Client client;
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
Next, you need to configure that client. You can do that by providing a single implementation of the `ClientConfiguration` (or `ClientJerseyConfiguration`) interface.
|
Next, you need to configure that client. You can do that by providing a single implementation of the `ClientConfiguration` (or `ClientCxfConfiguration`) interface.
|
||||||
|
|
||||||
```java
|
```java
|
||||||
@Configuration
|
@Configuration
|
||||||
public class ... implements ClientJerseyConfiguration {
|
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
|
#### 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.
|
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
|
```java
|
||||||
@Component("my.client")
|
@Component("my.client")
|
||||||
public class MyClient extends ClientJerseyImpl {
|
public class MyClient extends ClientCxfImpl {
|
||||||
@Autowired
|
@Autowired
|
||||||
public MyClient(MyClientConfiguration config) {
|
public MyClient(MyClientConfiguration config) {
|
||||||
super(config);
|
super(config);
|
||||||
@@ -82,6 +87,6 @@ You do not have to use the Spring framework to use these classes. You can insta
|
|||||||
```java
|
```java
|
||||||
MyClientConfiguration config = new MyClientConfiguration();
|
MyClientConfiguration config = new MyClientConfiguration();
|
||||||
...
|
...
|
||||||
ClientJerseyImpl client = new ClientJerseyImpl(config);
|
ClientCxfImpl client = new ClientCxfImpl(config);
|
||||||
MyJaxRsApi api = client.getApi(MyJaxRsApi.class);
|
MyJaxRsApi api = client.getApi(MyJaxRsApi.class);
|
||||||
```
|
```
|
||||||
|
105
pom.xml
105
pom.xml
@@ -6,11 +6,11 @@
|
|||||||
|
|
||||||
<groupId>com.inteligr8</groupId>
|
<groupId>com.inteligr8</groupId>
|
||||||
<artifactId>common-rest-client</artifactId>
|
<artifactId>common-rest-client</artifactId>
|
||||||
<version>2.0.1-jersey</version>
|
<version>2.0.4-cxf</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 Jersey REST API clients</description>
|
<description>A common library for building CXF REST API clients</description>
|
||||||
<url>https://bitbucket.org/inteligr8/common-rest-client</url>
|
<url>https://bitbucket.org/inteligr8/common-rest-client</url>
|
||||||
|
|
||||||
<licenses>
|
<licenses>
|
||||||
@@ -44,8 +44,9 @@
|
|||||||
<maven.compiler.target>8</maven.compiler.target>
|
<maven.compiler.target>8</maven.compiler.target>
|
||||||
|
|
||||||
<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.3.27</spring.version>
|
||||||
<jersey.version>2.35</jersey.version>
|
<jackson.version>2.15.1</jackson.version>
|
||||||
|
<cxf.version>3.5.6</cxf.version>
|
||||||
</properties>
|
</properties>
|
||||||
|
|
||||||
<dependencies>
|
<dependencies>
|
||||||
@@ -57,22 +58,22 @@
|
|||||||
<dependency>
|
<dependency>
|
||||||
<groupId>com.fasterxml.jackson.core</groupId>
|
<groupId>com.fasterxml.jackson.core</groupId>
|
||||||
<artifactId>jackson-databind</artifactId>
|
<artifactId>jackson-databind</artifactId>
|
||||||
<version>2.12.2</version>
|
<version>${jackson.version}</version>
|
||||||
</dependency>
|
</dependency>
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>com.fasterxml.jackson.jaxrs</groupId>
|
<groupId>com.fasterxml.jackson.jaxrs</groupId>
|
||||||
<artifactId>jackson-jaxrs-json-provider</artifactId>
|
<artifactId>jackson-jaxrs-json-provider</artifactId>
|
||||||
<version>2.12.2</version>
|
<version>${jackson.version}</version>
|
||||||
</dependency>
|
</dependency>
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>com.fasterxml.jackson.datatype</groupId>
|
<groupId>com.fasterxml.jackson.datatype</groupId>
|
||||||
<artifactId>jackson-datatype-jsr310</artifactId>
|
<artifactId>jackson-datatype-jsr310</artifactId>
|
||||||
<version>2.12.2</version>
|
<version>${jackson.version}</version>
|
||||||
</dependency>
|
</dependency>
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>org.slf4j</groupId>
|
<groupId>org.slf4j</groupId>
|
||||||
<artifactId>slf4j-api</artifactId>
|
<artifactId>slf4j-api</artifactId>
|
||||||
<version>1.7.29</version>
|
<version>1.7.36</version>
|
||||||
</dependency>
|
</dependency>
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>jakarta.ws.rs</groupId>
|
<groupId>jakarta.ws.rs</groupId>
|
||||||
@@ -94,37 +95,15 @@
|
|||||||
<dependency>
|
<dependency>
|
||||||
<groupId>org.apache.httpcomponents</groupId>
|
<groupId>org.apache.httpcomponents</groupId>
|
||||||
<artifactId>httpclient</artifactId>
|
<artifactId>httpclient</artifactId>
|
||||||
<version>4.5.9</version>
|
<version>4.5.14</version>
|
||||||
<scope>test</scope>
|
<scope>test</scope>
|
||||||
</dependency>
|
</dependency>
|
||||||
|
|
||||||
<!-- Jersey libraries -->
|
<!-- Apache CXF libraries -->
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>org.glassfish.jersey.ext</groupId>
|
<groupId>org.apache.cxf</groupId>
|
||||||
<artifactId>jersey-proxy-client</artifactId>
|
<artifactId>cxf-rt-rs-client</artifactId>
|
||||||
<version>${jersey.version}</version>
|
<version>${cxf.version}</version>
|
||||||
</dependency>
|
|
||||||
<dependency>
|
|
||||||
<groupId>org.glassfish.jersey.core</groupId>
|
|
||||||
<artifactId>jersey-client</artifactId>
|
|
||||||
<version>${jersey.version}</version>
|
|
||||||
</dependency>
|
|
||||||
<dependency>
|
|
||||||
<groupId>org.glassfish.jersey.media</groupId>
|
|
||||||
<artifactId>jersey-media-multipart</artifactId>
|
|
||||||
<version>${jersey.version}</version>
|
|
||||||
</dependency>
|
|
||||||
<dependency>
|
|
||||||
<groupId>org.glassfish.jersey.inject</groupId>
|
|
||||||
<artifactId>jersey-hk2</artifactId>
|
|
||||||
<version>${jersey.version}</version>
|
|
||||||
<scope>test</scope>
|
|
||||||
</dependency>
|
|
||||||
<dependency>
|
|
||||||
<groupId>org.glassfish.jersey.media</groupId>
|
|
||||||
<artifactId>jersey-media-json-jackson</artifactId>
|
|
||||||
<version>${jersey.version}</version>
|
|
||||||
<scope>test</scope>
|
|
||||||
</dependency>
|
</dependency>
|
||||||
</dependencies>
|
</dependencies>
|
||||||
|
|
||||||
@@ -133,14 +112,14 @@
|
|||||||
<plugin>
|
<plugin>
|
||||||
<groupId>org.codehaus.mojo</groupId>
|
<groupId>org.codehaus.mojo</groupId>
|
||||||
<artifactId>build-helper-maven-plugin</artifactId>
|
<artifactId>build-helper-maven-plugin</artifactId>
|
||||||
<version>3.2.0</version>
|
<version>3.4.0</version>
|
||||||
<executions>
|
<executions>
|
||||||
<execution>
|
<execution>
|
||||||
<id>add-jaxrs-src</id>
|
<id>add-jaxrs-src</id>
|
||||||
<goals><goal>add-source</goal></goals>
|
<goals><goal>add-source</goal></goals>
|
||||||
<configuration>
|
<configuration>
|
||||||
<sources>
|
<sources>
|
||||||
<source>src/main/jersey</source>
|
<source>src/main/cxf</source>
|
||||||
</sources>
|
</sources>
|
||||||
</configuration>
|
</configuration>
|
||||||
</execution>
|
</execution>
|
||||||
@@ -149,7 +128,7 @@
|
|||||||
<goals><goal>add-test-source</goal></goals>
|
<goals><goal>add-test-source</goal></goals>
|
||||||
<configuration>
|
<configuration>
|
||||||
<sources>
|
<sources>
|
||||||
<source>src/test/jersey</source>
|
<source>src/test/cxf</source>
|
||||||
</sources>
|
</sources>
|
||||||
</configuration>
|
</configuration>
|
||||||
</execution>
|
</execution>
|
||||||
@@ -157,7 +136,7 @@
|
|||||||
</plugin>
|
</plugin>
|
||||||
<plugin>
|
<plugin>
|
||||||
<artifactId>maven-surefire-plugin</artifactId>
|
<artifactId>maven-surefire-plugin</artifactId>
|
||||||
<version>3.0.0-M5</version>
|
<version>3.1.0</version>
|
||||||
<dependencies>
|
<dependencies>
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>org.junit.jupiter</groupId>
|
<groupId>org.junit.jupiter</groupId>
|
||||||
@@ -168,7 +147,7 @@
|
|||||||
</plugin>
|
</plugin>
|
||||||
<plugin>
|
<plugin>
|
||||||
<artifactId>maven-failsafe-plugin</artifactId>
|
<artifactId>maven-failsafe-plugin</artifactId>
|
||||||
<version>3.0.0-M5</version>
|
<version>3.1.0</version>
|
||||||
<dependencies>
|
<dependencies>
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>org.junit.jupiter</groupId>
|
<groupId>org.junit.jupiter</groupId>
|
||||||
@@ -177,29 +156,6 @@
|
|||||||
</dependency>
|
</dependency>
|
||||||
</dependencies>
|
</dependencies>
|
||||||
</plugin>
|
</plugin>
|
||||||
<plugin>
|
|
||||||
<artifactId>maven-source-plugin</artifactId>
|
|
||||||
<executions>
|
|
||||||
<execution>
|
|
||||||
<id>source</id>
|
|
||||||
<phase>package</phase>
|
|
||||||
<goals><goal>jar-no-fork</goal></goals>
|
|
||||||
</execution>
|
|
||||||
</executions>
|
|
||||||
</plugin>
|
|
||||||
<plugin>
|
|
||||||
<artifactId>maven-javadoc-plugin</artifactId>
|
|
||||||
<executions>
|
|
||||||
<execution>
|
|
||||||
<id>javadoc</id>
|
|
||||||
<phase>package</phase>
|
|
||||||
<goals><goal>jar</goal></goals>
|
|
||||||
<configuration>
|
|
||||||
<show>public</show>
|
|
||||||
</configuration>
|
|
||||||
</execution>
|
|
||||||
</executions>
|
|
||||||
</plugin>
|
|
||||||
</plugins>
|
</plugins>
|
||||||
</build>
|
</build>
|
||||||
|
|
||||||
@@ -211,6 +167,29 @@
|
|||||||
</properties>
|
</properties>
|
||||||
<build>
|
<build>
|
||||||
<plugins>
|
<plugins>
|
||||||
|
<plugin>
|
||||||
|
<artifactId>maven-source-plugin</artifactId>
|
||||||
|
<executions>
|
||||||
|
<execution>
|
||||||
|
<id>source</id>
|
||||||
|
<phase>package</phase>
|
||||||
|
<goals><goal>jar-no-fork</goal></goals>
|
||||||
|
</execution>
|
||||||
|
</executions>
|
||||||
|
</plugin>
|
||||||
|
<plugin>
|
||||||
|
<artifactId>maven-javadoc-plugin</artifactId>
|
||||||
|
<executions>
|
||||||
|
<execution>
|
||||||
|
<id>javadoc</id>
|
||||||
|
<phase>package</phase>
|
||||||
|
<goals><goal>jar</goal></goals>
|
||||||
|
<configuration>
|
||||||
|
<show>public</show>
|
||||||
|
</configuration>
|
||||||
|
</execution>
|
||||||
|
</executions>
|
||||||
|
</plugin>
|
||||||
<plugin>
|
<plugin>
|
||||||
<artifactId>maven-gpg-plugin</artifactId>
|
<artifactId>maven-gpg-plugin</artifactId>
|
||||||
<executions>
|
<executions>
|
||||||
|
@@ -15,20 +15,23 @@
|
|||||||
package com.inteligr8.rs;
|
package com.inteligr8.rs;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* This interface defines additional configurations specific to the Jersey
|
* This interface defines additional configurations specific to the Apache CXF
|
||||||
* JAX-RS library and its nuances.
|
* JAX-RS library and its nuances.
|
||||||
*
|
*
|
||||||
* @author brian@inteligr8.com
|
* @author brian@inteligr8.com
|
||||||
*/
|
*/
|
||||||
public interface ClientJerseyConfiguration extends ClientConfiguration {
|
public interface ClientCxfConfiguration extends ClientConfiguration {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Jersey is automatically strict in its adherence to the ReST API
|
* Apache CXF uses a global bus configuration where interceptors could
|
||||||
* specifications. It requires a body to PUT calls by default.
|
* wreck havoc on your implementation. This method allows you to
|
||||||
|
* explicitly by-pass the default bus.
|
||||||
*
|
*
|
||||||
* @return true to require body in PUT calls; false to make it optional
|
* See https://cxf.apache.org/docs/bus-configuration.html.
|
||||||
|
*
|
||||||
|
* @return true to use the default bus; false otherwise.
|
||||||
*/
|
*/
|
||||||
default boolean isPutBodyRequired() {
|
default boolean isDefaultBusEnabled() {
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
|
|
142
src/main/cxf/com/inteligr8/rs/ClientCxfImpl.java
Normal file
142
src/main/cxf/com/inteligr8/rs/ClientCxfImpl.java
Normal file
@@ -0,0 +1,142 @@
|
|||||||
|
/*
|
||||||
|
* 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.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 ClientCxfConfiguration config;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 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() {
|
||||||
|
return this.getCxfClient(null);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param authFilter A post-configuration authorization filter.
|
||||||
|
* @return A CXF client (not JAX-RS).
|
||||||
|
*/
|
||||||
|
public WebClient getCxfClient(AuthorizationFilter authFilter) {
|
||||||
|
List<Object> providersAndFilters = new LinkedList<Object>();
|
||||||
|
providersAndFilters.add(new JacksonJaxbJsonProvider());
|
||||||
|
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());
|
||||||
|
}
|
||||||
|
|
||||||
|
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);
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
52
src/main/cxf/com/inteligr8/rs/CxfLoggingFilter.java
Normal file
52
src/main/cxf/com/inteligr8/rs/CxfLoggingFilter.java
Normal file
@@ -0,0 +1,52 @@
|
|||||||
|
/*
|
||||||
|
* 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());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
49
src/main/cxf/com/inteligr8/rs/CxfMultipartProvider.java
Normal file
49
src/main/cxf/com/inteligr8/rs/CxfMultipartProvider.java
Normal file
@@ -0,0 +1,49 @@
|
|||||||
|
/*
|
||||||
|
* 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);
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
@@ -18,9 +18,10 @@ import javax.ws.rs.client.ClientBuilder;
|
|||||||
import javax.ws.rs.client.WebTarget;
|
import javax.ws.rs.client.WebTarget;
|
||||||
|
|
||||||
import com.fasterxml.jackson.databind.DeserializationFeature;
|
import com.fasterxml.jackson.databind.DeserializationFeature;
|
||||||
|
import com.fasterxml.jackson.databind.ObjectMapper;
|
||||||
import com.fasterxml.jackson.databind.SerializationFeature;
|
import com.fasterxml.jackson.databind.SerializationFeature;
|
||||||
|
import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule;
|
||||||
import com.fasterxml.jackson.jaxrs.json.JacksonJaxbJsonProvider;
|
import com.fasterxml.jackson.jaxrs.json.JacksonJaxbJsonProvider;
|
||||||
import com.fasterxml.jackson.jaxrs.json.JacksonJsonProvider;
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* A class that provides pre-configured JAX-RS Client & WebTarget objects.
|
* A class that provides pre-configured JAX-RS Client & WebTarget objects.
|
||||||
@@ -66,8 +67,16 @@ public abstract class Client {
|
|||||||
* @return A pre-configured JAX-RS client (no URL) with the specified authorization.
|
* @return A pre-configured JAX-RS client (no URL) with the specified authorization.
|
||||||
*/
|
*/
|
||||||
public final javax.ws.rs.client.Client buildClient(AuthorizationFilter authFilter) {
|
public final javax.ws.rs.client.Client buildClient(AuthorizationFilter authFilter) {
|
||||||
JacksonJsonProvider provider = new JacksonJaxbJsonProvider();
|
ObjectMapper om = new ObjectMapper();
|
||||||
|
om.registerModules(new JavaTimeModule());
|
||||||
|
this.getConfig().configureJacksonMapper(om);
|
||||||
|
|
||||||
|
JacksonJaxbJsonProvider provider = new JacksonJaxbJsonProvider(om, JacksonJaxbJsonProvider.DEFAULT_ANNOTATIONS);
|
||||||
|
provider.enable(DeserializationFeature.READ_UNKNOWN_ENUM_VALUES_AS_NULL);
|
||||||
|
provider.disable(DeserializationFeature.READ_UNKNOWN_ENUM_VALUES_USING_DEFAULT_VALUE);
|
||||||
|
|
||||||
|
this.getConfig().configureJacksonProvider(provider);
|
||||||
|
|
||||||
if (this.getConfig().isWrapRootValueEnabled())
|
if (this.getConfig().isWrapRootValueEnabled())
|
||||||
provider.enable(SerializationFeature.WRAP_ROOT_VALUE);
|
provider.enable(SerializationFeature.WRAP_ROOT_VALUE);
|
||||||
if (this.getConfig().isUnwrapRootValueEnabled())
|
if (this.getConfig().isUnwrapRootValueEnabled())
|
||||||
@@ -83,15 +92,17 @@ public abstract class Client {
|
|||||||
clientBuilder.register(authFilter);
|
clientBuilder.register(authFilter);
|
||||||
this.buildClient(clientBuilder);
|
this.buildClient(clientBuilder);
|
||||||
|
|
||||||
|
this.getConfig().configureClient(clientBuilder);
|
||||||
|
|
||||||
return clientBuilder.build();
|
return clientBuilder.build();
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param clientBuilder A client builder
|
* @param clientBuilder A client builder
|
||||||
*/
|
*/
|
||||||
public void buildClient(ClientBuilder clientBuilder) {
|
public void buildClient(ClientBuilder clientBuilder) {
|
||||||
// for extension purposes
|
// for extension purposes
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @return A pre-configured JAX-RS target (client w/ base URL) with configured authorization.
|
* @return A pre-configured JAX-RS target (client w/ base URL) with configured authorization.
|
||||||
|
@@ -16,6 +16,11 @@ package com.inteligr8.rs;
|
|||||||
|
|
||||||
import java.net.URI;
|
import java.net.URI;
|
||||||
|
|
||||||
|
import javax.ws.rs.client.ClientBuilder;
|
||||||
|
|
||||||
|
import com.fasterxml.jackson.databind.ObjectMapper;
|
||||||
|
import com.fasterxml.jackson.jaxrs.json.JacksonJaxbJsonProvider;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* This interface defines the configurable parameters of the clients; primarily
|
* This interface defines the configurable parameters of the clients; primarily
|
||||||
* their default authentication and authorization.
|
* their default authentication and authorization.
|
||||||
@@ -128,6 +133,18 @@ public interface ClientConfiguration {
|
|||||||
default boolean isWrapRootValueEnabled() {
|
default boolean isWrapRootValueEnabled() {
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param mapper A Jackson object mapper to configure.
|
||||||
|
*/
|
||||||
|
default void configureJacksonMapper(ObjectMapper mapper) {
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param provider A Jackson JAX-RS provider to configure.
|
||||||
|
*/
|
||||||
|
default void configureJacksonProvider(JacksonJaxbJsonProvider provider) {
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -169,5 +186,13 @@ public interface ClientConfiguration {
|
|||||||
return null;
|
return null;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A Jackson provider, logging filter, and authentication filter are already registered.
|
||||||
|
*
|
||||||
|
* @param clientBuilder A JAX-RS client builder to configure.
|
||||||
|
*/
|
||||||
|
default void configureClient(ClientBuilder clientBuilder) {
|
||||||
|
}
|
||||||
|
|
||||||
}
|
}
|
||||||
|
@@ -1,105 +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 javax.annotation.PostConstruct;
|
|
||||||
import javax.ws.rs.client.ClientBuilder;
|
|
||||||
import javax.ws.rs.ext.RuntimeDelegate;
|
|
||||||
|
|
||||||
import org.glassfish.jersey.client.ClientProperties;
|
|
||||||
import org.glassfish.jersey.client.proxy.WebResourceFactory;
|
|
||||||
import org.glassfish.jersey.internal.RuntimeDelegateImpl;
|
|
||||||
import org.glassfish.jersey.media.multipart.MultiPartFeature;
|
|
||||||
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
|
|
||||||
* for Jersey.
|
|
||||||
*
|
|
||||||
* @author brian@inteligr8.com
|
|
||||||
*/
|
|
||||||
@Component("client.jersey")
|
|
||||||
public class ClientJerseyImpl extends Client {
|
|
||||||
|
|
||||||
private final Logger logger = LoggerFactory.getLogger(ClientJerseyImpl.class);
|
|
||||||
|
|
||||||
private ClientJerseyConfiguration config;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* This constructor is for Spring or POJO use.
|
|
||||||
* @param config The client configuration.
|
|
||||||
*/
|
|
||||||
@Autowired
|
|
||||||
public ClientJerseyImpl(ClientJerseyConfiguration config) {
|
|
||||||
this.config = config;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* This method registers the Jersey 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 Jersey library");
|
|
||||||
RuntimeDelegate.setInstance(new RuntimeDelegateImpl());
|
|
||||||
} else if (RuntimeDelegate.getInstance() instanceof RuntimeDelegateImpl) {
|
|
||||||
this.logger.info("JAX-RS runtime delegate already the Jersey library");
|
|
||||||
} else {
|
|
||||||
this.logger.warn("Setting JAX-RS runtime delegate to the Jersey library; was: " + RuntimeDelegate.getInstance().getClass().getName());
|
|
||||||
RuntimeDelegate.setInstance(new RuntimeDelegateImpl());
|
|
||||||
}
|
|
||||||
|
|
||||||
if (this.logger.isInfoEnabled())
|
|
||||||
this.logger.info("API Base URL: " + this.getConfig().getBaseUrl());
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @param clientBuilder A client builder.
|
|
||||||
*/
|
|
||||||
@Override
|
|
||||||
public void buildClient(ClientBuilder clientBuilder) {
|
|
||||||
clientBuilder.register(MultiPartFeature.class);
|
|
||||||
|
|
||||||
if (!this.getConfig().isPutBodyRequired()) {
|
|
||||||
// allow PUT operations without body data
|
|
||||||
clientBuilder.property(ClientProperties.SUPPRESS_HTTP_COMPLIANCE_VALIDATION, true);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @return The client configuration.
|
|
||||||
*/
|
|
||||||
public ClientJerseyConfiguration 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 WebResourceFactory.newResource(apiClass, this.getTarget(authFilter));
|
|
||||||
}
|
|
||||||
|
|
||||||
}
|
|
Reference in New Issue
Block a user