Compare commits

...

45 Commits

Author SHA1 Message Date
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
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
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
f84279a148 better oauth token expiration handling 2023-06-12 17:16:03 -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
6cb7afd9f1 Merge branch 'develop' into stable 2022-10-02 17:56:01 -04:00
5df5388bd2 Merge branch 'develop' into stable 2022-10-02 17:52:21 -04:00
5cda622082 v2.0.1 poms 2022-10-01 21:26:18 -04:00
e1191abaaa Merge branch 'develop' into stable 2022-10-01 21:25:26 -04:00
67ea4b72b3 POM release to v2.0.0 2022-10-01 00:53:17 -04:00
a574154c20 Merge branch 'develop' into stable 2022-10-01 00:52:53 -04:00
b1b19d8cb0 Merge branch 'develop' into stable 2022-05-02 18:33:27 -04:00
160766e0ef v1.1.6 pom 2022-04-07 23:36:39 -04:00
e167ac43cc Merge branch 'develop' into stable 2022-04-07 23:36:09 -04:00
a28fc13161 v1.1.5 pom 2022-03-08 13:32:45 -05:00
52c7e3cf6d Merge branch 'develop' into stable 2022-03-08 13:29:28 -05:00
bd7413bb48 v1.1.4 pom 2022-02-02 13:34:16 -05:00
75c518801f Merge branch 'develop' into stable 2022-02-02 13:33:47 -05:00
b3bc04467b v1.1.3 pom 2021-12-21 17:13:26 -05:00
88c8657a34 Merge branch 'develop' into stable 2021-12-21 17:12:58 -05:00
28b2478a08 v1.1.2 pom 2021-12-02 16:25:05 -05:00
dc63abc272 Merge branch 'develop' into stable 2021-12-02 16:20:39 -05:00
dd5d0f504a Merge branch 'develop' into stable 2021-10-27 14:54:54 -04:00
34d03a91e5 Merge branch 'develop' into stable 2021-09-03 12:42:25 -04:00
2584b8d668 v1.1.1 pom 2021-09-03 11:38:52 -04:00
a756b05f6c Merge branch 'develop' into stable 2021-09-03 11:38:22 -04:00
853b4e66cf Merge branch 'develop' into stable 2021-09-01 14:43:43 -04:00
f2032df0f3 Merge branch 'develop' into stable 2021-08-31 13:22:01 -04:00
8d3f4559bd v1.0.2 pom 2021-07-22 15:23:15 -04:00
3f476bba5c Merge branch 'develop' into stable 2021-07-22 15:22:49 -04:00
6292dde23b v1.0.1 pom 2021-07-07 11:07:04 -04:00
659f71c72c Merge branch 'develop' into stable 2021-07-07 11:06:35 -04:00
52f77dddbb v1.0.0 pom 2021-06-16 15:59:04 -04:00
9 changed files with 87 additions and 14 deletions

View File

@@ -6,7 +6,7 @@
<groupId>com.inteligr8</groupId>
<artifactId>common-rest-client</artifactId>
<version>2.0-SNAPSHOT</version>
<version>2.0.9</version>
<packaging>jar</packaging>
<name>ReST API Client for Java</name>
@@ -74,6 +74,11 @@
<artifactId>jackson-datatype-jsr310</artifactId>
<version>${jackson.version}</version>
</dependency>
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-lang3</artifactId>
<version>3.14.0</version>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>

View File

@@ -20,6 +20,8 @@ import java.util.Base64;
import javax.ws.rs.client.ClientRequestContext;
import javax.ws.rs.core.HttpHeaders;
import org.apache.commons.lang3.StringUtils;
/**
* This class implements a simple 2-credential (username &amp; password) based
* authorization filter.
@@ -36,8 +38,8 @@ public class BasicAuthorizationFilter implements AuthorizationFilter {
* @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,6 +14,8 @@
*/
package com.inteligr8.rs;
import java.util.concurrent.TimeUnit;
import javax.ws.rs.client.ClientBuilder;
import javax.ws.rs.client.WebTarget;
@@ -82,6 +84,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();

View File

@@ -119,6 +119,16 @@ public interface ClientConfiguration {
}
default Integer getConnectTimeoutInMillis() {
return null;
}
default Integer getResponseTimeoutInMillis() {
return null;
}
/**
* @return true to enable Jackson UNWRAP_ROOT_VALUE feature; false otherwise.

View File

@@ -16,6 +16,8 @@ package com.inteligr8.rs;
import javax.ws.rs.client.ClientRequestContext;
import org.apache.commons.lang3.StringUtils;
/**
* This class is the base for implementations of client authorization similar
* to OAuth-based flows.
@@ -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

@@ -18,6 +18,10 @@ import java.net.URI;
import javax.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
* filter.
@@ -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

@@ -27,6 +27,7 @@ import javax.ws.rs.core.HttpHeaders;
import javax.ws.rs.core.Response;
import javax.ws.rs.core.Response.Status.Family;
import org.apache.commons.lang3.StringUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
@@ -48,6 +49,7 @@ 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
@@ -87,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);
}
/**
@@ -99,8 +101,29 @@ public abstract class OAuthAuthorizationFilter implements AuthorizationFilter {
*/
@Override
public void filter(ClientRequestContext requestContext) {
if (this.accessToken == null || System.currentTimeMillis() > this.expiration)
this.requestToken();
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;
}
}
}
}
requestContext.getHeaders().add(HttpHeaders.AUTHORIZATION, "Bearer " + this.accessToken);
}
@@ -139,6 +162,8 @@ public abstract class OAuthAuthorizationFilter implements AuthorizationFilter {
.register(new JacksonJaxbJsonProvider())
.build();
WebTarget target = client.target(this.tokenUrl);
long requestSendTime = System.currentTimeMillis();
Response response = target.request().post(entity);
@@ -160,8 +185,10 @@ public abstract class OAuthAuthorizationFilter implements AuthorizationFilter {
}
this.accessToken = (String)responseMap.get("access_token");
this.expiration = System.currentTimeMillis() + ((Number)responseMap.get("expires_in")).longValue() * 1000L;
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;
}
protected Form createRefreshForm() {

View File

@@ -16,6 +16,9 @@ package com.inteligr8.rs;
import javax.ws.rs.core.Form;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* This class implements the OAuth Client Credential flow as an authorization
* filter.
@@ -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

@@ -16,6 +16,10 @@ package com.inteligr8.rs;
import javax.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
* filter.
@@ -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);
}