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
pull/21002/head
Scott Frederick 5 years ago
parent f4c2714139
commit 1caca6e3d0

@ -83,7 +83,7 @@ public class BasicErrorController extends AbstractErrorController {
@Override @Override
public String getErrorPath() { public String getErrorPath() {
return this.errorProperties.getPath(); return null;
} }
@RequestMapping(produces = MediaType.TEXT_HTML_VALUE) @RequestMapping(produces = MediaType.TEXT_HTML_VALUE)

@ -19,19 +19,23 @@ package org.springframework.boot.web.servlet.error;
import org.springframework.stereotype.Controller; import org.springframework.stereotype.Controller;
/** /**
* Marker interface used to indicate that a {@link Controller @Controller} is used to * Marker interface used to identify a {@link Controller @Controller} that should be used
* render errors. Primarily used to know the error paths that will not need to be secured. * to render errors.
* *
* @author Phillip Webb * @author Phillip Webb
* @author Scott Frederick
* @since 2.0.0 * @since 2.0.0
*/ */
@FunctionalInterface @FunctionalInterface
public interface ErrorController { 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 * @return the error path
* @deprecated since 2.3.0 in favor of setting the property `server.error.path`
*/ */
@Deprecated
String getErrorPath(); String getErrorPath();
} }

Loading…
Cancel
Save