Compare commits
78 Commits
v2.0.8-jer
...
stable-cxf
Author | SHA1 | Date | |
---|---|---|---|
637898120a | |||
7f7d7a9004 | |||
0820dd7a7c | |||
65eedab7e6 | |||
4d3af40911 | |||
06b4171141 | |||
4353c673db | |||
66454c36ef | |||
c1621491c8 | |||
eb2bd96ced | |||
c2147e1461 | |||
4ac69a15cf | |||
8fb4527b90 | |||
52cffffa8e | |||
e9bc191945 | |||
d5ef510aeb | |||
24fbe5f5ed | |||
6c58263903 | |||
e015ec5a1e | |||
795c9fef44 | |||
e1b3fd9b92 | |||
b2efbc3f5f | |||
d46d258a65 | |||
f5998ebde6 | |||
6b79be8e41 | |||
eb7ac34f5e | |||
964a55fcc8 | |||
b7ac0d25c9 | |||
5e3e9080a9 | |||
dfb039dc17 | |||
271016dcf9 | |||
00ec8c972d | |||
bedc424ab5 | |||
b4d6c1c72c | |||
2cd9cc9484 | |||
618d008a37 | |||
303af956cb | |||
ec4ffbee43 | |||
d4cd2f248c | |||
ac6f82a7f4 | |||
eb654c5488 | |||
8c9cbecd53 | |||
81198de0fb | |||
0258cfcb9a | |||
6fc43b85f7 | |||
803d49e53e | |||
adad70d884 | |||
512f118354 | |||
26c37ab737 | |||
4de7968e11 | |||
21255bfb3d | |||
378563560b | |||
d23a4249f7 | |||
8628d2dce8 | |||
f10fd39e97 | |||
eaed628f00 | |||
e4e393a855 | |||
c7ce4e7c57 | |||
458cdad213 | |||
8b03d251e8 | |||
a1acb3f9d9 | |||
00f25ff054 | |||
003afc208e | |||
cd278bcc81 | |||
b64c408029 | |||
85df5d3ea4 | |||
ec6e7cc15d | |||
2451c634b7 | |||
c9833bb4b1 | |||
23b9c4ccb2 | |||
6bb1561825 | |||
ed00346e71 | |||
c001576b65 | |||
0ce2369452 | |||
ae82bc4ec7 | |||
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);
|
||||||
```
|
```
|
||||||
|
74
pom.xml
74
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.8-jersey</version>
|
<version>3.0.3-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>
|
||||||
@@ -40,16 +40,21 @@
|
|||||||
|
|
||||||
<properties>
|
<properties>
|
||||||
<project.build.sourceEncoding>utf-8</project.build.sourceEncoding>
|
<project.build.sourceEncoding>utf-8</project.build.sourceEncoding>
|
||||||
<maven.compiler.source>8</maven.compiler.source>
|
<maven.compiler.source>11</maven.compiler.source>
|
||||||
<maven.compiler.target>8</maven.compiler.target>
|
<maven.compiler.target>11</maven.compiler.target>
|
||||||
|
|
||||||
<junit.version>5.7.2</junit.version>
|
<junit.version>5.12.0</junit.version>
|
||||||
<spring.version>5.3.27</spring.version>
|
<spring.version>6.0.23</spring.version>
|
||||||
<jackson.version>2.15.1</jackson.version>
|
<jackson.version>2.17.3</jackson.version>
|
||||||
<jersey.version>2.39.1</jersey.version>
|
<cxf.version>4.0.6</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>
|
||||||
@@ -61,8 +66,8 @@
|
|||||||
<version>${jackson.version}</version>
|
<version>${jackson.version}</version>
|
||||||
</dependency>
|
</dependency>
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>com.fasterxml.jackson.jaxrs</groupId>
|
<groupId>com.fasterxml.jackson.jakarta.rs</groupId>
|
||||||
<artifactId>jackson-jaxrs-json-provider</artifactId>
|
<artifactId>jackson-jakarta-rs-json-provider</artifactId>
|
||||||
<version>${jackson.version}</version>
|
<version>${jackson.version}</version>
|
||||||
</dependency>
|
</dependency>
|
||||||
<dependency>
|
<dependency>
|
||||||
@@ -70,15 +75,20 @@
|
|||||||
<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.17.0</version>
|
||||||
|
</dependency>
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>org.slf4j</groupId>
|
<groupId>org.slf4j</groupId>
|
||||||
<artifactId>slf4j-api</artifactId>
|
<artifactId>slf4j-api</artifactId>
|
||||||
<version>1.7.36</version>
|
<version>2.0.17</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>2.1.6</version>
|
<version>3.1.0</version>
|
||||||
</dependency>
|
</dependency>
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>org.junit.jupiter</groupId>
|
<groupId>org.junit.jupiter</groupId>
|
||||||
@@ -99,33 +109,11 @@
|
|||||||
<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>
|
||||||
|
|
||||||
@@ -141,7 +129,7 @@
|
|||||||
<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>
|
||||||
@@ -150,7 +138,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>
|
||||||
@@ -158,7 +146,7 @@
|
|||||||
</plugin>
|
</plugin>
|
||||||
<plugin>
|
<plugin>
|
||||||
<artifactId>maven-surefire-plugin</artifactId>
|
<artifactId>maven-surefire-plugin</artifactId>
|
||||||
<version>3.1.0</version>
|
<version>3.4.0</version>
|
||||||
<dependencies>
|
<dependencies>
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>org.junit.jupiter</groupId>
|
<groupId>org.junit.jupiter</groupId>
|
||||||
@@ -169,7 +157,7 @@
|
|||||||
</plugin>
|
</plugin>
|
||||||
<plugin>
|
<plugin>
|
||||||
<artifactId>maven-failsafe-plugin</artifactId>
|
<artifactId>maven-failsafe-plugin</artifactId>
|
||||||
<version>3.1.0</version>
|
<version>3.4.0</version>
|
||||||
<dependencies>
|
<dependencies>
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>org.junit.jupiter</groupId>
|
<groupId>org.junit.jupiter</groupId>
|
||||||
@@ -225,7 +213,7 @@
|
|||||||
<plugin>
|
<plugin>
|
||||||
<groupId>org.sonatype.plugins</groupId>
|
<groupId>org.sonatype.plugins</groupId>
|
||||||
<artifactId>nexus-staging-maven-plugin</artifactId>
|
<artifactId>nexus-staging-maven-plugin</artifactId>
|
||||||
<version>1.6.13</version>
|
<version>1.6.14</version>
|
||||||
<configuration>
|
<configuration>
|
||||||
<serverId>ossrh</serverId>
|
<serverId>ossrh</serverId>
|
||||||
<nexusUrl>https://s01.oss.sonatype.org/</nexusUrl>
|
<nexusUrl>https://s01.oss.sonatype.org/</nexusUrl>
|
||||||
|
@@ -14,22 +14,35 @@
|
|||||||
*/
|
*/
|
||||||
package com.inteligr8.rs;
|
package com.inteligr8.rs;
|
||||||
|
|
||||||
|
import org.apache.cxf.jaxrs.client.WebClient;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* 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;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A Jackson provider, logging filter, and authentication filter are already registered.
|
||||||
|
*
|
||||||
|
* @param client A CXF client to configure.
|
||||||
|
*/
|
||||||
|
default void configureClient(WebClient client) {
|
||||||
|
}
|
||||||
|
|
||||||
}
|
}
|
181
src/main/cxf/com/inteligr8/rs/ClientCxfImpl.java
Normal file
181
src/main/cxf/com/inteligr8/rs/ClientCxfImpl.java
Normal file
@@ -0,0 +1,181 @@
|
|||||||
|
/*
|
||||||
|
* 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 & WebTarget &
|
||||||
|
* 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);
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
54
src/main/cxf/com/inteligr8/rs/CxfLoggingFilter.java
Normal file
54
src/main/cxf/com/inteligr8/rs/CxfLoggingFilter.java
Normal file
@@ -0,0 +1,54 @@
|
|||||||
|
/*
|
||||||
|
* 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);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
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 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);
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
@@ -14,7 +14,7 @@
|
|||||||
*/
|
*/
|
||||||
package com.inteligr8.rs;
|
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
|
* 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.io.UnsupportedEncodingException;
|
||||||
import java.util.Base64;
|
import java.util.Base64;
|
||||||
|
|
||||||
import javax.ws.rs.client.ClientRequestContext;
|
import jakarta.ws.rs.client.ClientRequestContext;
|
||||||
import javax.ws.rs.core.HttpHeaders;
|
import jakarta.ws.rs.core.HttpHeaders;
|
||||||
|
|
||||||
|
import org.apache.commons.lang3.StringUtils;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* This class implements a simple 2-credential (username & password) based
|
* This class implements a simple 2-credential (username & password) based
|
||||||
@@ -32,12 +34,14 @@ public class BasicAuthorizationFilter implements AuthorizationFilter {
|
|||||||
private final String password;
|
private final String password;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* This constructor instantiates the filter with required fields.
|
||||||
|
*
|
||||||
* @param username A username or access key.
|
* @param username A username or access key.
|
||||||
* @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 = username;
|
this.username = StringUtils.trimToNull(username);
|
||||||
this.password = password;
|
this.password = StringUtils.trimToNull(password);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
@@ -14,8 +14,8 @@
|
|||||||
*/
|
*/
|
||||||
package com.inteligr8.rs;
|
package com.inteligr8.rs;
|
||||||
|
|
||||||
import javax.ws.rs.client.ClientRequestContext;
|
import jakarta.ws.rs.client.ClientRequestContext;
|
||||||
import javax.ws.rs.core.HttpHeaders;
|
import jakarta.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
|
||||||
@@ -32,6 +32,8 @@ public class BearerTokenAuthorizationFilter implements AuthorizationFilter {
|
|||||||
private final String token;
|
private final String token;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* This constructor instantiates the filter with required fields.
|
||||||
|
*
|
||||||
* @param token A 'Bearer' token.
|
* @param token A 'Bearer' token.
|
||||||
*/
|
*/
|
||||||
public BearerTokenAuthorizationFilter(String token) {
|
public BearerTokenAuthorizationFilter(String token) {
|
||||||
|
@@ -16,34 +16,39 @@ package com.inteligr8.rs;
|
|||||||
|
|
||||||
import java.util.concurrent.TimeUnit;
|
import java.util.concurrent.TimeUnit;
|
||||||
|
|
||||||
import javax.ws.rs.client.ClientBuilder;
|
import jakarta.ws.rs.client.ClientBuilder;
|
||||||
import javax.ws.rs.client.WebTarget;
|
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.ObjectMapper;
|
||||||
import com.fasterxml.jackson.databind.SerializationFeature;
|
import com.fasterxml.jackson.databind.SerializationFeature;
|
||||||
import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule;
|
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.
|
* A class that provides pre-configured Jakarta RS Client & WebTarget objects.
|
||||||
*
|
*
|
||||||
* @author brian@inteligr8.com
|
* @author brian@inteligr8.com
|
||||||
*/
|
*/
|
||||||
public abstract class Client {
|
public abstract class Client {
|
||||||
|
|
||||||
private final Object sync = new Object();
|
private final Object sync = new Object();
|
||||||
private javax.ws.rs.client.Client client;
|
private jakarta.ws.rs.client.Client client;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* This method retrieves the configuration for the client.
|
||||||
|
*
|
||||||
* @return The client configuration.
|
* @return The client configuration.
|
||||||
*/
|
*/
|
||||||
public abstract ClientConfiguration getConfig();
|
public abstract ClientConfiguration getConfig();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @return A pre-configured JAX-RS client (no URL) with configured authorization.
|
* This method retrieves an anonymous cached instance of the underlying
|
||||||
|
* Jakarta RS client.
|
||||||
|
*
|
||||||
|
* @return A pre-configured Jakarta 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) {
|
synchronized (this.sync) {
|
||||||
if (this.client == null)
|
if (this.client == null)
|
||||||
this.client = this.buildClient((AuthorizationFilter)null);
|
this.client = this.buildClient((AuthorizationFilter)null);
|
||||||
@@ -53,10 +58,13 @@ public abstract class Client {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* This method retrieves either an anonymous cached instance or builds an
|
||||||
|
* authorized instance of the underlying Jakarta RS 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 Jakarta 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) {
|
if (authFilter == null) {
|
||||||
return this.getClient();
|
return this.getClient();
|
||||||
} else {
|
} else {
|
||||||
@@ -65,15 +73,17 @@ public abstract class Client {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* This method builds a new Jakarta RS client with optional authorization.
|
||||||
|
*
|
||||||
* @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 Jakarta 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();
|
ObjectMapper om = new ObjectMapper();
|
||||||
om.registerModules(new JavaTimeModule());
|
om.registerModules(new JavaTimeModule());
|
||||||
this.getConfig().configureJacksonMapper(om);
|
this.getConfig().configureJacksonMapper(om);
|
||||||
|
|
||||||
JacksonJaxbJsonProvider provider = new JacksonJaxbJsonProvider(om, JacksonJaxbJsonProvider.DEFAULT_ANNOTATIONS);
|
JacksonJsonProvider provider = new JacksonJsonProvider(om, JacksonJsonProvider.BASIC_ANNOTATIONS);
|
||||||
this.getConfig().configureJacksonProvider(provider);
|
this.getConfig().configureJacksonProvider(provider);
|
||||||
|
|
||||||
if (this.getConfig().isWrapRootValueEnabled())
|
if (this.getConfig().isWrapRootValueEnabled())
|
||||||
@@ -101,14 +111,19 @@ public abstract class Client {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param clientBuilder A client builder
|
* This method allows sub-classes to extend the Jakarta RS client builder
|
||||||
|
* before the client is built.
|
||||||
|
*
|
||||||
|
* @param clientBuilder A Jakarta RS 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.
|
* This method builds an anonymous Jakarta RS target.
|
||||||
|
*
|
||||||
|
* @return A pre-configured Jakarta RS target (client w/ base URL) with configured authorization.
|
||||||
*/
|
*/
|
||||||
public final WebTarget getTarget() {
|
public final WebTarget getTarget() {
|
||||||
return this.getClient()
|
return this.getClient()
|
||||||
@@ -116,8 +131,10 @@ public abstract class Client {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* This method builds an authorized Jakarta RS target.
|
||||||
|
*
|
||||||
* @param authFilter A dynamic authorization filter.
|
* @param authFilter A dynamic authorization filter.
|
||||||
* @return A pre-configured JAX-RS target (client w/ base URL) with the specified authorization.
|
* @return A pre-configured Jakarta RS target (client w/ base URL) with the specified authorization.
|
||||||
*/
|
*/
|
||||||
public WebTarget getTarget(AuthorizationFilter authFilter) {
|
public WebTarget getTarget(AuthorizationFilter authFilter) {
|
||||||
if (authFilter == null) {
|
if (authFilter == null) {
|
||||||
@@ -129,10 +146,10 @@ public abstract class Client {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* This method retrieves a JAX-RS implementation of the specified API.
|
* This method retrieves a Jakarta RS implementation of the specified API.
|
||||||
*
|
*
|
||||||
* @param <T> A JAX-RS annotated API class.
|
* @param <T> A Jakarta RS annotated API class.
|
||||||
* @param apiClass A JAX-RS annotated API class.
|
* @param apiClass A Jakarta RS annotated API class.
|
||||||
* @return An instance of the API class.
|
* @return An instance of the API class.
|
||||||
*/
|
*/
|
||||||
public final <T> T getApi(Class<T> apiClass) {
|
public final <T> T getApi(Class<T> apiClass) {
|
||||||
@@ -140,12 +157,12 @@ public abstract class Client {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* This method retrieves a JAX-RS implementation of the specified API with
|
* This method retrieves a Jakarta RS implementation of the specified API with
|
||||||
* the specified authorization.
|
* the specified authorization.
|
||||||
*
|
*
|
||||||
* @param <T> A JAX-RS annotated API class.
|
* @param <T> A Jakarta RS annotated API class.
|
||||||
* @param authFilter A dynamic authorization filter.
|
* @param authFilter A dynamic authorization filter.
|
||||||
* @param apiClass A JAX-RS annotated API class.
|
* @param apiClass A Jakarta RS annotated API class.
|
||||||
* @return An instance of the API class.
|
* @return An instance of the API class.
|
||||||
*/
|
*/
|
||||||
public abstract <T> T getApi(AuthorizationFilter authFilter, Class<T> apiClass);
|
public abstract <T> T getApi(AuthorizationFilter authFilter, Class<T> apiClass);
|
||||||
|
@@ -16,10 +16,10 @@ 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.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
|
* This interface defines the configurable parameters of the clients; primarily
|
||||||
@@ -30,89 +30,127 @@ import com.fasterxml.jackson.jaxrs.json.JacksonJaxbJsonProvider;
|
|||||||
public interface ClientConfiguration {
|
public interface ClientConfiguration {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @return The base or root URL of the service.
|
* This method retrieves the base/root URL of the client service.
|
||||||
|
*
|
||||||
|
* @return The URL.
|
||||||
*/
|
*/
|
||||||
String getBaseUrl();
|
String getBaseUrl();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @return The username for BASIC authentication.
|
* This method retrieves the username to use in HTTP BASIC authentication/authorization.
|
||||||
|
*
|
||||||
|
* @return A username.
|
||||||
*/
|
*/
|
||||||
default String getBasicAuthUsername() {
|
default String getBasicAuthUsername() {
|
||||||
return null;
|
return null;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @return The corresponding password for the username in BASIC authentication.
|
* This method retrieves the password to use in HTTP BASIC authentication/authorization.
|
||||||
|
*
|
||||||
|
* @return The corresponding password for the username.
|
||||||
*/
|
*/
|
||||||
default String getBasicAuthPassword() {
|
default String getBasicAuthPassword() {
|
||||||
return null;
|
return null;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @return The client ID for Client Enforcement authentication.
|
* This method retrieves the client identifier to use in Client Enforcement authorization.
|
||||||
|
*
|
||||||
|
* @return A client identifier.
|
||||||
*/
|
*/
|
||||||
default String getClientId() {
|
default String getClientId() {
|
||||||
return null;
|
return null;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @return The corresponding client secret for the client ID in Client Enforcement authentication.
|
* This method retrieves the client secret to use in Client Enforcement authorization.
|
||||||
|
*
|
||||||
|
* @return The corresponding client secret for the client identifier.
|
||||||
*/
|
*/
|
||||||
default String getClientSecret() {
|
default String getClientSecret() {
|
||||||
return null;
|
return null;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @return The token for BEARER authorization.
|
* This method retrieves the token to use in HTTP BEARER authorization.
|
||||||
|
* This is provided in a response to the token URL.
|
||||||
|
*
|
||||||
|
* @return An access token.
|
||||||
*/
|
*/
|
||||||
default String getBearerToken() {
|
default String getBearerToken() {
|
||||||
return null;
|
return null;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @return The token URL for OAuth authorization.
|
* This method retrieves the token URL to use for OAuth authorization.
|
||||||
|
* The value can be pulled from OAuth endpoint well-known meta-data. That
|
||||||
|
* endpoint or the token URL itself may also be provided OAuth IdP
|
||||||
|
* administrator.
|
||||||
|
*
|
||||||
|
* @return An OAuth token URL.
|
||||||
*/
|
*/
|
||||||
default String getOAuthTokenUrl() {
|
default String getOAuthTokenUrl() {
|
||||||
return null;
|
return null;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @return The client ID provided by the OAuth IdP administrator.
|
* This method retrieves the client identifier to use in OAuth
|
||||||
|
* authorization. This is provided by the OAuth IdP administrator or
|
||||||
|
* tooling.
|
||||||
|
*
|
||||||
|
* @return A client identifier.
|
||||||
*/
|
*/
|
||||||
default String getOAuthClientId() {
|
default String getOAuthClientId() {
|
||||||
return this.getClientId();
|
return this.getClientId();
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @return The corresponding client secret for the client ID provided by the OAuth IdP administrator.
|
* This method retrieves the client secret to use in OAuth authorization.
|
||||||
|
* This is provided by the OAuth IdP administrator or tooling.
|
||||||
|
*
|
||||||
|
* @return The corresponding client secret for the client identifier.
|
||||||
*/
|
*/
|
||||||
default String getOAuthClientSecret() {
|
default String getOAuthClientSecret() {
|
||||||
return this.getClientSecret();
|
return this.getClientSecret();
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @return The authorization code used in the OAuth Authorization Code flow.
|
* This method retrieves the authorization code to use in OAuth
|
||||||
|
* Authorization Code flow. This is provided by the OAuth IdP
|
||||||
|
* administrator or tooling.
|
||||||
|
*
|
||||||
|
* @return An authorization code.
|
||||||
*/
|
*/
|
||||||
default String getOAuthAuthCode() {
|
default String getOAuthAuthCode() {
|
||||||
return null;
|
return null;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @return The redirect URL used in the OAuth Authorization Code flow.
|
* This method retrieves the redirect URL to use in OAuth Authorization
|
||||||
|
* Code flow. This has meaning to the client-side web application.
|
||||||
|
*
|
||||||
|
* @return A URL for the OAuth flow to redirect to when complete.
|
||||||
*/
|
*/
|
||||||
default String getOAuthAuthRedirectUri() {
|
default String getOAuthAuthRedirectUri() {
|
||||||
return null;
|
return null;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @return The username used in the OAuth Password Grant flow.
|
* This method retrieves the username to use in OAuth Password Grant flow.
|
||||||
|
* This is provided by the OAuth IdP administrator or tooling.
|
||||||
|
*
|
||||||
|
* @return A username.
|
||||||
*/
|
*/
|
||||||
default String getOAuthUsername() {
|
default String getOAuthUsername() {
|
||||||
return null;
|
return null;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @return The corresponding password for the username used in the OAuth Password Grant flow.
|
* This method retrieves the password to use in OAuth Password Grant flow.
|
||||||
|
* This is provided by the OAuth IdP administrator or tooling.
|
||||||
|
*
|
||||||
|
* @return The corresponding password for the username.
|
||||||
*/
|
*/
|
||||||
default String getOAuthPassword() {
|
default String getOAuthPassword() {
|
||||||
return null;
|
return null;
|
||||||
@@ -120,10 +158,22 @@ public interface ClientConfiguration {
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This method retrieves the connection (before request sent) timeout for
|
||||||
|
* the client.
|
||||||
|
*
|
||||||
|
* @return A timeout in milliseconds.
|
||||||
|
*/
|
||||||
default Integer getConnectTimeoutInMillis() {
|
default Integer getConnectTimeoutInMillis() {
|
||||||
return null;
|
return null;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This method retrieves the response (after request sent) timeout for the
|
||||||
|
* client.
|
||||||
|
*
|
||||||
|
* @return A timeout in milliseconds.
|
||||||
|
*/
|
||||||
default Integer getResponseTimeoutInMillis() {
|
default Integer getResponseTimeoutInMillis() {
|
||||||
return null;
|
return null;
|
||||||
}
|
}
|
||||||
@@ -131,29 +181,38 @@ public interface ClientConfiguration {
|
|||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @return true to enable Jackson UNWRAP_ROOT_VALUE feature; false otherwise.
|
* This method enables/disables the JackSON UNWRAP_ROOT_VALUE feature.
|
||||||
|
*
|
||||||
|
* @return `true` to enable; `false` otherwise.
|
||||||
*/
|
*/
|
||||||
default boolean isUnwrapRootValueEnabled() {
|
default boolean isUnwrapRootValueEnabled() {
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @return true to enable Jackson WRAP_ROOT_VALUE feature; false otherwise.
|
* This method enables/disables the JackSON WRAP_ROOT_VALUE feature.
|
||||||
|
*
|
||||||
|
* @return `true` to enable; `false` otherwise.
|
||||||
*/
|
*/
|
||||||
default boolean isWrapRootValueEnabled() {
|
default boolean isWrapRootValueEnabled() {
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param mapper A Jackson object mapper to configure.
|
* This method allows sub-classes to extend the JackSON mapper
|
||||||
|
* configuration and behavior.
|
||||||
|
*
|
||||||
|
* @param mapper A JackSON object mapper.
|
||||||
*/
|
*/
|
||||||
default void configureJacksonMapper(ObjectMapper mapper) {
|
default void configureJacksonMapper(ObjectMapper mapper) {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param provider A Jackson JAX-RS provider to configure.
|
* This method allows sub-classes to extend the JackSON JSON provider.
|
||||||
|
*
|
||||||
|
* @param provider A JackSON Jakarta RS provider.
|
||||||
*/
|
*/
|
||||||
default void configureJacksonProvider(JacksonJaxbJsonProvider provider) {
|
default void configureJacksonProvider(JacksonJsonProvider provider) {
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
|
@@ -14,7 +14,9 @@
|
|||||||
*/
|
*/
|
||||||
package com.inteligr8.rs;
|
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
|
* 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.
|
* @param clientSecret A secret corresponding to the client ID.
|
||||||
*/
|
*/
|
||||||
public ClientEnforcementAuthorizationFilter(String clientId, String clientSecret) {
|
public ClientEnforcementAuthorizationFilter(String clientId, String clientSecret) {
|
||||||
this.clientId = clientId;
|
this.clientId = StringUtils.trimToNull(clientId);
|
||||||
this.clientSecret = clientSecret;
|
this.clientSecret = StringUtils.trimToNull(clientSecret);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
@@ -14,21 +14,18 @@
|
|||||||
*/
|
*/
|
||||||
package com.inteligr8.rs;
|
package com.inteligr8.rs;
|
||||||
|
|
||||||
import javax.annotation.PostConstruct;
|
import jakarta.annotation.PostConstruct;
|
||||||
import javax.ws.rs.client.ClientBuilder;
|
import jakarta.ws.rs.client.ClientBuilder;
|
||||||
|
|
||||||
import org.slf4j.Logger;
|
import org.slf4j.Logger;
|
||||||
import org.slf4j.LoggerFactory;
|
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
|
* A class that provides pre-configured Jakarta RS Client & WebTarget
|
||||||
* for Jersey.
|
* objects.
|
||||||
*
|
*
|
||||||
* @author brian@inteligr8.com
|
* @author brian@inteligr8.com
|
||||||
*/
|
*/
|
||||||
@Component("client.jaxrs")
|
|
||||||
public class ClientImpl extends Client {
|
public class ClientImpl extends Client {
|
||||||
|
|
||||||
private final Logger logger = LoggerFactory.getLogger(ClientImpl.class);
|
private final Logger logger = LoggerFactory.getLogger(ClientImpl.class);
|
||||||
@@ -37,44 +34,30 @@ public class ClientImpl extends Client {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* This constructor is for Spring or POJO use.
|
* This constructor is for Spring or POJO use.
|
||||||
|
*
|
||||||
* @param config The client configuration.
|
* @param config The client configuration.
|
||||||
*/
|
*/
|
||||||
@Autowired
|
|
||||||
public ClientImpl(ClientConfiguration config) {
|
public ClientImpl(ClientConfiguration config) {
|
||||||
this.config = config;
|
this.config = config;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* This method registers the Jersey library as the default provider for the
|
* This method is a placeholder.
|
||||||
* JAX-RS specification.
|
|
||||||
*/
|
*/
|
||||||
@PostConstruct
|
@PostConstruct
|
||||||
public void register() {
|
public void register() {
|
||||||
this.logger.info("API Base URL: {}", this.getConfig().getBaseUrl());
|
this.logger.info("API Base URL: {}", this.getConfig().getBaseUrl());
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* @param clientBuilder A client builder.
|
|
||||||
*/
|
|
||||||
@Override
|
@Override
|
||||||
public void buildClient(ClientBuilder clientBuilder) {
|
public void buildClient(ClientBuilder clientBuilder) {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
@Override
|
||||||
* @return The client configuration.
|
|
||||||
*/
|
|
||||||
public ClientConfiguration getConfig() {
|
public ClientConfiguration getConfig() {
|
||||||
return this.config;
|
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
|
@Override
|
||||||
public <T> T getApi(AuthorizationFilter authFilter, Class<T> apiClass) {
|
public <T> T getApi(AuthorizationFilter authFilter, Class<T> apiClass) {
|
||||||
throw new UnsupportedOperationException();
|
throw new UnsupportedOperationException();
|
||||||
|
@@ -14,8 +14,8 @@
|
|||||||
*/
|
*/
|
||||||
package com.inteligr8.rs;
|
package com.inteligr8.rs;
|
||||||
|
|
||||||
import javax.ws.rs.client.ClientRequestContext;
|
import jakarta.ws.rs.client.ClientRequestContext;
|
||||||
import javax.ws.rs.core.HttpHeaders;
|
import jakarta.ws.rs.core.HttpHeaders;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* This class implements a proxied or forwarded authorization header based
|
* This class implements a proxied or forwarded authorization header based
|
||||||
@@ -32,6 +32,8 @@ public class ForwardingAuthorizationFilter implements AuthorizationFilter {
|
|||||||
private final String authorizationHeaderValue;
|
private final String authorizationHeaderValue;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* This constructor instantiates the filter with required fields.
|
||||||
|
*
|
||||||
* @param authorizationHeaderValue A previously used or formulated 'Authorization' header.
|
* @param authorizationHeaderValue A previously used or formulated 'Authorization' header.
|
||||||
*/
|
*/
|
||||||
public ForwardingAuthorizationFilter(String authorizationHeaderValue) {
|
public ForwardingAuthorizationFilter(String authorizationHeaderValue) {
|
||||||
|
@@ -0,0 +1,68 @@
|
|||||||
|
/*
|
||||||
|
* 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.UnsupportedEncodingException;
|
||||||
|
import java.util.List;
|
||||||
|
import java.util.Map.Entry;
|
||||||
|
|
||||||
|
import org.springframework.util.LinkedMultiValueMap;
|
||||||
|
import org.springframework.util.MultiValueMap;
|
||||||
|
|
||||||
|
import jakarta.ws.rs.client.ClientRequestContext;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This class implements a header-based authorization filter.
|
||||||
|
*
|
||||||
|
* @author brian@inteligr8.com
|
||||||
|
*/
|
||||||
|
public class HeaderAuthorizationFilter implements AuthorizationFilter {
|
||||||
|
|
||||||
|
private final MultiValueMap<String, Object> headers = new LinkedMultiValueMap<>();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This constructor instantiates the filter with required fields.
|
||||||
|
*
|
||||||
|
* @param headerName A header name.
|
||||||
|
* @param headerValue A header value.
|
||||||
|
*/
|
||||||
|
public HeaderAuthorizationFilter(String headerName, Object headerValue) {
|
||||||
|
this.headers.add(headerName, headerValue);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This method adds another header name/value to outgoing requests.
|
||||||
|
*
|
||||||
|
* @param headerName A header name.
|
||||||
|
* @param headerValue A header value.
|
||||||
|
* @return This class for fluent chaining.
|
||||||
|
*/
|
||||||
|
public HeaderAuthorizationFilter add(String headerName, Object headerValue) {
|
||||||
|
this.headers.add(headerName, headerValue);
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This method applies the 'Authorization' header to the {@link ClientRequestContext}.
|
||||||
|
*
|
||||||
|
* @param requestContext A request context.
|
||||||
|
*/
|
||||||
|
@Override
|
||||||
|
public void filter(ClientRequestContext requestContext) throws UnsupportedEncodingException {
|
||||||
|
for (Entry<String, List<Object>> header : this.headers.entrySet())
|
||||||
|
requestContext.getHeaders().put(header.getKey(), header.getValue());
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
@@ -16,12 +16,12 @@ package com.inteligr8.rs;
|
|||||||
|
|
||||||
import java.io.IOException;
|
import java.io.IOException;
|
||||||
|
|
||||||
import javax.ws.rs.client.ClientRequestContext;
|
import jakarta.ws.rs.client.ClientRequestContext;
|
||||||
import javax.ws.rs.client.ClientRequestFilter;
|
import jakarta.ws.rs.client.ClientRequestFilter;
|
||||||
import javax.ws.rs.client.ClientResponseContext;
|
import jakarta.ws.rs.client.ClientResponseContext;
|
||||||
import javax.ws.rs.client.ClientResponseFilter;
|
import jakarta.ws.rs.client.ClientResponseFilter;
|
||||||
import javax.ws.rs.core.Form;
|
import jakarta.ws.rs.core.Form;
|
||||||
import javax.ws.rs.core.MediaType;
|
import jakarta.ws.rs.core.MediaType;
|
||||||
|
|
||||||
import org.slf4j.Logger;
|
import org.slf4j.Logger;
|
||||||
import org.slf4j.LoggerFactory;
|
import org.slf4j.LoggerFactory;
|
||||||
|
@@ -16,7 +16,11 @@ package com.inteligr8.rs;
|
|||||||
|
|
||||||
import java.net.URI;
|
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
|
* This class implements the OAuth Authorization Code flow as an authorization
|
||||||
@@ -26,6 +30,8 @@ import javax.ws.rs.core.Form;
|
|||||||
*/
|
*/
|
||||||
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;
|
||||||
|
|
||||||
@@ -68,12 +74,13 @@ 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 = code;
|
this.code = StringUtils.trimToNull(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");
|
||||||
if (this.redirectUri != null)
|
if (this.redirectUri != null)
|
||||||
form.param("redirect_uri", this.redirectUri.toString());
|
form.param("redirect_uri", this.redirectUri.toString());
|
||||||
|
@@ -16,21 +16,22 @@ package com.inteligr8.rs;
|
|||||||
|
|
||||||
import java.util.Map;
|
import java.util.Map;
|
||||||
|
|
||||||
import javax.ws.rs.WebApplicationException;
|
import jakarta.ws.rs.WebApplicationException;
|
||||||
import javax.ws.rs.client.Client;
|
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 javax.ws.rs.core.Response;
|
import jakarta.ws.rs.core.Response;
|
||||||
import javax.ws.rs.core.Response.Status.Family;
|
import jakarta.ws.rs.core.Response.Status.Family;
|
||||||
|
|
||||||
|
import org.apache.commons.lang3.StringUtils;
|
||||||
import org.slf4j.Logger;
|
import org.slf4j.Logger;
|
||||||
import org.slf4j.LoggerFactory;
|
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.
|
* This class is the base for implementations of OAuth authorization flows.
|
||||||
@@ -88,9 +89,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 = clientId;
|
this.clientId = StringUtils.trimToNull(clientId);
|
||||||
this.clientSecret = clientSecret;
|
this.clientSecret = StringUtils.trimToNull(clientSecret);
|
||||||
this.scope = scope;
|
this.scope = StringUtils.trimToNull(scope);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -158,7 +159,7 @@ public abstract class OAuthAuthorizationFilter implements AuthorizationFilter {
|
|||||||
Entity<Form> entity = Entity.form(form);
|
Entity<Form> entity = Entity.form(form);
|
||||||
|
|
||||||
Client client = ClientBuilder.newBuilder()
|
Client client = ClientBuilder.newBuilder()
|
||||||
.register(new JacksonJaxbJsonProvider())
|
.register(new JacksonJsonProvider())
|
||||||
.build();
|
.build();
|
||||||
WebTarget target = client.target(this.tokenUrl);
|
WebTarget target = client.target(this.tokenUrl);
|
||||||
|
|
||||||
|
@@ -14,7 +14,10 @@
|
|||||||
*/
|
*/
|
||||||
package com.inteligr8.rs;
|
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
|
* This class implements the OAuth Client Credential flow as an authorization
|
||||||
@@ -24,6 +27,8 @@ import javax.ws.rs.core.Form;
|
|||||||
*/
|
*/
|
||||||
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.
|
||||||
* @param clientId The ID provided by the OAuth IdP administrator.
|
* @param clientId The ID provided by the OAuth IdP administrator.
|
||||||
@@ -35,6 +40,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");
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@@ -14,7 +14,11 @@
|
|||||||
*/
|
*/
|
||||||
package com.inteligr8.rs;
|
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
|
* This class implements the OAuth Password Grant flow as an authorization
|
||||||
@@ -24,6 +28,8 @@ import javax.ws.rs.core.Form;
|
|||||||
*/
|
*/
|
||||||
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;
|
||||||
|
|
||||||
@@ -46,12 +52,13 @@ 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 = username;
|
this.username = StringUtils.trimToNull(username);
|
||||||
this.password = password;
|
this.password = StringUtils.trimToNull(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);
|
||||||
}
|
}
|
||||||
|
@@ -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