Package org.springframework.boot.actuate.endpoint

Enum Class Access

java.lang.Object

java.lang.Enum<Access>

org.springframework.boot.actuate.endpoint.Access

All Implemented Interfaces:

Serializable, Comparable<Access>, Constable

public enum Access
extends Enum<Access>

Permitted level of access to an endpoint and its operations.

Since:

3.4.0

Author:

Andy Wilkinson

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
NONE	No access to the endpoint is permitted.
READ_ONLY	Read-only access to the endpoint is permitted.
UNRESTRICTED	Unrestricted access to the endpoint is permitted.

Method Summary

Modifier and Type	Method	Description
Access	cap(Access maxPermitted)	Cap access to a maximum permitted.
static Access	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Access[]	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

NONE

public static final Access NONE

No access to the endpoint is permitted.

READ_ONLY

public static final Access READ_ONLY

Read-only access to the endpoint is permitted.

UNRESTRICTED

public static final Access UNRESTRICTED

Unrestricted access to the endpoint is permitted.

Method Details

values

public static Access[] 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 Access 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

cap

public Access cap(Access maxPermitted)

Cap access to a maximum permitted.

Parameters:

maxPermitted - the maximum permitted access

Returns:

this access if less than the maximum or the maximum permitted