Commit 1caca6e3 authored by Scott Frederick's avatar Scott Frederick

Deprecate unused ErrorController interface method

This commit marks as deprecated an interface method that is no longer
used, and changes all internal implementations to return `null` to
make the fact that the return value is not used more obvious.

Fixes gh-19844
parent f4c27141
......@@ -83,7 +83,7 @@ public class BasicErrorController extends AbstractErrorController {
@Override
public String getErrorPath() {
return this.errorProperties.getPath();
return null;
}
@RequestMapping(produces = MediaType.TEXT_HTML_VALUE)
......
......@@ -19,19 +19,23 @@ package org.springframework.boot.web.servlet.error;
import org.springframework.stereotype.Controller;
/**
* Marker interface used to indicate that a {@link Controller @Controller} is used to
* render errors. Primarily used to know the error paths that will not need to be secured.
* Marker interface used to identify a {@link Controller @Controller} that should be used
* to render errors.
*
* @author Phillip Webb
* @author Scott Frederick
* @since 2.0.0
*/
@FunctionalInterface
public interface ErrorController {
/**
* Returns the path of the error page.
* The return value from this method is not used; the property `server.error.path`
* must be set to override the default error page path.
* @return the error path
* @deprecated since 2.3.0 in favor of setting the property `server.error.path`
*/
@Deprecated
String getErrorPath();
}
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment