Skip to content

Commit f0e4e1e

Browse files
PhilippHeuerPhilippHeuer
committed
feat: add support for oauth auth methods
1 parent 73498f5 commit f0e4e1e

17 files changed

Lines changed: 464 additions & 33 deletions

File tree

‎bom/build.gradle.kts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ projectConfiguration {
1212
dependencies {
1313
constraints {
1414
api(project(":feign-common"))
15+
api(project(":feign-blackbird"))
1516
api(project(":feign-resilience4j"))
1617
}
1718
}

‎build.gradle.kts‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
// Plugins
22
plugins {
33
`java-library`
4-
id("me.philippheuer.configuration") version "0.10.7"
4+
id("me.philippheuer.configuration") version "0.14.0"
55
}
66

77
version = properties["version"] as String
@@ -54,9 +54,9 @@ subprojects {
5454

5555
dependencies {
5656
// bom
57-
add("api", platform("io.github.openfeign:feign-bom:12.4"))
58-
add("api", platform("io.github.resilience4j:resilience4j-bom:2.1.0"))
59-
add("api", platform("com.fasterxml.jackson:jackson-bom:2.15.2"))
57+
add("api", platform("io.github.openfeign:feign-bom:13.5"))
58+
add("api", platform("io.github.resilience4j:resilience4j-bom:2.3.0"))
59+
add("api", platform("com.fasterxml.jackson:jackson-bom:2.18.2"))
6060
}
6161
}
6262
}

