Compare commits

..

14 Commits

21 changed files with 433 additions and 594 deletions

View File

@@ -1,7 +1,7 @@
# Common ReST Client Library
This project provides a library for Spring and POJO-based REST client instantiation. It includes special classes 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
@@ -15,7 +15,8 @@ First, you will need to include the library in your project.
<dependency>
<groupId>com.inteligr8</groupId>
<artifactId>common-rest-client</artifactId>
<version>...-jersey</version>
<classifier>...</classifier>
<version>...</version>
</dependency>
...
</dependencies>
@@ -23,6 +24,8 @@ First, you will need to include the library in your project.
</project>
```
Valid `classifier` values are `cxf` or `jersey`.
### Spring Framework
#### Single Client
@@ -33,27 +36,29 @@ If you will only be declaring a single client in your Spring context, this is ea
@Component
public class ... {
@Autowired
@Qualifier("client.jersey") // may be optional
@Qualifier("client.cxf") // may be optional
private Client client;
}
```
Next, you need to configure that client. You can do that by providing a single implementation of the `ClientConfiguration` (or `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
@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
If you will or may have multiple clients in your Spring context, there is an extra step. You will still need to define a `ClientConfiguration` for each. On top of that, you will need to create specialized implementations of each client. That special implementation will reference the configuration directly. An example is below.
```java
@Component("my.client")
public class MyClient extends ClientJerseyImpl {
public class MyClient extends ClientCxfImpl {
@Autowired
public MyClient(MyClientConfiguration config) {
super(config);
@@ -82,6 +87,6 @@ You do not have to use the Spring framework to use these classes. You can insta
```java
MyClientConfiguration config = new MyClientConfiguration();
...
ClientJerseyImpl client = new ClientJerseyImpl(config);
ClientCxfImpl client = new ClientCxfImpl(config);
MyJaxRsApi api = client.getApi(MyJaxRsApi.class);
```

74
pom.xml
View File

@@ -6,11 +6,11 @@
<groupId>com.inteligr8</groupId>
<artifactId>common-rest-client</artifactId>
<version>3.0.3-jersey</version>
<version>2.0.5-cxf</version>
<packaging>jar</packaging>
<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>
<licenses>
@@ -40,21 +40,16 @@
<properties>
<project.build.sourceEncoding>utf-8</project.build.sourceEncoding>
<maven.compiler.source>11</maven.compiler.source>
<maven.compiler.target>11</maven.compiler.target>
<maven.compiler.source>8</maven.compiler.source>
<maven.compiler.target>8</maven.compiler.target>
<junit.version>5.12.0</junit.version>
<spring.version>6.0.23</spring.version>
<jackson.version>2.17.3</jackson.version>
<jersey.version>3.1.10</jersey.version>
<junit.version>5.7.2</junit.version>
<spring.version>5.3.27</spring.version>
<jackson.version>2.15.1</jackson.version>
<cxf.version>3.5.6</cxf.version>
</properties>
<dependencies>
<dependency>
<groupId>jakarta.annotation</groupId>
<artifactId>jakarta.annotation-api</artifactId>
<version>2.1.1</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-context</artifactId>
@@ -66,8 +61,8 @@
<version>${jackson.version}</version>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.jakarta.rs</groupId>
<artifactId>jackson-jakarta-rs-json-provider</artifactId>
<groupId>com.fasterxml.jackson.jaxrs</groupId>
<artifactId>jackson-jaxrs-json-provider</artifactId>
<version>${jackson.version}</version>
</dependency>
<dependency>
@@ -75,20 +70,15 @@
<artifactId>jackson-datatype-jsr310</artifactId>
<version>${jackson.version}</version>
</dependency>
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-lang3</artifactId>
<version>3.17.0</version>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
<version>2.0.17</version>
<version>1.7.36</version>
</dependency>
<dependency>
<groupId>jakarta.ws.rs</groupId>
<artifactId>jakarta.ws.rs-api</artifactId>
<version>3.1.0</version>
<version>2.1.6</version>
</dependency>
<dependency>
<groupId>org.junit.jupiter</groupId>
@@ -109,33 +99,11 @@
<scope>test</scope>
</dependency>
<!-- Jersey libraries -->
<!-- Apache CXF libraries -->
<dependency>
<groupId>org.glassfish.jersey.ext</groupId>
<artifactId>jersey-proxy-client</artifactId>
<version>${jersey.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>
<groupId>org.apache.cxf</groupId>
<artifactId>cxf-rt-rs-client</artifactId>
<version>${cxf.version}</version>
</dependency>
</dependencies>
@@ -151,7 +119,7 @@
<goals><goal>add-source</goal></goals>
<configuration>
<sources>
<source>src/main/jersey</source>
<source>src/main/cxf</source>
</sources>
</configuration>
</execution>
@@ -160,7 +128,7 @@
<goals><goal>add-test-source</goal></goals>
<configuration>
<sources>
<source>src/test/jersey</source>
<source>src/test/cxf</source>
</sources>
</configuration>
</execution>
@@ -168,7 +136,7 @@
</plugin>
<plugin>
<artifactId>maven-surefire-plugin</artifactId>
<version>3.4.0</version>
<version>3.1.0</version>
<dependencies>
<dependency>
<groupId>org.junit.jupiter</groupId>
@@ -179,7 +147,7 @@
</plugin>
<plugin>
<artifactId>maven-failsafe-plugin</artifactId>
<version>3.4.0</version>
<version>3.1.0</version>
<dependencies>
<dependency>
<groupId>org.junit.jupiter</groupId>
@@ -235,7 +203,7 @@
<plugin>
<groupId>org.sonatype.plugins</groupId>
<artifactId>nexus-staging-maven-plugin</artifactId>
<version>1.6.14</version>
<version>1.6.13</version>
<configuration>
<serverId>ossrh</serverId>
<nexusUrl>https://s01.oss.sonatype.org/</nexusUrl>

View File

@@ -14,22 +14,35 @@
*/
package com.inteligr8.rs;
import org.apache.cxf.jaxrs.client.WebClient;
/**
* This interface defines additional configurations specific to the Jersey
* Jakarta RS library and its nuances.
* This interface defines additional configurations specific to the Apache CXF
* JAX-RS library and its nuances.
*
* @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
* specifications. It requires a body to PUT calls by default.
* Apache CXF uses a global bus configuration where interceptors could
* wreck havoc on your implementation. This method allows you to
* explicitly by-pass the default bus.
*
* @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;
}
/**
* A Jackson provider, logging filter, and authentication filter are already registered.
*
* @param client A CXF client to configure.
*/
default void configureClient(WebClient client) {
}
}

View File

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

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

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

View File

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

View File

@@ -17,10 +17,8 @@ package com.inteligr8.rs;
import java.io.UnsupportedEncodingException;
import java.util.Base64;
import jakarta.ws.rs.client.ClientRequestContext;
import jakarta.ws.rs.core.HttpHeaders;
import org.apache.commons.lang3.StringUtils;
import javax.ws.rs.client.ClientRequestContext;
import javax.ws.rs.core.HttpHeaders;
/**
* This class implements a simple 2-credential (username &amp; password) based
@@ -34,14 +32,12 @@ public class BasicAuthorizationFilter implements AuthorizationFilter {
private final String password;
/**
* This constructor instantiates the filter with required fields.
*
* @param username A username or access key.
* @param password A password or secret key.
*/
public BasicAuthorizationFilter(String username, String password) {
this.username = StringUtils.trimToNull(username);
this.password = StringUtils.trimToNull(password);
this.username = username;
this.password = password;
}
/**

View File

@@ -14,8 +14,8 @@
*/
package com.inteligr8.rs;
import jakarta.ws.rs.client.ClientRequestContext;
import jakarta.ws.rs.core.HttpHeaders;
import javax.ws.rs.client.ClientRequestContext;
import javax.ws.rs.core.HttpHeaders;
/**
* This class implements a simple long living or proxied token-based
@@ -32,8 +32,6 @@ public class BearerTokenAuthorizationFilter implements AuthorizationFilter {
private final String token;
/**
* This constructor instantiates the filter with required fields.
*
* @param token A 'Bearer' token.
*/
public BearerTokenAuthorizationFilter(String token) {

View File

@@ -14,41 +14,34 @@
*/
package com.inteligr8.rs;
import java.util.concurrent.TimeUnit;
import jakarta.ws.rs.client.ClientBuilder;
import jakarta.ws.rs.client.WebTarget;
import javax.ws.rs.client.ClientBuilder;
import javax.ws.rs.client.WebTarget;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.SerializationFeature;
import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule;
import com.fasterxml.jackson.jakarta.rs.json.JacksonJsonProvider;
import com.fasterxml.jackson.jaxrs.json.JacksonJaxbJsonProvider;
/**
* A class that provides pre-configured Jakarta RS Client &amp; WebTarget objects.
* A class that provides pre-configured JAX-RS Client &amp; WebTarget objects.
*
* @author brian@inteligr8.com
*/
public abstract class Client {
private final Object sync = new Object();
private jakarta.ws.rs.client.Client client;
private javax.ws.rs.client.Client client;
/**
* This method retrieves the configuration for the client.
*
* @return The client configuration.
*/
public abstract ClientConfiguration getConfig();
/**
* 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.
* @return A pre-configured JAX-RS client (no URL) with configured authorization.
*/
public final jakarta.ws.rs.client.Client getClient() {
public final javax.ws.rs.client.Client getClient() {
synchronized (this.sync) {
if (this.client == null)
this.client = this.buildClient((AuthorizationFilter)null);
@@ -58,13 +51,10 @@ 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.
* @return A pre-configured Jakarta RS client (no URL) with the specified authorization.
* @return A pre-configured JAX-RS client (no URL) with the specified authorization.
*/
public jakarta.ws.rs.client.Client getClient(AuthorizationFilter authFilter) {
public javax.ws.rs.client.Client getClient(AuthorizationFilter authFilter) {
if (authFilter == null) {
return this.getClient();
} else {
@@ -73,17 +63,18 @@ public abstract class Client {
}
/**
* This method builds a new Jakarta RS client with optional authorization.
*
* @param authFilter A dynamic authorization filter.
* @return A pre-configured Jakarta RS client (no URL) with the specified authorization.
* @return A pre-configured JAX-RS client (no URL) with the specified authorization.
*/
public final jakarta.ws.rs.client.Client buildClient(AuthorizationFilter authFilter) {
public final javax.ws.rs.client.Client buildClient(AuthorizationFilter authFilter) {
ObjectMapper om = new ObjectMapper();
om.registerModules(new JavaTimeModule());
this.getConfig().configureJacksonMapper(om);
JacksonJsonProvider provider = new JacksonJsonProvider(om, JacksonJsonProvider.BASIC_ANNOTATIONS);
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())
@@ -94,36 +85,27 @@ public abstract class Client {
ClientBuilder clientBuilder = ClientBuilder.newBuilder()
.register(provider)
.register(new LoggingFilter());
if (this.getConfig().getConnectTimeoutInMillis() != null)
clientBuilder.connectTimeout(this.getConfig().getConnectTimeoutInMillis(), TimeUnit.MILLISECONDS);
if (this.getConfig().getResponseTimeoutInMillis() != null)
clientBuilder.readTimeout(this.getConfig().getResponseTimeoutInMillis(), TimeUnit.MILLISECONDS);
if (authFilter == null)
authFilter = this.getConfig().createAuthorizationFilter();
if (authFilter != null)
clientBuilder.register(authFilter);
this.buildClient(clientBuilder);
this.getConfig().configureClient(clientBuilder);
return clientBuilder.build();
}
/**
* This method allows sub-classes to extend the Jakarta RS client builder
* before the client is built.
*
* @param clientBuilder A Jakarta RS client builder.
* @param clientBuilder A client builder
*/
public void buildClient(ClientBuilder clientBuilder) {
// for extension purposes
}
/**
* This method builds an anonymous Jakarta RS target.
*
* @return A pre-configured Jakarta RS target (client w/ base URL) with configured authorization.
* @return A pre-configured JAX-RS target (client w/ base URL) with configured authorization.
*/
public final WebTarget getTarget() {
return this.getClient()
@@ -131,10 +113,8 @@ public abstract class Client {
}
/**
* This method builds an authorized Jakarta RS target.
*
* @param authFilter A dynamic authorization filter.
* @return A pre-configured Jakarta RS target (client w/ base URL) with the specified authorization.
* @return A pre-configured JAX-RS target (client w/ base URL) with the specified authorization.
*/
public WebTarget getTarget(AuthorizationFilter authFilter) {
if (authFilter == null) {
@@ -146,10 +126,10 @@ public abstract class Client {
}
/**
* This method retrieves a Jakarta RS implementation of the specified API.
* This method retrieves a JAX-RS implementation of the specified API.
*
* @param <T> A Jakarta RS annotated API class.
* @param apiClass A Jakarta RS annotated API class.
* @param <T> A JAX-RS annotated API class.
* @param apiClass A JAX-RS annotated API class.
* @return An instance of the API class.
*/
public final <T> T getApi(Class<T> apiClass) {
@@ -157,12 +137,12 @@ public abstract class Client {
}
/**
* This method retrieves a Jakarta RS implementation of the specified API with
* This method retrieves a JAX-RS implementation of the specified API with
* the specified authorization.
*
* @param <T> A Jakarta RS annotated API class.
* @param <T> A JAX-RS annotated API class.
* @param authFilter A dynamic authorization filter.
* @param apiClass A Jakarta RS annotated API class.
* @param apiClass A JAX-RS annotated API class.
* @return An instance of the API class.
*/
public abstract <T> T getApi(AuthorizationFilter authFilter, Class<T> apiClass);

View File

@@ -16,10 +16,10 @@ package com.inteligr8.rs;
import java.net.URI;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.jakarta.rs.json.JacksonJsonProvider;
import javax.ws.rs.client.ClientBuilder;
import jakarta.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
@@ -30,189 +30,120 @@ import jakarta.ws.rs.client.ClientBuilder;
public interface ClientConfiguration {
/**
* This method retrieves the base/root URL of the client service.
*
* @return The URL.
* @return The base or root URL of the service.
*/
String getBaseUrl();
/**
* This method retrieves the username to use in HTTP BASIC authentication/authorization.
*
* @return A username.
* @return The username for BASIC authentication.
*/
default String getBasicAuthUsername() {
return null;
}
/**
* This method retrieves the password to use in HTTP BASIC authentication/authorization.
*
* @return The corresponding password for the username.
* @return The corresponding password for the username in BASIC authentication.
*/
default String getBasicAuthPassword() {
return null;
}
/**
* This method retrieves the client identifier to use in Client Enforcement authorization.
*
* @return A client identifier.
* @return The client ID for Client Enforcement authentication.
*/
default String getClientId() {
return null;
}
/**
* This method retrieves the client secret to use in Client Enforcement authorization.
*
* @return The corresponding client secret for the client identifier.
* @return The corresponding client secret for the client ID in Client Enforcement authentication.
*/
default String getClientSecret() {
return null;
}
/**
* 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.
* @return The token for BEARER authorization.
*/
default String getBearerToken() {
return null;
}
/**
* 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.
* @return The token URL for OAuth authorization.
*/
default String getOAuthTokenUrl() {
return null;
}
/**
* 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.
* @return The client ID provided by the OAuth IdP administrator.
*/
default String getOAuthClientId() {
return this.getClientId();
}
/**
* 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.
* @return The corresponding client secret for the client ID provided by the OAuth IdP administrator.
*/
default String getOAuthClientSecret() {
return this.getClientSecret();
}
/**
* 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.
* @return The authorization code used in the OAuth Authorization Code flow.
*/
default String getOAuthAuthCode() {
return null;
}
/**
* 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.
* @return The redirect URL used in the OAuth Authorization Code flow.
*/
default String getOAuthAuthRedirectUri() {
return null;
}
/**
* 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.
* @return The username used in the OAuth Password Grant flow.
*/
default String getOAuthUsername() {
return null;
}
/**
* 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.
* @return The corresponding password for the username used in the OAuth Password Grant flow.
*/
default String getOAuthPassword() {
return null;
}
/**
* This method retrieves the connection (before request sent) timeout for
* the client.
*
* @return A timeout in milliseconds.
*/
default Integer getConnectTimeoutInMillis() {
return null;
}
/**
* This method retrieves the response (after request sent) timeout for the
* client.
*
* @return A timeout in milliseconds.
*/
default Integer getResponseTimeoutInMillis() {
return null;
}
/**
* This method enables/disables the JackSON UNWRAP_ROOT_VALUE feature.
*
* @return `true` to enable; `false` otherwise.
* @return true to enable Jackson UNWRAP_ROOT_VALUE feature; false otherwise.
*/
default boolean isUnwrapRootValueEnabled() {
return false;
}
/**
* This method enables/disables the JackSON WRAP_ROOT_VALUE feature.
*
* @return `true` to enable; `false` otherwise.
* @return true to enable Jackson WRAP_ROOT_VALUE feature; false otherwise.
*/
default boolean isWrapRootValueEnabled() {
return false;
}
/**
* This method allows sub-classes to extend the JackSON mapper
* configuration and behavior.
*
* @param mapper A JackSON object mapper.
* @param mapper A Jackson object mapper to configure.
*/
default void configureJacksonMapper(ObjectMapper mapper) {
}
/**
* This method allows sub-classes to extend the JackSON JSON provider.
*
* @param provider A JackSON Jakarta RS provider.
* @param provider A Jackson JAX-RS provider to configure.
*/
default void configureJacksonProvider(JacksonJsonProvider provider) {
default void configureJacksonProvider(JacksonJaxbJsonProvider provider) {
}

View File

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

View File

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

View File

@@ -14,8 +14,8 @@
*/
package com.inteligr8.rs;
import jakarta.ws.rs.client.ClientRequestContext;
import jakarta.ws.rs.core.HttpHeaders;
import javax.ws.rs.client.ClientRequestContext;
import javax.ws.rs.core.HttpHeaders;
/**
* This class implements a proxied or forwarded authorization header based
@@ -32,8 +32,6 @@ public class ForwardingAuthorizationFilter implements AuthorizationFilter {
private final String authorizationHeaderValue;
/**
* This constructor instantiates the filter with required fields.
*
* @param authorizationHeaderValue A previously used or formulated 'Authorization' header.
*/
public ForwardingAuthorizationFilter(String authorizationHeaderValue) {

View File

@@ -1,68 +0,0 @@
/*
* This program is free software: you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or (at your
* option) any later version.
*
* This program is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
* more details.
*
* You should have received a copy of the GNU General Public License along
* with this program. If not, see <https://www.gnu.org/licenses/>.
*/
package com.inteligr8.rs;
import java.io.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());
}
}

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@@ -1,101 +0,0 @@
/*
* This program is free software: you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or (at your
* option) any later version.
*
* This program is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
* more details.
*
* You should have received a copy of the GNU General Public License along
* with this program. If not, see <https://www.gnu.org/licenses/>.
*/
package com.inteligr8.rs;
import jakarta.annotation.PostConstruct;
import jakarta.ws.rs.client.ClientBuilder;
import jakarta.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;
/**
* A class that provides pre-configured JAX-RS Client &amp; WebTarget objects
* for Jersey.
*
* @author brian@inteligr8.com
*/
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.
*/
public ClientJerseyImpl(ClientJerseyConfiguration config) {
this.config = config;
}
/**
* This method registers the Jersey library as the default provider for the
* Jakarta RS specification.
*/
@PostConstruct
public void register() {
if (RuntimeDelegate.getInstance() == null) {
this.logger.info("Setting Jakarta RS runtime delegate to the Jersey library");
RuntimeDelegate.setInstance(new RuntimeDelegateImpl());
} else if (RuntimeDelegate.getInstance() instanceof RuntimeDelegateImpl) {
this.logger.info("Jakarta RS runtime delegate already the Jersey library");
} else {
this.logger.warn("Setting Jakarta 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 Jakarta RS implementation of the specified API
* with the specified authorization.
*
* @param authFilter A dynamic authorization filter.
* @param apiClass A Jakarta 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));
}
}