Compare commits

...

58 Commits

Author SHA1 Message Date
637898120a v3.0.3-cxf pom 2025-03-03 09:15:04 -05:00
7f7d7a9004 Merge branch 'stable' into stable-cxf 2025-03-03 09:14:33 -05:00
0820dd7a7c Merge branch 'develop-cxf' into stable-cxf 2025-03-03 09:14:03 -05:00
65eedab7e6 v3.0.3 pom 2025-03-03 09:08:09 -05:00
4d3af40911 Merge branch 'develop' into stable 2025-03-03 09:07:50 -05:00
06b4171141 Merge branch 'develop' into develop-cxf 2025-03-03 09:07:29 -05:00
4353c673db fix HeaderAuthorizationFilter multimap usage 2025-03-03 09:07:15 -05:00
66454c36ef Merge branch 'stable' into stable-cxf 2025-02-28 11:14:34 -05:00
c1621491c8 Merge branch 'develop-cxf' into stable-cxf 2025-02-28 11:12:55 -05:00
eb2bd96ced v3.0.2 pom 2025-02-28 11:12:23 -05:00
c2147e1461 Merge branch 'develop' into stable 2025-02-28 11:12:03 -05:00
4ac69a15cf cxf v4.0.6 2025-02-28 11:11:39 -05:00
8fb4527b90 Merge branch 'develop' into develop-cxf 2025-02-28 11:11:01 -05:00
52cffffa8e upgrade maven plugins 2025-02-28 11:10:17 -05:00
e9bc191945 updated javadocs 2025-02-28 11:07:55 -05:00
d5ef510aeb v3.0.2-cxf pom 2025-02-28 10:25:25 -05:00
24fbe5f5ed Merge branch 'stable' into stable-cxf 2025-02-28 10:25:03 -05:00
6c58263903 v3.0.2 pom 2025-02-28 10:24:22 -05:00
e015ec5a1e Merge branch 'develop' into stable 2025-02-28 10:24:02 -05:00
795c9fef44 added header-based auth filter 2025-02-28 10:21:57 -05:00
e1b3fd9b92 v3.0.1-cxf 2024-10-24 11:18:18 -04:00
b2efbc3f5f Merge branch 'develop-cxf' into stable-cxf 2024-10-24 11:17:46 -04:00
d46d258a65 cxf v4.0.5 2024-10-24 11:17:23 -04:00
f5998ebde6 fix request logging 2024-10-24 11:13:21 -04:00
6b79be8e41 Merge branch 'develop-cxf' into stable-cxf 2024-08-15 11:57:57 -04:00
eb7ac34f5e Merge branch 'develop' into stable 2024-08-15 11:52:02 -04:00
964a55fcc8 cxf v4.x 2024-08-15 11:47:55 -04:00
b7ac0d25c9 v3.x; upgrade to jakarta 2024-08-15 11:44:12 -04:00
5e3e9080a9 v2.0.10-cxf pom 2024-03-05 18:51:25 -05:00
dfb039dc17 Merge branch 'develop-cxf' into stable-cxf 2024-03-05 18:50:39 -05:00
271016dcf9 v2.0.10 pom 2024-03-05 18:49:07 -05:00
00ec8c972d Merge branch 'develop' into stable 2024-03-05 18:47:56 -05:00
bedc424ab5 Merge branch 'develop' into develop-cxf 2024-03-05 18:47:18 -05:00
b4d6c1c72c removing spring annotations to support multiple clients 2024-03-05 18:46:43 -05:00
2cd9cc9484 removing spring annotations to support multiple clients 2024-03-05 18:46:07 -05:00
618d008a37 v2.0.9-cxf pom 2024-01-23 10:45:04 -05:00
303af956cb Merge branch 'develop-cxf' into stable-cxf 2024-01-23 10:44:43 -05:00
ec4ffbee43 Merge branch 'develop' into develop-cxf 2024-01-23 10:43:46 -05:00
d4cd2f248c v2.0.9 pom 2024-01-23 10:42:51 -05:00
ac6f82a7f4 Merge branch 'develop' into stable 2024-01-23 10:41:11 -05:00
eb654c5488 added logging and param trimming 2024-01-23 10:40:37 -05:00
8c9cbecd53 v2.0.8-cxf pom 2023-06-29 10:59:37 -04:00
81198de0fb Merge branch 'develop-cxf' into stable-cxf 2023-06-29 10:59:15 -04:00
0258cfcb9a v2.0.8 pom 2023-06-29 10:46:39 -04:00
6fc43b85f7 Merge branch 'develop' into stable 2023-06-29 10:46:11 -04:00
803d49e53e added CXF-specific configurable connect/received timeout 2023-06-29 10:45:55 -04:00
adad70d884 Merge branch 'develop' into develop-cxf 2023-06-29 10:32:16 -04:00
d29ccbef79 added connect/read timeout configurability 2023-06-29 10:31:42 -04:00
512f118354 v2.0.7 pom 2023-06-12 17:23:23 -04:00
21255bfb3d Merge branch 'develop' into stable 2023-06-12 17:16:33 -04:00
f10fd39e97 v2.0.6 pom 2023-06-12 16:10:25 -04:00
eaed628f00 Merge branch 'develop' into stable 2023-06-12 16:08:46 -04:00
cd278bcc81 v2.0.4 pom 2023-05-30 18:00:33 -04:00
b64c408029 Merge branch 'develop' into stable 2023-05-30 18:00:06 -04:00
ec6e7cc15d v2.0.3 pom 2023-05-30 12:44:41 -04:00
2451c634b7 Merge branch 'develop' into stable 2023-05-30 12:44:21 -04:00
ed00346e71 v2.0.2 pom 2023-05-29 10:15:38 -04:00
c001576b65 Merge branch 'develop' into stable 2023-05-29 10:11:16 -04:00
18 changed files with 329 additions and 133 deletions

