Polishing

This commit is contained in:
Juergen Hoeller 2018-08-06 18:34:00 +02:00
parent 8a9d042320
commit 943b394992
5 changed files with 23 additions and 23 deletions

View File

@ -1,5 +1,5 @@
/*
* Copyright 2002-2017 the original author or authors.
* Copyright 2002-2018 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.
@ -88,7 +88,6 @@ public class DefaultResponseErrorHandler implements ResponseErrorHandler {
* @since 5.0
*/
protected void handleError(ClientHttpResponse response, HttpStatus statusCode) throws IOException {
String statusText = response.getStatusText();
HttpHeaders headers = response.getHeaders();
byte[] body = getResponseBody(response);
@ -106,8 +105,8 @@ public class DefaultResponseErrorHandler implements ResponseErrorHandler {
}
}
private void handleClientError(HttpStatus statusCode,
String statusText, HttpHeaders headers, byte[] body, @Nullable Charset charset) {
private void handleClientError(
HttpStatus statusCode, String statusText, HttpHeaders headers, byte[] body, @Nullable Charset charset) {
switch (statusCode) {
case BAD_REQUEST:
@ -137,8 +136,8 @@ public class DefaultResponseErrorHandler implements ResponseErrorHandler {
}
}
private void handleServerError(HttpStatus statusCode,
String statusText, HttpHeaders headers, byte[] body, @Nullable Charset charset) {
private void handleServerError(
HttpStatus statusCode, String statusText, HttpHeaders headers, byte[] body, @Nullable Charset charset) {
switch (statusCode) {
case INTERNAL_SERVER_ERROR:

View File

@ -67,8 +67,7 @@ public class HttpClientErrorException extends HttpStatusCodeException {
}
// Sub-classes for specific HTTP status codes..
// Subclasses for specific HTTP status codes
/**
* {@link HttpClientErrorException} for status HTTP 400 Bad Request.

View File

@ -1,5 +1,5 @@
/*
* Copyright 2002-2016 the original author or authors.
* Copyright 2002-2018 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.
@ -67,8 +67,7 @@ public class HttpServerErrorException extends HttpStatusCodeException {
}
// Sub-classes for specific HTTP status codes..
// Subclasses for specific HTTP status codes
/**
* {@link HttpServerErrorException} for status HTTP 500 Internal Server Error.

View File

@ -13,11 +13,11 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.web.server.adapter;
import java.net.URI;
import java.util.Collections;
import java.util.LinkedHashSet;
import java.util.Locale;
import java.util.Set;
import java.util.function.Function;
@ -29,12 +29,12 @@ import org.springframework.util.LinkedCaseInsensitiveMap;
import org.springframework.web.util.UriComponentsBuilder;
/**
* Extract values from "Forwarded" and "X-Forwarded-*" headers to override the
* request URI (i.e. {@link ServerHttpRequest#getURI()}) so it reflects the
* client-originated protocol and address.
* Extract values from "Forwarded" and "X-Forwarded-*" headers to override
* the request URI (i.e. {@link ServerHttpRequest#getURI()}) so it reflects
* the client-originated protocol and address.
*
* <p>Alternatively if {@link #setRemoveOnly removeOnly} is set to "true", then
* "Forwarded" and "X-Forwarded-*" headers are only removed, and not used.
* <p>Alternatively if {@link #setRemoveOnly removeOnly} is set to "true",
* then "Forwarded" and "X-Forwarded-*" headers are only removed, and not used.
*
* @author Rossen Stoyanchev
* @since 5.1
@ -43,7 +43,7 @@ import org.springframework.web.util.UriComponentsBuilder;
public class ForwardedHeaderTransformer implements Function<ServerHttpRequest, ServerHttpRequest> {
static final Set<String> FORWARDED_HEADER_NAMES =
Collections.newSetFromMap(new LinkedCaseInsensitiveMap<>(6, Locale.ENGLISH));
Collections.newSetFromMap(new LinkedCaseInsensitiveMap<>(8, Locale.ENGLISH));
static {
FORWARDED_HEADER_NAMES.add("Forwarded");
@ -59,7 +59,7 @@ public class ForwardedHeaderTransformer implements Function<ServerHttpRequest, S
/**
* Enables mode in which any "Forwarded" or "X-Forwarded-*" headers are
* Enable mode in which any "Forwarded" or "X-Forwarded-*" headers are
* removed only and the information in them ignored.
* @param removeOnly whether to discard and ignore forwarded headers
*/
@ -69,6 +69,7 @@ public class ForwardedHeaderTransformer implements Function<ServerHttpRequest, S
/**
* Whether the "remove only" mode is on.
* @see #setRemoveOnly
*/
public boolean isRemoveOnly() {
return this.removeOnly;
@ -81,7 +82,6 @@ public class ForwardedHeaderTransformer implements Function<ServerHttpRequest, S
*/
@Override
public ServerHttpRequest apply(ServerHttpRequest request) {
if (hasForwardedHeaders(request)) {
ServerHttpRequest.Builder builder = request.mutate();
if (!this.removeOnly) {
@ -96,7 +96,6 @@ public class ForwardedHeaderTransformer implements Function<ServerHttpRequest, S
removeForwardedHeaders(builder);
request = builder.build();
}
return request;
}
@ -118,6 +117,7 @@ public class ForwardedHeaderTransformer implements Function<ServerHttpRequest, S
builder.headers(map -> FORWARDED_HEADER_NAMES.forEach(map::remove));
}
@Nullable
private static String getForwardedPrefix(ServerHttpRequest request) {
HttpHeaders headers = request.getHeaders();

View File

@ -54,10 +54,12 @@ public abstract class ExchangeFilterFunctions {
public static final String BASIC_AUTHENTICATION_CREDENTIALS_ATTRIBUTE =
ExchangeFilterFunctions.class.getName() + ".basicAuthenticationCredentials";
/**
* Consume up to the specified number of bytes from the response body and
* cancel if any more data arrives. Internally delegates to
* {@link DataBufferUtils#takeUntilByteCount}.
* cancel if any more data arrives.
* <p>Internally delegates to {@link DataBufferUtils#takeUntilByteCount}.
* @param maxByteCount the limit as number of bytes
* @return the filter to limit the response size with
* @since 5.1
*/
@ -107,6 +109,7 @@ public abstract class ExchangeFilterFunctions {
.map(credentials -> (Credentials) credentials));
}
@Deprecated
private static ExchangeFilterFunction basicAuthenticationInternal(
Function<ClientRequest, Optional<Credentials>> credentialsFunction) {