Module io.inverno.mod.web.server

Package io.inverno.mod.web.server

Class MissingRequiredParameterException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

io.inverno.mod.http.base.HttpException

io.inverno.mod.http.base.BadRequestException

io.inverno.mod.web.server.MissingRequiredParameterException

All Implemented Interfaces:

Serializable

public class MissingRequiredParameterException
extends BadRequestException

Thrown to indicates that a required parameter is missing to process the request.

The missing parameter could be any kind of request parameters: a query parameter, a header, a cookie, path parameter...

Since:

1.0

Author:

Jeremy Kuhn

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
MissingRequiredParameterException()	Creates a missing required parameter exception.
MissingRequiredParameterException(String parameterName)	Creates a missing required parameter exception for the specified parameter name.
MissingRequiredParameterException(String parameterName, Throwable cause)	Creates a missing required parameter exception with the specified parameter name and cause.
MissingRequiredParameterException(Throwable cause)	Creates a missing required parameter exception with the specified cause.

Method Summary

Modifier and Type	Method	Description
String	getParameterName()	Returns the name of the missing parameter.

Methods inherited from class io.inverno.mod.http.base.HttpException

getStatus, getStatusCategory, getStatusCode, getStatusReasonPhrase, wrap

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

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

Constructor Details

MissingRequiredParameterException

public MissingRequiredParameterException()

Creates a missing required parameter exception.

MissingRequiredParameterException

public MissingRequiredParameterException(String parameterName)

Creates a missing required parameter exception for the specified parameter name.

Parameters:

parameterName - the name of the missing parameter

MissingRequiredParameterException

public MissingRequiredParameterException(Throwable cause)

Creates a missing required parameter exception with the specified cause.

Parameters:

cause - the cause

MissingRequiredParameterException

public MissingRequiredParameterException(String parameterName,
 Throwable cause)

Creates a missing required parameter exception with the specified parameter name and cause.

Parameters:

parameterName - the name of the missing parameter

cause - the cause

Method Details

getParameterName

public String getParameterName()

Returns the name of the missing parameter.

Returns:

the missing parameter name or null