Cwikius-Spring/spring-security
1
0
Fork 0
mirror of https://github.com/spring-projects/spring-security.git synced 2025-05-30 08:42:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add valueOf

Browse Source 
This commit adds a static factory for returning a constant
ClientAuthenticationMethod or creating a new one when there
is no match.

Issue gh-16825
This commit is contained in:
Josh Cummings 2025-04-02 11:16:26 -06:00
parent 2a24bb0b26
commit 2885b0f75f
3 changed files with 53 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
config/src/main/java/org/springframework/security/config/oauth2/client/ClientRegistrationsBeanDefinitionParser.java
View File

@ -1,5 +1,5 @@
/*
* Copyright 2002-2020 the original author or authors.
* Copyright 2002-2025 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@ -125,7 +125,7 @@ public final class ClientRegistrationsBeanDefinitionParser implements BeanDefini
getOptionalIfNotEmpty(parserContext, clientRegistrationElt.getAttribute(ATT_CLIENT_SECRET))
.ifPresent(builder::clientSecret);
getOptionalIfNotEmpty(parserContext, clientRegistrationElt.getAttribute(ATT_CLIENT_AUTHENTICATION_METHOD))
.map(ClientAuthenticationMethod::new)
.map(ClientAuthenticationMethod::valueOf)
.ifPresent(builder::clientAuthenticationMethod);
getOptionalIfNotEmpty(parserContext, clientRegistrationElt.getAttribute(ATT_AUTHORIZATION_GRANT_TYPE))
.map(AuthorizationGrantType::new)

26
oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/ClientAuthenticationMethod.java
View File

@ -1,5 +1,5 @@
/*
* Copyright 2002-2024 the original author or authors.
* Copyright 2002-2025 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@ -18,6 +18,7 @@ package org.springframework.security.oauth2.core;
import java.io.Serializable;
import org.springframework.lang.NonNull;
import org.springframework.security.core.SpringSecurityCoreVersion;
import org.springframework.util.Assert;
@ -92,6 +93,29 @@ public final class ClientAuthenticationMethod implements Serializable {
return this.value;
}
static ClientAuthenticationMethod[] methods() {
return new ClientAuthenticationMethod[] { CLIENT_SECRET_BASIC, CLIENT_SECRET_POST, CLIENT_SECRET_JWT,
PRIVATE_KEY_JWT, NONE, TLS_CLIENT_AUTH, SELF_SIGNED_TLS_CLIENT_AUTH };
}
/**
* A factory to construct a {@link ClientAuthenticationMethod} based on a string,
* returning any constant value that matches.
* @param method the client authentication method
* @return a {@link ClientAuthenticationMethod}; specifically the corresponding
* constant, if any
* @since 6.5
*/
@NonNull
public static ClientAuthenticationMethod valueOf(String method) {
for (ClientAuthenticationMethod m : methods()) {
if (m.getValue().equals(method)) {
return m;
}
}
return new ClientAuthenticationMethod(method);
}
@Override
public boolean equals(Object obj) {
if (this == obj) {

27
oauth2/oauth2-core/src/test/java/org/springframework/security/oauth2/core/ClientAuthenticationMethodTests.java
View File

@ -1,5 +1,5 @@
/*
* Copyright 2002-2024 the original author or authors.
* Copyright 2002-2025 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@ -16,7 +16,13 @@
package org.springframework.security.oauth2.core;
import java.util.stream.Stream;
import org.junit.jupiter.api.DynamicTest;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.TestFactory;
import org.springframework.util.StringUtils;
import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatIllegalArgumentException;
@ -69,4 +75,23 @@ public class ClientAuthenticationMethodTests {
.isEqualTo("self_signed_tls_client_auth");
}
@Test
public void valueOfWhenAnyAuthenticationMethodThenConstructs() {
String string = new String("any");
ClientAuthenticationMethod method = ClientAuthenticationMethod.valueOf(string);
assertThat(method.getValue()).isSameAs(string);
}
@TestFactory
Stream<DynamicTest> valueOfWhenMatchesStaticThenReturnsStatic() {
return Stream.of(ClientAuthenticationMethod.methods())
.map((method) -> DynamicTest.dynamicTest(testName(method.getValue()),
() -> assertThat(ClientAuthenticationMethod.valueOf(method.getValue())).isSameAs(method)));
}
String testName(String method) {
String methodName = StringUtils.capitalize(method.replaceAll("_", ""));
return "valueOfWhen" + methodName + "ThenReturnsStatic" + methodName;
}
}