Package io.micronaut.http.server

Enum HttpServerConfiguration.ErrorResponseIncludeMessageMode

java.lang.Object

java.lang.Enum<HttpServerConfiguration.ErrorResponseIncludeMessageMode>

io.micronaut.http.server.HttpServerConfiguration.ErrorResponseIncludeMessageMode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<HttpServerConfiguration.ErrorResponseIncludeMessageMode>

Enclosing class:

HttpServerConfiguration

public static enum HttpServerConfiguration.ErrorResponseIncludeMessageMode
extends java.lang.Enum<HttpServerConfiguration.ErrorResponseIncludeMessageMode>

When to include unhandled exception messages in error responses.

Since:

3.10.11

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALWAYS	Always include the exception message.
NEVER	Never include the exception message.
ON_PARAM	Include the exception message when the message request parameter is present and not false.

Method Summary

Modifier and Type	Method	Description
static HttpServerConfiguration.ErrorResponseIncludeMessageMode	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static HttpServerConfiguration.ErrorResponseIncludeMessageMode[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NEVER

public static final HttpServerConfiguration.ErrorResponseIncludeMessageMode NEVER

Never include the exception message.

ALWAYS

public static final HttpServerConfiguration.ErrorResponseIncludeMessageMode ALWAYS

Always include the exception message.

ON_PARAM

public static final HttpServerConfiguration.ErrorResponseIncludeMessageMode ON_PARAM

Include the exception message when the message request parameter is present and not false.

Method Detail

values

public static HttpServerConfiguration.ErrorResponseIncludeMessageMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (HttpServerConfiguration.ErrorResponseIncludeMessageMode c : HttpServerConfiguration.ErrorResponseIncludeMessageMode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static HttpServerConfiguration.ErrorResponseIncludeMessageMode valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null