com.hcl.voltmx.middleware.api

Enum OperationSecurityLevel

java.lang.Object

java.lang.Enum<OperationSecurityLevel>

com.hcl.voltmx.middleware.api.OperationSecurityLevel

All Implemented Interfaces:

Serializable, Comparable<OperationSecurityLevel>

public enum OperationSecurityLevel
extends Enum<OperationSecurityLevel>

The operation security level.

Since:

Foundry V9 (9.0) release

Enum Constant Summary

Enum Constants

Enum Constant and Description
ANONYMOUS_APP_USER Only clients with the App Key and App Secret of the app linked to this operation can access it.
AUTHENTICATED_APP_USER Only clients authenticated with Identity Service linked to this operation can access it.
PRIVATE No client can access this operation.
PUBLIC All clients can access this operation without any authentication.

Method Summary

Modifier and Type	Method and Description
static OperationSecurityLevel	fromString(String securityName) Returns the OperationSecurityLevel corresponding to the given string.
String	getSecurityName() Gets the underline security name.
static boolean	isAnonymousAppUser(String securityName) Returns true if the given security name is ANONYMOUS_APP_USER operation.
static boolean	isAuthenticatedAppUser(String securityName) Returns true if the given security name is AUTHENTICATED_APP_USER operation or an invalid value.
static boolean	isPrivate(String securityName) Returns true if the given security name is PRIVATE operation.
static boolean	isPublic(String securityName) Returns true if the given security name is PUBLIC operation.
static OperationSecurityLevel	valueOf(String name) Returns the enum constant of this type with the specified name.
static OperationSecurityLevel[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

PUBLIC

public static final OperationSecurityLevel PUBLIC

All clients can access this operation without any authentication.

ANONYMOUS_APP_USER

public static final OperationSecurityLevel ANONYMOUS_APP_USER

Only clients with the App Key and App Secret of the app linked to this operation can access it.

AUTHENTICATED_APP_USER

public static final OperationSecurityLevel AUTHENTICATED_APP_USER

Only clients authenticated with Identity Service linked to this operation can access it.

PRIVATE

public static final OperationSecurityLevel PRIVATE

No client can access this operation. The operation can only be accessed internally from server via another service or custom code.

Method Detail

values

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

Returns:

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

valueOf

public static OperationSecurityLevel 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

getSecurityName

public String getSecurityName()

Gets the underline security name.

Returns:

The underline security name

fromString

public static OperationSecurityLevel fromString(String securityName)

Returns the OperationSecurityLevel corresponding to the given string. If no match then returns OperationSecurityLevel.AUTHENTICATED_APP_USER.

Parameters:

securityName - The security name

Returns:

The OperationSecurityLevel corresponding to the given string

isPublic

public static boolean isPublic(String securityName)

Returns true if the given security name is PUBLIC operation.

Parameters:

securityName - The security name

Returns:

True if the given security name is PUBLIC operation, false otherwise.

isAnonymousAppUser

public static boolean isAnonymousAppUser(String securityName)

Returns true if the given security name is ANONYMOUS_APP_USER operation.

Parameters:

securityName - The security name

Returns:

True if the given security name is ANONYMOUS_APP_USER operation, false otherwise.

isPrivate

public static boolean isPrivate(String securityName)

Returns true if the given security name is PRIVATE operation.

Parameters:

securityName - The security name

Returns:

True if the given security name is PRIVATE operation, false otherwise.

isAuthenticatedAppUser

public static boolean isAuthenticatedAppUser(String securityName)

Returns true if the given security name is AUTHENTICATED_APP_USER operation or an invalid value.

Parameters:

securityName - The security name

Returns:

True if the given security name is AUTHENTICATED_APP_USER operation or an invalid value, false otherwise.