Package org.cyclos.model.system.webservices

Enum RunAs

java.lang.Object

java.lang.Enum<RunAs>

org.cyclos.model.system.webservices.RunAs

All Implemented Interfaces:

Serializable, Comparable<RunAs>, HasMessageKey

public enum RunAs
extends Enum<RunAs>
implements HasMessageKey

Specifies the different ways a custom web service can be ran.

Enum Constant Summary

Enum Constants

Enum Constant	Description
GUEST	The custom web service will be run as guest
GUEST_WITH_AUTHORIZATION	The custom web service will be run as guest but validating the supplied credentials (basic access authentication)
USER	The caller must specify any of the authorizations to find a valid user (access client, user/password/session token)

Method Summary

Modifier and Type	Method	Description
MessageKey	getMessageKey()
static RunAs	valueOf(String name)	Returns the enum constant of this type with the specified name.
static RunAs[]	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

USER

public static final RunAs USER

The caller must specify any of the authorizations to find a valid user (access client, user/password/session token)

GUEST

public static final RunAs GUEST

The custom web service will be run as guest

GUEST_WITH_AUTHORIZATION

public static final RunAs GUEST_WITH_AUTHORIZATION

The custom web service will be run as guest but validating the supplied credentials (basic access authentication)

Method Detail

values

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

Returns:

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

valueOf

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

getMessageKey

public MessageKey getMessageKey()

Specified by:

getMessageKey in interface HasMessageKey