38
pom.xml
View File

@@ -6,7 +6,7 @@
<groupId>com.inteligr8</groupId>
<artifactId>common-rest-client</artifactId>
<version>2.0.7-cxf</version>
<version>3.0.3-cxf</version>
<packaging>jar</packaging>
<name>ReST API Client for Java</name>
@@ -40,16 +40,21 @@
<properties>
<project.build.sourceEncoding>utf-8</project.build.sourceEncoding>
<maven.compiler.source>8</maven.compiler.source>
<maven.compiler.target>8</maven.compiler.target>
<maven.compiler.source>11</maven.compiler.source>
<maven.compiler.target>11</maven.compiler.target>
<junit.version>5.7.2</junit.version>
<spring.version>5.3.27</spring.version>
<jackson.version>2.15.1</jackson.version>
<cxf.version>3.5.6</cxf.version>
<junit.version>5.12.0</junit.version>
<spring.version>6.0.23</spring.version>
<jackson.version>2.17.3</jackson.version>
<cxf.version>4.0.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>
@@ -61,8 +66,8 @@
<version>${jackson.version}</version>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.jaxrs</groupId>
<artifactId>jackson-jaxrs-json-provider</artifactId>
<groupId>com.fasterxml.jackson.jakarta.rs</groupId>
<artifactId>jackson-jakarta-rs-json-provider</artifactId>
<version>${jackson.version}</version>
</dependency>
<dependency>
@@ -70,15 +75,20 @@
<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>1.7.36</version>
<version>2.0.17</version>
</dependency>
<dependency>
<groupId>jakarta.ws.rs</groupId>
<artifactId>jakarta.ws.rs-api</artifactId>
<version>2.1.6</version>
<version>3.1.0</version>
</dependency>
<dependency>
<groupId>org.junit.jupiter</groupId>
@@ -136,7 +146,7 @@
</plugin>
<plugin>
<artifactId>maven-surefire-plugin</artifactId>
<version>3.1.0</version>
<version>3.4.0</version>
<dependencies>
<dependency>
<groupId>org.junit.jupiter</groupId>
@@ -147,7 +157,7 @@
</plugin>
<plugin>
<artifactId>maven-failsafe-plugin</artifactId>
<version>3.1.0</version>
<version>3.4.0</version>
<dependencies>
<dependency>
<groupId>org.junit.jupiter</groupId>
@@ -203,7 +213,7 @@
<plugin>
<groupId>org.sonatype.plugins</groupId>
<artifactId>nexus-staging-maven-plugin</artifactId>
<version>1.6.13</version>
<version>1.6.14</version>
<configuration>
<serverId>ossrh</serverId>
<nexusUrl>https://s01.oss.sonatype.org/</nexusUrl>

