org.springframework.boot.actuate.autoconfigure.cloudfoundry

Enum AccessLevel

java.lang.Object

java.lang.Enum<AccessLevel>

org.springframework.boot.actuate.autoconfigure.cloudfoundry.AccessLevel

All Implemented Interfaces:

Serializable, Comparable<AccessLevel>

public enum AccessLevel
extends Enum<AccessLevel>

The specific access level granted to the cloud foundry user that's calling the endpoints.

Since:

2.0.0

Author:

Madhura Bhave

Enum Constant Summary

Enum Constants

Enum Constant and Description
FULL Full access to all endpoints.
RESTRICTED Restricted access to a limited set of endpoints.

Field Summary

Fields

Modifier and Type	Field and Description
static String	REQUEST_ATTRIBUTE

Method Summary

Modifier and Type	Method and Description
boolean	isAccessAllowed(String endpointPath) Returns if the access level should allow access to the specified endpoint path.
static AccessLevel	valueOf(String name) Returns the enum constant of this type with the specified name.
static AccessLevel[]	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

RESTRICTED

public static final AccessLevel RESTRICTED

Restricted access to a limited set of endpoints.

FULL

public static final AccessLevel FULL

Full access to all endpoints.

Field Detail

REQUEST_ATTRIBUTE

public static final String REQUEST_ATTRIBUTE

See Also:

Constant Field Values

Method Detail

values

public static AccessLevel[] 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 (AccessLevel c : AccessLevel.values())
    System.out.println(c);

Returns:

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

valueOf

public static AccessLevel valueOf(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:

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

NullPointerException - if the argument is null

isAccessAllowed

public boolean isAccessAllowed(String endpointPath)

Returns if the access level should allow access to the specified endpoint path.

Parameters:

endpointPath - the endpoint path

Returns:

true if access is allowed