Package org.springframework.boot.actuate.endpoint

Enum Class Show

java.lang.Object

java.lang.Enum<Show>

org.springframework.boot.actuate.endpoint.Show

All Implemented Interfaces:

Serializable, Comparable<Show>, Constable

public enum Show
extends Enum<Show>

Options for showing data in endpoint responses.

Since:

3.0.0

Author:

Madhura Bhave

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALWAYS	Always show the item in the response.
NEVER	Never show the item in the response.
WHEN_AUTHORIZED	Show the item in the response when accessed by an authorized user.

Method Summary

Modifier and Type	Method	Description
boolean	isShown(boolean unauthorizedResult)	Return if data should be shown when no SecurityContext is available.
boolean	isShown(SecurityContext securityContext, Collection<String> roles)	Return if data should be shown.
static Show	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Show[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NEVER

public static final Show NEVER

Never show the item in the response.

WHEN_AUTHORIZED

public static final Show WHEN_AUTHORIZED

Show the item in the response when accessed by an authorized user.

ALWAYS

public static final Show ALWAYS

Always show the item in the response.

Method Details

values

public static Show[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static Show valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

isShown

public boolean isShown(boolean unauthorizedResult)

Return if data should be shown when no SecurityContext is available.

Parameters:

unauthorizedResult - the result to used for an unauthorized user

Returns:

if data should be shown

isShown

public boolean isShown(SecurityContext securityContext,
 Collection<String> roles)

Return if data should be shown.

Parameters:

securityContext - the security context

roles - the required roles

Returns:

if data should be shown