org.springframework.web.servlet.NoHandlerFoundException Maven / Gradle / Ivy
/*
* Copyright 2002-2024 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.servlet;
import jakarta.servlet.ServletException;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpStatus;
import org.springframework.http.HttpStatusCode;
import org.springframework.http.ProblemDetail;
import org.springframework.web.ErrorResponse;
/**
* Thrown when the {@link DispatcherServlet} can't find a handler for a request,
* which may be handled with a configured {@link HandlerExceptionResolver}.
*
* @author Brian Clozel
* @since 4.0
* @see DispatcherServlet#noHandlerFound(HttpServletRequest, HttpServletResponse)
*/
@SuppressWarnings("serial")
public class NoHandlerFoundException extends ServletException implements ErrorResponse {
private final String httpMethod;
private final String requestURL;
private final HttpHeaders requestHeaders;
private final ProblemDetail body;
/**
* Constructor for NoHandlerFoundException.
* @param httpMethod the HTTP method
* @param requestURL the HTTP request URL
* @param headers the HTTP request headers
*/
public NoHandlerFoundException(String httpMethod, String requestURL, HttpHeaders headers) {
super("No endpoint " + httpMethod + " " + requestURL + ".");
this.httpMethod = httpMethod;
this.requestURL = requestURL;
this.requestHeaders = headers;
this.body = ProblemDetail.forStatusAndDetail(getStatusCode(), getMessage());
}
@Override
public HttpStatusCode getStatusCode() {
return HttpStatus.NOT_FOUND;
}
public String getHttpMethod() {
return this.httpMethod;
}
public String getRequestURL() {
return this.requestURL;
}
/**
* Return headers to use for the response.
* Note: As of 6.0 this method overlaps with
* {@link ErrorResponse#getHeaders()} and therefore no longer returns request
* headers. Use {@link #getRequestHeaders()} instead for request headers.
*/
@Override
public HttpHeaders getHeaders() {
return ErrorResponse.super.getHeaders();
}
/**
* Return the headers of the request.
* @since 6.0.3
*/
public HttpHeaders getRequestHeaders() {
return this.requestHeaders;
}
@Override
public ProblemDetail getBody() {
return this.body;
}
}