View File

@@ -17,21 +17,21 @@ package com.inteligr8.rs;
import java.util.LinkedList;
import java.util.List;
import javax.annotation.PostConstruct;
import javax.ws.rs.ext.RuntimeDelegate;
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 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;
import com.fasterxml.jackson.jakarta.rs.json.JacksonJsonProvider;
/**
* A class that provides pre-configured JAX-RS Client &amp; WebTarget &amp;
@@ -39,7 +39,6 @@ import com.fasterxml.jackson.jaxrs.json.JacksonJaxbJsonProvider;
*
* @author brian@inteligr8.com
*/
@Component("client.cxf")
public class ClientCxfImpl extends Client {
private final Logger logger = LoggerFactory.getLogger(ClientCxfImpl.class);
@@ -52,7 +51,6 @@ public class ClientCxfImpl extends Client {
* This constructor is for Spring or POJO use.
* @param config The client configuration.
*/
@Autowired
public ClientCxfImpl(ClientCxfConfiguration config) {
this.config = config;
}
@@ -110,7 +108,7 @@ public class ClientCxfImpl extends Client {
om.registerModules(new JavaTimeModule());
this.getConfig().configureJacksonMapper(om);
JacksonJaxbJsonProvider jacksonProvider = new JacksonJaxbJsonProvider(om, JacksonJaxbJsonProvider.DEFAULT_ANNOTATIONS);
JacksonJsonProvider jacksonProvider = new JacksonJsonProvider(om, JacksonJsonProvider.BASIC_ANNOTATIONS);
this.getConfig().configureJacksonProvider(jacksonProvider);
List<Object> providersAndFilters = new LinkedList<Object>();
@@ -129,6 +127,17 @@ public class ClientCxfImpl extends Client {
// 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

View File

@@ -18,8 +18,8 @@ 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 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;
@@ -46,6 +46,8 @@ public class CxfLoggingFilter extends LoggingFilter {
} else {
logger.trace("request: {} {}: failed to output form", requestContext.getMethod(), requestContext.getUri());
}
} else {
super.logUnhandledRequest(requestContext, logger);
}
}

View File

@@ -17,10 +17,10 @@ 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 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;

View File

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

View File

@@ -17,8 +17,10 @@ package com.inteligr8.rs;
import java.io.UnsupportedEncodingException;
import java.util.Base64;
import javax.ws.rs.client.ClientRequestContext;
import javax.ws.rs.core.HttpHeaders;
import jakarta.ws.rs.client.ClientRequestContext;
import jakarta.ws.rs.core.HttpHeaders;
import org.apache.commons.lang3.StringUtils;
/**
* This class implements a simple 2-credential (username &amp; password) based
@@ -32,12 +34,14 @@ 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 = username;
this.password = password;
this.username = StringUtils.trimToNull(username);
this.password = StringUtils.trimToNull(password);
}
/**

View File

@@ -14,8 +14,8 @@
*/
package com.inteligr8.rs;
import javax.ws.rs.client.ClientRequestContext;
import javax.ws.rs.core.HttpHeaders;
import jakarta.ws.rs.client.ClientRequestContext;
import jakarta.ws.rs.core.HttpHeaders;
/**
* This class implements a simple long living or proxied token-based
@@ -32,6 +32,8 @@ 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,34 +14,41 @@
*/
package com.inteligr8.rs;
import javax.ws.rs.client.ClientBuilder;
import javax.ws.rs.client.WebTarget;
import java.util.concurrent.TimeUnit;
import jakarta.ws.rs.client.ClientBuilder;
import jakarta.ws.rs.client.WebTarget;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.SerializationFeature;
import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule;
import com.fasterxml.jackson.jaxrs.json.JacksonJaxbJsonProvider;
import com.fasterxml.jackson.jakarta.rs.json.JacksonJsonProvider;
/**
* A class that provides pre-configured JAX-RS Client &amp; WebTarget objects.
* A class that provides pre-configured Jakarta RS Client &amp; WebTarget objects.
*
* @author brian@inteligr8.com
*/
public abstract class Client {
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.
*/
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) {
if (this.client == null)
this.client = this.buildClient((AuthorizationFilter)null);
@@ -51,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.
* @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) {
return this.getClient();
} else {
@@ -63,15 +73,17 @@ 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 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();
om.registerModules(new JavaTimeModule());
this.getConfig().configureJacksonMapper(om);
JacksonJaxbJsonProvider provider = new JacksonJaxbJsonProvider(om, JacksonJaxbJsonProvider.DEFAULT_ANNOTATIONS);
JacksonJsonProvider provider = new JacksonJsonProvider(om, JacksonJsonProvider.BASIC_ANNOTATIONS);
this.getConfig().configureJacksonProvider(provider);
if (this.getConfig().isWrapRootValueEnabled())
@@ -82,6 +94,11 @@ public abstract class Client {
ClientBuilder clientBuilder = ClientBuilder.newBuilder()
.register(provider)
.register(new LoggingFilter());
if (this.getConfig().getConnectTimeoutInMillis() != null)
clientBuilder.connectTimeout(this.getConfig().getConnectTimeoutInMillis(), TimeUnit.MILLISECONDS);
if (this.getConfig().getResponseTimeoutInMillis() != null)
clientBuilder.readTimeout(this.getConfig().getResponseTimeoutInMillis(), TimeUnit.MILLISECONDS);
if (authFilter == null)
authFilter = this.getConfig().createAuthorizationFilter();
@@ -94,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) {
// 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() {
return this.getClient()
@@ -109,8 +131,10 @@ public abstract class Client {
}
/**
* This method builds an authorized Jakarta RS target.
*
* @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) {
if (authFilter == null) {
@@ -122,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 apiClass A JAX-RS annotated API class.
* @param <T> A Jakarta RS annotated API class.
* @param apiClass A Jakarta RS annotated API class.
* @return An instance of the API class.
*/
public final <T> T getApi(Class<T> apiClass) {
@@ -133,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.
*
* @param <T> A JAX-RS annotated API class.
* @param <T> A Jakarta RS annotated API class.
* @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.
*/
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 javax.ws.rs.client.ClientBuilder;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.jaxrs.json.JacksonJaxbJsonProvider;
import com.fasterxml.jackson.jakarta.rs.json.JacksonJsonProvider;
import jakarta.ws.rs.client.ClientBuilder;
/**
* This interface defines the configurable parameters of the clients; primarily
@@ -30,120 +30,189 @@ import com.fasterxml.jackson.jaxrs.json.JacksonJaxbJsonProvider;
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();
/**
* @return The username for BASIC authentication.
* This method retrieves the username to use in HTTP BASIC authentication/authorization.
*
* @return A username.
*/
default String getBasicAuthUsername() {
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() {
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() {
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() {
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() {
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() {
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() {
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() {
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() {
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() {
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() {
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() {
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;
}
/**
* @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() {
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() {
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) {
}
/**
* @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) {
}

View File

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

View File

@@ -14,21 +14,18 @@
*/
package com.inteligr8.rs;
import javax.annotation.PostConstruct;
import javax.ws.rs.client.ClientBuilder;
import jakarta.annotation.PostConstruct;
import jakarta.ws.rs.client.ClientBuilder;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
/**
* A class that provides pre-configured JAX-RS Client &amp; WebTarget objects
* for Jersey.
* A class that provides pre-configured Jakarta RS Client &amp; WebTarget
* objects.
*
* @author brian@inteligr8.com
*/
@Component("client.jaxrs")
public class ClientImpl extends Client {
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.
*
* @param config The client configuration.
*/
@Autowired
public ClientImpl(ClientConfiguration config) {
this.config = config;
}
/**
* This method registers the Jersey library as the default provider for the
* JAX-RS specification.
* This method is a placeholder.
*/
@PostConstruct
public void register() {
this.logger.info("API Base URL: {}", this.getConfig().getBaseUrl());
}
/**
* @param clientBuilder A client builder.
*/
@Override
public void buildClient(ClientBuilder clientBuilder) {
}
/**
* @return The client configuration.
*/
@Override
public ClientConfiguration 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) {
throw new UnsupportedOperationException();

View File

@@ -14,8 +14,8 @@
*/
package com.inteligr8.rs;
import javax.ws.rs.client.ClientRequestContext;
import javax.ws.rs.core.HttpHeaders;
import jakarta.ws.rs.client.ClientRequestContext;
import jakarta.ws.rs.core.HttpHeaders;
/**
* This class implements a proxied or forwarded authorization header based
@@ -32,6 +32,8 @@ 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

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

View File

@@ -16,12 +16,12 @@ package com.inteligr8.rs;
import java.io.IOException;
import javax.ws.rs.client.ClientRequestContext;
import javax.ws.rs.client.ClientRequestFilter;
import javax.ws.rs.client.ClientResponseContext;
import javax.ws.rs.client.ClientResponseFilter;
import javax.ws.rs.core.Form;
import javax.ws.rs.core.MediaType;
import jakarta.ws.rs.client.ClientRequestContext;
import jakarta.ws.rs.client.ClientRequestFilter;
import jakarta.ws.rs.client.ClientResponseContext;
import jakarta.ws.rs.client.ClientResponseFilter;
import jakarta.ws.rs.core.Form;
import jakarta.ws.rs.core.MediaType;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

View File

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

View File

@@ -16,21 +16,22 @@ package com.inteligr8.rs;
import java.util.Map;
import javax.ws.rs.WebApplicationException;
import javax.ws.rs.client.Client;
import javax.ws.rs.client.ClientBuilder;
import javax.ws.rs.client.ClientRequestContext;
import javax.ws.rs.client.Entity;
import javax.ws.rs.client.WebTarget;
import javax.ws.rs.core.Form;
import javax.ws.rs.core.HttpHeaders;
import javax.ws.rs.core.Response;
import javax.ws.rs.core.Response.Status.Family;
import jakarta.ws.rs.WebApplicationException;
import jakarta.ws.rs.client.Client;
import jakarta.ws.rs.client.ClientBuilder;
import jakarta.ws.rs.client.ClientRequestContext;
import jakarta.ws.rs.client.Entity;
import jakarta.ws.rs.client.WebTarget;
import jakarta.ws.rs.core.Form;
import jakarta.ws.rs.core.HttpHeaders;
import jakarta.ws.rs.core.Response;
import jakarta.ws.rs.core.Response.Status.Family;
import org.apache.commons.lang3.StringUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.fasterxml.jackson.jaxrs.json.JacksonJaxbJsonProvider;
import com.fasterxml.jackson.jakarta.rs.json.JacksonJsonProvider;
/**
* This class is the base for implementations of OAuth authorization flows.
@@ -88,9 +89,9 @@ public abstract class OAuthAuthorizationFilter implements AuthorizationFilter {
*/
public OAuthAuthorizationFilter(String tokenUrl, String clientId, String clientSecret, String scope) {
this.tokenUrl = tokenUrl;
this.clientId = clientId;
this.clientSecret = clientSecret;
this.scope = scope;
this.clientId = StringUtils.trimToNull(clientId);
this.clientSecret = StringUtils.trimToNull(clientSecret);
this.scope = StringUtils.trimToNull(scope);
}
/**
@@ -158,7 +159,7 @@ public abstract class OAuthAuthorizationFilter implements AuthorizationFilter {
Entity<Form> entity = Entity.form(form);
Client client = ClientBuilder.newBuilder()
.register(new JacksonJaxbJsonProvider())
.register(new JacksonJsonProvider())
.build();
WebTarget target = client.target(this.tokenUrl);

View File

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

View File

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