‎common/build.gradle.kts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,5 @@ projectConfiguration {
1010

1111
dependencies {
1212
// annotations
13-
implementation("org.jetbrains:annotations:24.0.1")
13+
implementation("org.jetbrains:annotations:26.0.2")
1414
}

‎feign-blackbird/build.gradle.kts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ dependencies {
1313
api(project(":feign-common"))
1414

1515
// annotations
16-
implementation("org.jetbrains:annotations:24.0.1")
16+
implementation("org.jetbrains:annotations:26.0.2")
1717

1818
// feign
1919
api("io.github.openfeign:feign-core")

‎feign-common/build.gradle.kts‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,14 @@ dependencies {
1313
api(project(":common"))
1414

1515
// annotations
16-
implementation("org.jetbrains:annotations:24.0.1")
16+
implementation("org.jetbrains:annotations:26.0.2")
1717

1818
// feign
1919
api("io.github.openfeign:feign-core")
2020

21+
// auth
22+
implementation("com.github.philippheuer.credentialmanager:credentialmanager:0.3.1")
23+
2124
// jackson
2225
compileOnly("com.fasterxml.jackson.core:jackson-databind")
2326
}

‎feign-common/src/main/java/io/github/primelib/primecodegenlib/java/feign/common/auth/ApiKeyAuthSpec.java‎

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
package io.github.primelib.primecodegenlib.java.feign.common.auth;
2+
3+
import lombok.AccessLevel;
4+
import lombok.Data;
5+
import lombok.EqualsAndHashCode;
6+
import lombok.NoArgsConstructor;
7+
import lombok.experimental.Accessors;
8+
import org.jetbrains.annotations.NotNull;
9+
10+
import java.util.Map;
11+
import java.util.Objects;
12+
import java.util.function.Consumer;
13+
14+
@Data
15+
@EqualsAndHashCode(callSuper = true)
16+
@Accessors(fluent = true)
17+
@NoArgsConstructor(access = AccessLevel.PRIVATE, force = true)
18+
public class ApiKeyAuthSpec extends AuthSpecBase {
19+
/**
20+
* location of the API key
21+
*/
22+
@NotNull
23+
private String propertyLocation = "header";
24+
25+
/**
26+
* key of the property that holds the API key (header key or query param key)
27+
*/
28+
@NotNull
29+
private String propertyKey = "x-api-key";
30+
31+
/**
32+
* template for the API key property, use {apiKey} as placeholder for the value
33+
*/
34+
private String propertyTemplate = "";
35+
36+
/**
37+
* the API key
38+
*/
39+
@NotNull
40+
private String apiKey;
41+
42+
/**
43+
* Constructs a validated implementation of {@link ApiKeyAuthSpec}.
44+
*
45+
* @param spec the specification to process
46+
*/
47+
public ApiKeyAuthSpec(Consumer<ApiKeyAuthSpec> spec) {
48+
spec.accept(this);
49+
validate();
50+
update(apiKey);
51+
}
52+
53+
/**
54+
* Validates the Spec, will throw a exception if required parameters are missing
55+
*
56+
* @throws NullPointerException if a required parameter is missing
57+
* @throws IllegalArgumentException if a parameter has an invalid value
58+
*/
59+
public void validate() {
60+
Objects.requireNonNull(apiKey, "apiKey is a required parameter!");
61+
62+
// validate propertyLocation
63+
if (!propertyLocation.equals("header") && !propertyLocation.equals("query"))
64+
throw new IllegalArgumentException("propertyLocation must be either header or query");
65+
}
66+
67+
private void update(String value) {
68+
if (propertyTemplate != null && !propertyTemplate.isEmpty())
69+
value = propertyTemplate.replace("{apiKey}", value);
70+
71+
// set params
72+
if ("header".equalsIgnoreCase(propertyLocation)) {
73+
headerMap = Map.of(propertyKey, value);
74+
queryMap = null;
75+
cookieMap = null;
76+
} else if ("query".equalsIgnoreCase(propertyLocation)) {
77+
headerMap = null;
78+
queryMap = Map.of(propertyKey, value);
79+
cookieMap = null;
80+
}
81+
}
82+
}

‎feign-common/src/main/java/io/github/primelib/primecodegenlib/java/feign/common/auth/AuthSpecBase.java‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
package io.github.primelib.primecodegenlib.java.feign.common.auth;
2+
3+
import lombok.AccessLevel;
4+
import lombok.Getter;
5+
import lombok.Setter;
6+
7+
import java.util.Map;
8+
9+
public abstract class AuthSpecBase {
10+
@Setter(AccessLevel.NONE)
11+
@Getter(AccessLevel.PUBLIC)
12+
protected Map<String, String> headerMap = null;
13+
14+
@Setter(AccessLevel.NONE)
15+
@Getter(AccessLevel.PUBLIC)
16+
protected Map<String, String> queryMap = null;
17+
18+
@Setter(AccessLevel.NONE)
19+
@Getter(AccessLevel.PUBLIC)
20+
protected Map<String, String> cookieMap = null;
21+
}

‎feign-common/src/main/java/io/github/primelib/primecodegenlib/java/feign/common/auth/BasicAuthSpec.java‎

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
package io.github.primelib.primecodegenlib.java.feign.common.auth;
2+
3+
import lombok.AccessLevel;
4+
import lombok.Data;
5+
import lombok.EqualsAndHashCode;
6+
import lombok.NoArgsConstructor;
7+
import lombok.experimental.Accessors;
8+
import org.jetbrains.annotations.NotNull;
9+
import org.jetbrains.annotations.Nullable;
10+
11+
import java.util.Map;
12+
import java.util.Objects;
13+
import java.util.function.Consumer;
14+
15+
@Data
16+
@EqualsAndHashCode(callSuper = true)
17+
@Accessors(fluent = true)
18+
@NoArgsConstructor(access = AccessLevel.PRIVATE, force = true)
19+
public class BasicAuthSpec extends AuthSpecBase {
20+
/**
21+
* key of the property that holds the API key (header key or query param key)
22+
*/
23+
@NotNull
24+
private String propertyKey = "Authorization";
25+
26+
/**
27+
* template for the basic auth value, use {base64} as placeholder for the value
28+
*/
29+
@NotNull
30+
private String valueTemplate = "Basic {base64}";
31+
32+
/**
33+
* username
34+
*/
35+
@Nullable
36+
private String username;
37+
38+
/**
39+
* password
40+
*/
41+
@Nullable
42+
private String password;
43+
44+
/**
45+
* Constructs a validated implementation of {@link BasicAuthSpec}.
46+
*
47+
* @param spec the specification to process
48+
*/
49+
public BasicAuthSpec(Consumer<BasicAuthSpec> spec) {
50+
spec.accept(this);
51+
validate();
52+
update(username, password);
53+
}
54+
55+
/**
56+
* Validates the Spec, will throw a exception if required parameters are missing
57+
*
58+
* @throws NullPointerException if a required parameter is missing
59+
* @throws IllegalArgumentException if a parameter has an invalid value
60+
*/
61+
public void validate() {
62+
Objects.requireNonNull(propertyKey, "propertyKey is required");
63+
Objects.requireNonNull(valueTemplate, "valueTemplate is required");
64+
if (username == null && password == null)
65+
throw new NullPointerException("username or password are required");
66+
}
67+
68+
private void update(String username, String password) {
69+
String encoded = java.util.Base64.getEncoder().encodeToString((username + ":" + password).getBytes());
70+
encoded = valueTemplate.replace("{base64}", encoded);
71+
72+
// set params
73+
headerMap = Map.of("Authorization", encoded);
74+
}
75+
}

‎feign-common/src/main/java/io/github/primelib/primecodegenlib/java/feign/common/auth/BearerAuthSpec.java‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
package io.github.primelib.primecodegenlib.java.feign.common.auth;
2+
3+
import lombok.AccessLevel;
4+
import lombok.Data;
5+
import lombok.EqualsAndHashCode;
6+
import lombok.NoArgsConstructor;
7+
import lombok.experimental.Accessors;
8+
import org.jetbrains.annotations.NotNull;
9+
10+
import java.util.Map;
11+
import java.util.Objects;
12+
import java.util.function.Consumer;
13+
14+
@Data
15+
@EqualsAndHashCode(callSuper = true)
16+
@Accessors(fluent = true)
17+
@NoArgsConstructor(access = AccessLevel.PRIVATE, force = true)
18+
public class BearerAuthSpec extends AuthSpecBase {
19+
@NotNull
20+
private String propertyKey = "Authorization";
21+
@NotNull
22+
private String valueTemplate = "Bearer {token}";
23+
24+
/**
25+
* the token
26+
*/
27+
@NotNull
28+
private String token;
29+
30+
/**
31+
* Constructs a validated implementation of {@link BearerAuthSpec}.
32+
*
33+
* @param spec the specification to process
34+
*/
35+
public BearerAuthSpec(Consumer<BearerAuthSpec> spec) {
36+
spec.accept(this);
37+
validate();
38+
update(token);
39+
}
40+
41+
/**
42+
* Validates the Spec, will throw a exception if required parameters are missing
43+
*
44+
* @throws NullPointerException if a required parameter is missing
45+
* @throws IllegalArgumentException if a parameter has an invalid value
46+
*/
47+
public void validate() {
48+
Objects.requireNonNull(token, "token is a required parameter!");
49+
Objects.requireNonNull(propertyKey, "propertyKey is required");
50+
Objects.requireNonNull(valueTemplate, "valueTemplate is required");
51+
}
52+
53+
private void update(String value) {
54+
value = valueTemplate.replace("{token}", value);
55+
headerMap = Map.of(propertyKey, value);
56+
}
57+
}

‎feign-common/src/main/java/io/github/primelib/primecodegenlib/java/feign/common/auth/OAuth2ClientCredentialsAuthSpec.java‎

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
package io.github.primelib.primecodegenlib.java.feign.common.auth;
2+
3+
import com.github.philippheuer.credentialmanager.domain.OAuth2Credential;
4+
import com.github.philippheuer.credentialmanager.identityprovider.DefaultOAuth2IdentityProvider;
5+
import com.github.philippheuer.credentialmanager.identityprovider.OAuth2IdentityProvider;
6+
import lombok.AccessLevel;
7+
import lombok.Data;
8+
import lombok.EqualsAndHashCode;
9+
import lombok.NoArgsConstructor;
10+
import lombok.experimental.Accessors;
11+
import lombok.extern.slf4j.Slf4j;
12+
import org.jetbrains.annotations.ApiStatus;
13+
import org.jetbrains.annotations.NotNull;
14+
import org.jetbrains.annotations.Nullable;
15+
16+
import java.time.Instant;
17+
import java.util.Map;
18+
import java.util.Objects;
19+
import java.util.concurrent.locks.ReentrantLock;
20+
import java.util.function.Consumer;
21+
22+
@Data
23+
@EqualsAndHashCode(callSuper = true)
24+
@Accessors(fluent = true)
25+
@NoArgsConstructor(access = AccessLevel.PRIVATE, force = true)
26+
@Slf4j
27+
public class OAuth2ClientCredentialsAuthSpec extends AuthSpecBase {
28+
private final ReentrantLock refreshLock = new ReentrantLock();
29+
30+
@NotNull
31+
private String tokenEndpoint;
32+
@NotNull
33+
private String clientId;
34+
@NotNull
35+
private String clientSecret;
36+
37+
@NotNull
38+
private String propertyKey = "Authorization";
39+
@NotNull
40+
private String valueTemplate = "Bearer {token}";
41+
42+
@ApiStatus.Internal
43+
@NotNull
44+
private OAuth2IdentityProvider idp;
45+
46+
@ApiStatus.Internal
47+
@Nullable
48+
private OAuth2Credential credential;
49+
50+
/**
51+
* Constructs a validated implementation of {@link OAuth2ClientCredentialsAuthSpec}.
52+
*
53+
* @param spec the specification to process
54+
*/
55+
public OAuth2ClientCredentialsAuthSpec(Consumer<OAuth2ClientCredentialsAuthSpec> spec) {
56+
spec.accept(this);
57+
validate();
58+
}
59+
60+
/**
61+
* Validates the Spec, will throw a exception if required parameters are missing
62+
*
63+
* @throws NullPointerException if a required parameter is missing
64+
* @throws IllegalArgumentException if a parameter has an invalid value
65+
*/
66+
public void validate() {
67+
Objects.requireNonNull(tokenEndpoint, "tokenEndpoint is a required parameter!");
68+
Objects.requireNonNull(clientId, "clientId is a required parameter!");
69+
Objects.requireNonNull(clientSecret, "clientSecret is a required parameter!");
70+
Objects.requireNonNull(propertyKey, "propertyKey is required");
71+
Objects.requireNonNull(valueTemplate, "valueTemplate is required");
72+
}
73+
74+
@Override
75+
public Map<String, String> getHeaderMap() {
76+
if (credential == null || credential.getReceivedAt().plusSeconds(credential.getExpiresIn()).isBefore(Instant.now())) {
77+
refreshLock.lock();
78+
try {
79+
if (credential == null || credential.getReceivedAt().plusSeconds(credential.getExpiresIn()).isBefore(Instant.now())) {
80+
credential = idp.getAppAccessToken();
81+
}
82+
} finally {
83+
refreshLock.unlock();
84+
}
85+
}
86+
87+
return Map.of(propertyKey, valueTemplate.replace("{token}", credential.getAccessToken()));
88+
}
89+
}

0 commit comments

Comments
 (0)