Compare commits

..

32 Commits

Author SHA1 Message Date
63b48b8cbf Merge branch 'develop-jersey' into stable-jersey 2024-08-15 12:04:51 -04:00
3f34ddb59d v3.x; jersey v3.x 2024-08-15 11:51:22 -04:00
009bf7bb87 v2.0.10-jersey pom 2024-03-05 18:53:01 -05:00
b7c8e4479a Merge branch 'develop-jersey' into stable-jersey 2024-03-05 18:52:40 -05:00
255d64728e Merge branch 'develop' into develop-jersey 2024-03-05 18:47:23 -05:00
c61f2ca107 removing spring annotations to support multiple clients 2024-03-05 18:45:46 -05:00
1b2fbe5413 v2.0.9-jersey pom 2024-01-23 10:45:42 -05:00
80990f5335 Merge branch 'develop-jersey' into stable-jersey 2024-01-23 10:45:25 -05:00
f1852afe4e Merge branch 'develop' into develop-jersey 2024-01-23 10:43:58 -05:00
a8d2740329 v2.0.8-jersey pom 2023-06-29 10:56:57 -04:00
1f50bb8d3f Merge branch 'develop-jersey' into stable-jersey 2023-06-29 10:56:38 -04:00
d386f35258 Merge branch 'develop' into develop-jersey 2023-06-29 10:31:57 -04:00
7c98ce5545 v2.0.7-jersey pom 2023-06-12 17:19:39 -04:00
4c7e9da980 Merge branch 'develop-jersey' into stable-jersey 2023-06-12 17:19:21 -04:00
bb20a78224 Merge branch 'develop' into develop-jersey 2023-06-12 17:16:14 -04:00
518be99d4e v2.0.6-jersey pom 2023-06-12 16:14:51 -04:00
2dd7de15a3 Merge branch 'develop-jersey' into stable-jersey 2023-06-12 16:14:16 -04:00
053b7a36ff removing javax.annotation conflict 2023-06-12 16:08:32 -04:00
fa96a8cfb8 Merge branch 'develop' into develop-jersey 2023-06-12 16:07:35 -04:00
a4a1b3a9e6 v2.0.4-jersey 2023-05-30 18:02:43 -04:00
9e3c749f9b Merge branch 'develop-jersey' into stable-jersey 2023-05-30 18:02:14 -04:00
2cbb08e9cc Merge branch 'develop' into develop-jersey 2023-05-30 17:58:54 -04:00
6844044395 Merge branch 'develop' into develop-jersey 2023-05-30 17:54:44 -04:00
722a04fe16 v2.0.3-jersey 2023-05-30 12:45:35 -04:00
1e5fcf6ab8 Merge branch 'develop-jersey' into stable-jersey 2023-05-30 12:45:13 -04:00
efcfab1795 Merge branch 'develop' into develop-jersey 2023-05-30 12:44:04 -04:00
5c242d88f1 v2.0.2-jersey pom 2023-05-29 10:17:17 -04:00
e56152c47b Merge branch 'develop-jersey' into stable-jersey 2023-05-29 10:16:34 -04:00
eb843c3cb6 upgraded jersey version 2023-05-29 10:07:46 -04:00
56aca63307 Merge branch 'develop' into develop-jersey 2023-05-29 09:58:48 -04:00
22ab063d4e Merge branch 'develop-jersey' into stable-jersey 2022-10-02 17:58:08 -04:00
df402790b4 added Jersey impl 2022-10-02 17:50:48 -04:00
11 changed files with 313 additions and 198 deletions

View File

