Class MissingRequestHeaderException

java.lang.Object

java.lang.Throwable

java.lang.Exception

jakarta.servlet.ServletException

org.springframework.web.bind.ServletRequestBindingException

org.springframework.web.bind.MissingRequestValueException

org.springframework.web.bind.MissingRequestHeaderException

All Implemented Interfaces:

Serializable, ErrorResponse

public class MissingRequestHeaderException
extends MissingRequestValueException

ServletRequestBindingException subclass that indicates that a request header expected in the method parameters of an @RequestMapping method is not present.

Since:

5.1

Author:

Juergen Hoeller

See Also:

• MissingRequestCookieException
• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface ErrorResponse

ErrorResponse.Builder, ErrorResponse.Interceptor

Constructor Summary

Constructors

Constructor	Description
MissingRequestHeaderException(String headerName, MethodParameter parameter)	Constructor for MissingRequestHeaderException.
MissingRequestHeaderException(String headerName, MethodParameter parameter, boolean missingAfterConversion)	Constructor for use when a value was present but converted to null.

Method Summary

Modifier and Type	Method	Description
final String	getHeaderName()	Return the expected name of the request header.
String	getMessage()
final MethodParameter	getParameter()	Return the method parameter bound to the request header.

Methods inherited from class MissingRequestValueException

isMissingAfterConversion

Methods inherited from class ServletRequestBindingException

getBody, getDetailMessageArguments, getDetailMessageCode, getStatusCode

Methods inherited from class jakarta.servlet.ServletException

getRootCause

Methods inherited from class Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ErrorResponse

getDetailMessageArguments, getHeaders, getTitleMessageCode, getTypeMessageCode, updateAndGetBody

Constructor Details

MissingRequestHeaderException

public MissingRequestHeaderException(String headerName,
 MethodParameter parameter)

Constructor for MissingRequestHeaderException.

Parameters:

headerName - the name of the missing request header

parameter - the method parameter

MissingRequestHeaderException

public MissingRequestHeaderException(String headerName,
 MethodParameter parameter,
 boolean missingAfterConversion)

Constructor for use when a value was present but converted to null.

Parameters:

headerName - the name of the missing request header

parameter - the method parameter

missingAfterConversion - whether the value became null after conversion

Since:

5.3.6

Method Details

getMessage

public String getMessage()

Overrides:

getMessage in class Throwable

getHeaderName

public final String getHeaderName()

Return the expected name of the request header.

getParameter

public final MethodParameter getParameter()

Return the method parameter bound to the request header.