Spring/spring-framework
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix checkstyle violation (plus related polishing)

Browse Source 
Issue: SPR-16913
This commit is contained in:
Juergen Hoeller
2018-07-02 23:56:58 +02:00
parent d08b72a75a
commit e485abbe56
1 changed files with 12 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
spring-web/src/main/java/org/springframework/http/HttpHeaders.java
View File

@@ -1286,7 +1286,7 @@ public class HttpHeaders implements MultiValueMap<String, String>, Serializable
* {@link IllegalArgumentException} ({@code true}) or rather return {@code null} * {@link IllegalArgumentException} ({@code true}) or rather return {@code null}
* in that case ({@code false}) * in that case ({@code false})
* @return the parsed date header, or {@code null} if none (or invalid) * @return the parsed date header, or {@code null} if none (or invalid)
*/ */
@Nullable @Nullable
private ZonedDateTime getFirstZonedDateTime(String headerName, boolean rejectInvalid) { private ZonedDateTime getFirstZonedDateTime(String headerName, boolean rejectInvalid) {
String headerValue = getFirst(headerName); String headerValue = getFirst(headerName);
@@ -1570,57 +1570,52 @@ public class HttpHeaders implements MultiValueMap<String, String>, Serializable
} }
/** /**
* Returns a {@code HttpHeaders} consumer that adds Basic Authentication. * Return a {@code HttpHeaders} consumer that adds Basic Authentication.
* More specifically: a consumer that adds an {@linkplain #AUTHORIZATION * More specifically: a consumer that adds an {@linkplain #AUTHORIZATION
* Authorization} header based on the given username and password. Meant * Authorization} header based on the given username and password.
* to be used in combination with * Meant to be used in combination with
* {@link org.springframework.web.reactive.function.client.WebClient.RequestHeadersSpec#headers(java.util.function.Consumer)}. * {@link org.springframework.web.reactive.function.client.WebClient.RequestHeadersSpec#headers(java.util.function.Consumer)}.
* <p>Note that Basic Authentication only supports characters in the * <p>Note that Basic Authentication only supports characters in the
* {@linkplain StandardCharsets#ISO_8859_1 ISO-8859-1} character set. * {@linkplain StandardCharsets#ISO_8859_1 ISO-8859-1} character set.
*
* @param username the username * @param username the username
* @param password the password * @param password the password
* @return a consumer that adds a Basic Authentication header * @return a consumer that adds a Basic Authentication header
* @since 5.1
*/ */
public static Consumer<HttpHeaders> basicAuthenticationConsumer(String username,String password) { public static Consumer<HttpHeaders> basicAuthenticationConsumer(String username, String password) {
return basicAuthenticationConsumer(() -> username, () -> password); return basicAuthenticationConsumer(() -> username, () -> password);
} }
/** /**
* Returns a {@code HttpHeaders} consumer that adds Basic Authentication. * Return a {@code HttpHeaders} consumer that adds Basic Authentication.
* More specifically: a consumer that adds an {@linkplain #AUTHORIZATION * More specifically: a consumer that adds an {@linkplain #AUTHORIZATION
* Authorization} header based on the given username and password * Authorization} header based on the given username and password
* suppliers. Meant to be used in combination with * suppliers. Meant to be used in combination with
* {@link org.springframework.web.reactive.function.client.WebClient.RequestHeadersSpec#headers(java.util.function.Consumer)}. * {@link org.springframework.web.reactive.function.client.WebClient.RequestHeadersSpec#headers(java.util.function.Consumer)}.
* <p>Note that Basic Authentication only supports characters in the * <p>Note that Basic Authentication only supports characters in the
* {@linkplain StandardCharsets#ISO_8859_1 ISO-8859-1} character set. * {@linkplain StandardCharsets#ISO_8859_1 ISO-8859-1} character set.
*
* @param usernameSupplier supplier for the username * @param usernameSupplier supplier for the username
* @param passwordSupplier supplier for the password * @param passwordSupplier supplier for the password
* @return a consumer that adds a Basic Authentication header * @return a consumer that adds a Basic Authentication header
* @since 5.1
*/ */
public static Consumer<HttpHeaders> basicAuthenticationConsumer(Supplier<String> usernameSupplier, public static Consumer<HttpHeaders> basicAuthenticationConsumer(
Supplier<String> passwordSupplier) { Supplier<String> usernameSupplier, Supplier<String> passwordSupplier) {
Assert.notNull(usernameSupplier, "Username Supplier must not be null"); Assert.notNull(usernameSupplier, "Username Supplier must not be null");
Assert.notNull(passwordSupplier, "Password Supplier must not be null"); Assert.notNull(passwordSupplier, "Password Supplier must not be null");
return new BasicAuthenticationConsumer(usernameSupplier, passwordSupplier); return new BasicAuthenticationConsumer(usernameSupplier, passwordSupplier);
} }
/**
* @see #basicAuthenticationConsumer
*/
private static class BasicAuthenticationConsumer implements Consumer<HttpHeaders> { private static class BasicAuthenticationConsumer implements Consumer<HttpHeaders> {
private final Supplier<String> usernameSupplier; private final Supplier<String> usernameSupplier;
private final Supplier<String> passwordSupplier; private final Supplier<String> passwordSupplier;
public BasicAuthenticationConsumer(Supplier<String> usernameSupplier, public BasicAuthenticationConsumer(Supplier<String> usernameSupplier, Supplier<String> passwordSupplier) {
Supplier<String> passwordSupplier) {
this.usernameSupplier = usernameSupplier; this.usernameSupplier = usernameSupplier;
this.passwordSupplier = passwordSupplier; this.passwordSupplier = passwordSupplier;
} }
@@ -1629,17 +1624,14 @@ public class HttpHeaders implements MultiValueMap<String, String>, Serializable
public void accept(HttpHeaders httpHeaders) { public void accept(HttpHeaders httpHeaders) {
String username = this.usernameSupplier.get(); String username = this.usernameSupplier.get();
String password = this.passwordSupplier.get(); String password = this.passwordSupplier.get();
Assert.state(username != null, "Supplied username is null"); Assert.state(username != null, "Supplied username is null");
Assert.state(password != null, "Supplied password is null"); Assert.state(password != null, "Supplied password is null");
checkIllegalCharacters(username, password); checkIllegalCharacters(username, password);
String credentialsString = username + ":" + password; String credentialsString = username + ":" + password;
byte[] credentialBytes = credentialsString.getBytes(StandardCharsets.ISO_8859_1); byte[] credentialBytes = credentialsString.getBytes(StandardCharsets.ISO_8859_1);
byte[] encodedBytes = Base64.getEncoder().encode(credentialBytes); byte[] encodedBytes = Base64.getEncoder().encode(credentialBytes);
String encodedCredentials = new String(encodedBytes, StandardCharsets.ISO_8859_1); String encodedCredentials = new String(encodedBytes, StandardCharsets.ISO_8859_1);
httpHeaders.set(HttpHeaders.AUTHORIZATION, "Basic " + encodedCredentials); httpHeaders.set(HttpHeaders.AUTHORIZATION, "Basic " + encodedCredentials);
} }
@@ -1651,6 +1643,6 @@ public class HttpHeaders implements MultiValueMap<String, String>, Serializable
"Username or password contains characters that cannot be encoded to ISO-8859-1"); "Username or password contains characters that cannot be encoded to ISO-8859-1");
} }
} }
} }
} }