@@ -1,7 +1,7 @@
# Common ReST Client Library # Common ReST Client Library
This project provides a library for Spring and POJO-based REST client instantiation. This project provides a library for Spring and POJO-based REST client instantiation. It includes special classes for the Jersey JAXRS-based client frameworks.
## Usage ## Usage
@@ -15,7 +15,7 @@ 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>...</version> <version>...-jersey</version>
</dependency> </dependency>
... ...
</dependencies> </dependencies>
@@ -23,4 +23,65 @@ First, you will need to include the library in your project.
</project> </project>
``` ```
See the `cxf` and `jersey` branches for examples and more documentation. ### Spring Framework
#### Single Client
If you will only be declaring a single client in your Spring context, this is easy. You will just need two things. First, inject the single client into any of your Spring beans. You may do inject it into more than one. An example is below:
```java
@Component
public class ... {
@Autowired
@Qualifier("client.jersey") // 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.
```java
@Configuration
public class ... implements ClientJerseyConfiguration {
...
}
```
#### 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 {
@Autowired
public MyClient(MyClientConfiguration config) {
super(config);
}
}
```
You can then inject your client(s) into your Spring beans. Like the example below:
```java
@Component
public class ... {
@Autowired
private MyClient client;
@PostConstruct
public void init() {
MyJaxRsApi api = this.client.getApi(MyJaxRsApi.class);
}
}
### POJO
You do not have to use the Spring framework to use these classes. You can instantiate them directly. But you wil still need to create a `ClientConfiguration` as mentioned above.
```java
MyClientConfiguration config = new MyClientConfiguration();
...
ClientJerseyImpl client = new ClientJerseyImpl(config);
MyJaxRsApi api = client.getApi(MyJaxRsApi.class);
```

75
pom.xml
View File

@@ -6,11 +6,11 @@
<groupId>com.inteligr8</groupId> <groupId>com.inteligr8</groupId>
<artifactId>common-rest-client</artifactId> <artifactId>common-rest-client</artifactId>
<version>3.0.3</version> <version>3.0.0-jersey</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 REST API clients</description> <description>A common library for building Jersey REST API clients</description>
<url>https://bitbucket.org/inteligr8/common-rest-client</url> <url>https://bitbucket.org/inteligr8/common-rest-client</url>
<licenses> <licenses>
@@ -43,9 +43,10 @@
<maven.compiler.source>11</maven.compiler.source> <maven.compiler.source>11</maven.compiler.source>
<maven.compiler.target>11</maven.compiler.target> <maven.compiler.target>11</maven.compiler.target>
<junit.version>5.12.0</junit.version> <junit.version>5.10.0</junit.version>
<spring.version>6.0.23</spring.version> <spring.version>6.0.19</spring.version>
<jackson.version>2.17.3</jackson.version> <jackson.version>2.17.2</jackson.version>
<jersey.version>3.1.8</jersey.version>
</properties> </properties>
<dependencies> <dependencies>
@@ -77,12 +78,12 @@
<dependency> <dependency>
<groupId>org.apache.commons</groupId> <groupId>org.apache.commons</groupId>
<artifactId>commons-lang3</artifactId> <artifactId>commons-lang3</artifactId>
<version>3.17.0</version> <version>3.14.0</version>
</dependency> </dependency>
<dependency> <dependency>
<groupId>org.slf4j</groupId> <groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId> <artifactId>slf4j-api</artifactId>
<version>2.0.17</version> <version>2.0.13</version>
</dependency> </dependency>
<dependency> <dependency>
<groupId>jakarta.ws.rs</groupId> <groupId>jakarta.ws.rs</groupId>
@@ -107,13 +108,67 @@
<version>4.5.14</version> <version>4.5.14</version>
<scope>test</scope> <scope>test</scope>
</dependency> </dependency>
<!-- Jersey 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>
</dependency>
</dependencies> </dependencies>
<build> <build>
<plugins> <plugins>
<plugin> <plugin>
<artifactId>maven-surefire-plugin</artifactId> <groupId>org.codehaus.mojo</groupId>
<artifactId>build-helper-maven-plugin</artifactId>
<version>3.4.0</version> <version>3.4.0</version>
<executions>
<execution>
<id>add-jaxrs-src</id>
<goals><goal>add-source</goal></goals>
<configuration>
<sources>
<source>src/main/jersey</source>
</sources>
</configuration>
</execution>
<execution>
<id>add-test-src</id>
<goals><goal>add-test-source</goal></goals>
<configuration>
<sources>
<source>src/test/jersey</source>
</sources>
</configuration>
</execution>
</executions>
</plugin>
<plugin>
<artifactId>maven-surefire-plugin</artifactId>
<version>3.1.0</version>
<dependencies> <dependencies>
<dependency> <dependency>
<groupId>org.junit.jupiter</groupId> <groupId>org.junit.jupiter</groupId>
@@ -124,7 +179,7 @@
</plugin> </plugin>
<plugin> <plugin>
<artifactId>maven-failsafe-plugin</artifactId> <artifactId>maven-failsafe-plugin</artifactId>
<version>3.4.0</version> <version>3.1.0</version>
<dependencies> <dependencies>
<dependency> <dependency>
<groupId>org.junit.jupiter</groupId> <groupId>org.junit.jupiter</groupId>
@@ -180,7 +235,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.14</version> <version>1.6.13</version>
<configuration> <configuration>
<serverId>ossrh</serverId> <serverId>ossrh</serverId>
<nexusUrl>https://s01.oss.sonatype.org/</nexusUrl> <nexusUrl>https://s01.oss.sonatype.org/</nexusUrl>

View File

@@ -34,8 +34,6 @@ 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.
*/ */

View File

@@ -32,8 +32,6 @@ 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) {

View File

@@ -26,7 +26,7 @@ import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule;
import com.fasterxml.jackson.jakarta.rs.json.JacksonJsonProvider; import com.fasterxml.jackson.jakarta.rs.json.JacksonJsonProvider;
/** /**
* 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 * @author brian@inteligr8.com
*/ */
@@ -36,17 +36,12 @@ public abstract class Client {
private jakarta.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();
/** /**
* This method retrieves an anonymous cached instance of the underlying * @return A pre-configured JAX-RS client (no URL) with configured authorization.
* Jakarta RS client.
*
* @return A pre-configured Jakarta RS client (no URL) with configured authorization.
*/ */
public final jakarta.ws.rs.client.Client getClient() { public final jakarta.ws.rs.client.Client getClient() {
synchronized (this.sync) { synchronized (this.sync) {
@@ -58,11 +53,8 @@ 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 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 jakarta.ws.rs.client.Client getClient(AuthorizationFilter authFilter) {
if (authFilter == null) { if (authFilter == null) {
@@ -73,10 +65,8 @@ 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 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 jakarta.ws.rs.client.Client buildClient(AuthorizationFilter authFilter) {
ObjectMapper om = new ObjectMapper(); ObjectMapper om = new ObjectMapper();
@@ -111,19 +101,14 @@ public abstract class Client {
} }
/** /**
* This method allows sub-classes to extend the Jakarta RS client builder * @param clientBuilder A 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
} }
/** /**
* This method builds an anonymous Jakarta RS target. * @return A pre-configured JAX-RS target (client w/ base URL) with configured authorization.
*
* @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()
@@ -131,10 +116,8 @@ 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 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) { public WebTarget getTarget(AuthorizationFilter authFilter) {
if (authFilter == null) { if (authFilter == null) {
@@ -146,10 +129,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 <T> A JAX-RS annotated API class.
* @param apiClass A Jakarta RS annotated API class. * @param apiClass A JAX-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) {
@@ -157,12 +140,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. * 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 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. * @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);

View File

@@ -30,127 +30,89 @@ import jakarta.ws.rs.client.ClientBuilder;
public interface ClientConfiguration { public interface ClientConfiguration {
/** /**
* This method retrieves the base/root URL of the client service. * @return The base or root URL of the service.
*
* @return The URL.
*/ */
String getBaseUrl(); String getBaseUrl();
/** /**
* This method retrieves the username to use in HTTP BASIC authentication/authorization. * @return The username for BASIC authentication.
*
* @return A username.
*/ */
default String getBasicAuthUsername() { default String getBasicAuthUsername() {
return null; return null;
} }
/** /**
* This method retrieves the password to use in HTTP BASIC authentication/authorization. * @return The corresponding password for the username in BASIC authentication.
*
* @return The corresponding password for the username.
*/ */
default String getBasicAuthPassword() { default String getBasicAuthPassword() {
return null; return null;
} }
/** /**
* This method retrieves the client identifier to use in Client Enforcement authorization. * @return The client ID for Client Enforcement authentication.
*
* @return A client identifier.
*/ */
default String getClientId() { default String getClientId() {
return null; return null;
} }
/** /**
* This method retrieves the client secret to use in Client Enforcement authorization. * @return The corresponding client secret for the client ID in Client Enforcement authentication.
*
* @return The corresponding client secret for the client identifier.
*/ */
default String getClientSecret() { default String getClientSecret() {
return null; return null;
} }
/** /**
* This method retrieves the token to use in HTTP BEARER authorization. * @return The token for 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;
} }
/** /**
* This method retrieves the token URL to use for OAuth authorization. * @return The token URL 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;
} }
/** /**
* This method retrieves the client identifier to use in OAuth * @return The client ID provided by the OAuth IdP administrator.
* 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();
} }
/** /**
* This method retrieves the client secret to use in OAuth authorization. * @return The corresponding client secret for the client ID provided by the OAuth IdP administrator.
* 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();
} }
/** /**
* This method retrieves the authorization code to use in OAuth * @return The authorization code used in the OAuth Authorization Code flow.
* 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;
} }
/** /**
* This method retrieves the redirect URL to use in OAuth Authorization * @return The redirect URL used in the OAuth Authorization Code flow.
* 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;
} }
/** /**
* This method retrieves the username to use in OAuth Password Grant flow. * @return The username used in the 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;
} }
/** /**
* This method retrieves the password to use in OAuth Password Grant flow. * @return The corresponding password for the username used in the 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;
@@ -158,22 +120,10 @@ 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;
} }
@@ -181,36 +131,27 @@ public interface ClientConfiguration {
/** /**
* This method enables/disables the JackSON UNWRAP_ROOT_VALUE feature. * @return true to enable Jackson UNWRAP_ROOT_VALUE feature; false otherwise.
*
* @return `true` to enable; `false` otherwise.
*/ */
default boolean isUnwrapRootValueEnabled() { default boolean isUnwrapRootValueEnabled() {
return false; return false;
} }
/** /**
* This method enables/disables the JackSON WRAP_ROOT_VALUE feature. * @return true to enable Jackson WRAP_ROOT_VALUE feature; false otherwise.
*
* @return `true` to enable; `false` otherwise.
*/ */
default boolean isWrapRootValueEnabled() { default boolean isWrapRootValueEnabled() {
return false; return false;
} }
/** /**
* This method allows sub-classes to extend the JackSON mapper * @param mapper A Jackson object mapper to configure.
* configuration and behavior.
*
* @param mapper A JackSON object mapper.
*/ */
default void configureJacksonMapper(ObjectMapper mapper) { default void configureJacksonMapper(ObjectMapper mapper) {
} }
/** /**
* This method allows sub-classes to extend the JackSON JSON provider. * @param provider A Jackson Jakarta RS provider to configure.
*
* @param provider A JackSON Jakarta RS provider.
*/ */
default void configureJacksonProvider(JacksonJsonProvider provider) { default void configureJacksonProvider(JacksonJsonProvider provider) {
} }

View File

@@ -21,8 +21,8 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory; import org.slf4j.LoggerFactory;
/** /**
* A class that provides pre-configured Jakarta RS Client &amp; WebTarget * A class that provides pre-configured JAX-RS Client &amp; WebTarget objects
* objects. * for Jersey.
* *
* @author brian@inteligr8.com * @author brian@inteligr8.com
*/ */
@@ -34,7 +34,6 @@ 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.
*/ */
public ClientImpl(ClientConfiguration config) { public ClientImpl(ClientConfiguration config) {
@@ -42,22 +41,36 @@ public class ClientImpl extends Client {
} }
/** /**
* This method is a placeholder. * This method registers the Jersey library as the default provider for the
* 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();

View File

@@ -32,8 +32,6 @@ 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) {

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

@@ -0,0 +1,35 @@
/*
* 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;
/**
* This interface defines additional configurations specific to the Jersey
* JAX-RS library and its nuances.
*
* @author brian@inteligr8.com
*/
public interface ClientJerseyConfiguration extends ClientConfiguration {
/**
* Jersey is automatically strict in its adherence to the ReST API
* specifications. It requires a body to PUT calls by default.
*
* @return true to require body in PUT calls; false to make it optional
*/
default boolean isPutBodyRequired() {
return true;
}
}

View File

@@ -0,0 +1,101 @@
/*
* 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
* 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));
}
}