Add WebInputException subclasses

Closes gh-28142
This commit is contained in:
rstoyanchev
2022-05-09 08:58:31 +01:00
parent 06e1cc2f9b
commit 5d0f49c2c8
15 changed files with 261 additions and 79 deletions

View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2021 the original author or authors.
* Copyright 2002-2022 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.
@@ -31,11 +31,10 @@ import org.springframework.validation.FieldError;
import org.springframework.validation.ObjectError;
import org.springframework.web.server.ServerWebInputException;
/**
* A specialization of {@link ServerWebInputException} thrown when after data
* binding and validation failure. Implements {@link BindingResult} (and its
* super-interface {@link Errors}) to allow for direct analysis of binding and
* validation errors.
* {@link ServerWebInputException} subclass that indicates a data binding or
* validation failure.
*
* @author Rossen Stoyanchev
* @since 5.0

View File

@@ -0,0 +1,72 @@
/*
* Copyright 2002-2022 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.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.web.server;
import org.springframework.core.MethodParameter;
/**
* {@link ServerWebInputException} subclass that indicates a missing request
* value such as a request header, cookie value, query parameter, etc.
*
* @author Rossen Stoyanchev
* @since 6.0
*/
@SuppressWarnings("serial")
public class MissingRequestValueException extends ServerWebInputException {
private final String name;
private final Class<?> type;
private final String label;
public MissingRequestValueException(String name, Class<?> type, String label, MethodParameter parameter) {
super("Required " + label + " '" + name + "' is not present.", parameter);
this.name = name;
this.type = type;
this.label = label;
getBody().withDetail(getReason());
}
/**
* Return the name of the missing value, e.g. the name of the missing request
* header, or cookie, etc.
*/
public String getName() {
return this.name;
}
/**
* Return the target type the value is converted when present.
*/
public Class<?> getType() {
return this.type;
}
/**
* Return a label that describes the request value, e.g. "request header",
* "cookie value", etc. Use this to create a custom message.
*/
public String getLabel() {
return this.label;
}
}

View File

@@ -0,0 +1,78 @@
/*
* Copyright 2002-2022 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.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.web.server;
import java.util.List;
import org.springframework.util.MultiValueMap;
/**
* {@link ServerWebInputException} subclass that indicates an unsatisfied
* parameter condition, as typically expressed using an {@code @RequestMapping}
* annotation at the {@code @Controller} type level.
*
* @author Rossen Stoyanchev
* @since 6.0
*/
@SuppressWarnings("serial")
public class UnsatisfiedRequestParameterException extends ServerWebInputException {
private final List<String> conditions;
private final MultiValueMap<String, String> requestParams;
public UnsatisfiedRequestParameterException(
List<String> conditions, MultiValueMap<String, String> requestParams) {
super(initReason(conditions, requestParams));
this.conditions = conditions;
this.requestParams = requestParams;
getBody().withDetail("Invalid request parameters.");
}
private static String initReason(List<String> conditions, MultiValueMap<String, String> queryParams) {
StringBuilder sb = new StringBuilder("Parameter conditions ");
int i = 0;
for (String condition : conditions) {
if (i > 0) {
sb.append(" OR ");
}
sb.append('"').append(condition).append('"');
i++;
}
sb.append(" not met for actual request parameters: ").append(queryParams);
return sb.toString();
}
/**
* Return String representations of the unsatisfied condition(s).
*/
public List<String> getConditions() {
return this.conditions;
}
/**
* Return the actual request parameters.
*/
public MultiValueMap<String, String> getRequestParams() {
return this.requestParams;
}
}