Add concrete ResponseStatusException sub-classes

This commit is contained in:
Rossen Stoyanchev
2016-04-19 15:30:13 -04:00
parent 66707835fe
commit 8f0fe713f5
4 changed files with 252 additions and 0 deletions

View File

@@ -0,0 +1,63 @@
/*
* Copyright 2002-2016 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
*
* http://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.Optional;
import org.springframework.core.MethodParameter;
import org.springframework.http.HttpStatus;
/**
* Exception for errors that fit response status 400 (bad request).
*
* @author Rossen Stoyanchev
*/
public class BadRequestStatusException extends ResponseStatusException {
private final MethodParameter parameter;
/**
* Constructor with an explanation only.
*/
public BadRequestStatusException(String reason) {
this(reason, null);
}
/**
* Constructor for a 400 error linked to a specific {@code MethodParameter}.
*/
public BadRequestStatusException(String reason, MethodParameter parameter) {
this(reason, parameter, null);
}
/**
* Constructor for a 400 error with a root cause.
*/
public BadRequestStatusException(String reason, MethodParameter parameter, Throwable cause) {
super(HttpStatus.BAD_REQUEST, reason, cause);
this.parameter = parameter;
}
/**
* Return the {@code MethodParameter} associated with this error, if any.
*/
public Optional<MethodParameter> getMethodParameter() {
return Optional.ofNullable(this.parameter);
}
}

View File

@@ -0,0 +1,59 @@
/*
* Copyright 2002-2016 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
*
* http://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.Collection;
import java.util.Collections;
import java.util.HashSet;
import java.util.Set;
import org.springframework.http.HttpStatus;
import org.springframework.util.Assert;
/**
* Exception for errors that fit response status 405 (method not allowed).
*
* @author Rossen Stoyanchev
*/
public class MethodNotAllowedException extends ResponseStatusException {
private String method;
private Set<String> supportedMethods;
public MethodNotAllowedException(String method, Collection<String> supportedMethods) {
super(HttpStatus.METHOD_NOT_ALLOWED, "Request method '" + method + "' not supported");
Assert.notNull(method, "'method' is required");
this.method = method;
this.supportedMethods = Collections.unmodifiableSet(new HashSet<>(supportedMethods));
}
/**
* Return the HTTP method for the failed request.
*/
public String getHttpMethod() {
return this.method;
}
/**
* Return the list of supported HTTP methods.
*/
public Set<String> getSupportedMethods() {
return supportedMethods;
}
}

View File

@@ -0,0 +1,59 @@
/*
* Copyright 2002-2016 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
*
* http://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.Collections;
import java.util.List;
import org.springframework.http.HttpStatus;
import org.springframework.http.MediaType;
/**
* Exception for errors that fit response status 405 (not acceptable).
*
* @author Rossen Stoyanchev
*/
public class NotAcceptableStatusException extends ResponseStatusException {
private final List<MediaType> supportedMediaTypes;
/**
* Constructor for when the requested Content-Type is invalid.
*/
public NotAcceptableStatusException(String reason) {
super(HttpStatus.NOT_ACCEPTABLE, reason);
this.supportedMediaTypes = Collections.emptyList();
}
/**
* Constructor for when requested Content-Type is not supported.
*/
public NotAcceptableStatusException(List<MediaType> supportedMediaTypes) {
super(HttpStatus.NOT_ACCEPTABLE, "Could not find acceptable representation", null);
this.supportedMediaTypes = Collections.unmodifiableList(supportedMediaTypes);
}
/**
* Return the list of supported content types in cases when the Accept
* header is parsed but not supported, or an empty list otherwise.
*/
public List<MediaType> getSupportedMediaTypes() {
return this.supportedMediaTypes;
}
}

View File

@@ -0,0 +1,71 @@
/*
* Copyright 2002-2016 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
*
* http://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.Collections;
import java.util.List;
import java.util.Optional;
import org.springframework.http.HttpStatus;
import org.springframework.http.MediaType;
/**
* Exception for errors that fit response status 416 (unsupported media type).
*
* @author Rossen Stoyanchev
*/
public class UnsupportedMediaTypeStatusException extends ResponseStatusException {
private final MediaType contentType;
private final List<MediaType> supportedContentTypes;
/**
* Constructor for when the specified Content-Type is invalid.
*/
public UnsupportedMediaTypeStatusException(String reason) {
super(HttpStatus.UNSUPPORTED_MEDIA_TYPE, reason);
this.contentType = null;
this.supportedContentTypes = Collections.emptyList();
}
/**
* Constructor for when the Content-Type can be parsed but is not supported.
*/
public UnsupportedMediaTypeStatusException(MediaType contentType, List<MediaType> supportedContentTypes) {
super(HttpStatus.UNSUPPORTED_MEDIA_TYPE, "Content type '" + contentType + "' not supported");
this.contentType = contentType;
this.supportedContentTypes = Collections.unmodifiableList(supportedContentTypes);
}
/**
* Return the request Content-Type header if it was parsed successfully.
*/
public Optional<MediaType> getContentType() {
return Optional.ofNullable(this.contentType);
}
/**
* Return the list of supported content types in cases when the Content-Type
* header is parsed but not supported, or an empty list otherwise.
*/
public List<MediaType> getSupportedContentTypes() {
return this.supportedContentTypes;
}
}