Package org.eclipse.hono.auth

Enum Class Activity

java.lang.Object

java.lang.Enum<Activity>

org.eclipse.hono.auth.Activity

All Implemented Interfaces:

Serializable, Comparable<Activity>, Constable

public enum Activity
extends Enum<Activity>

Defines permissions that are required to access Hono service resources.

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
EXECUTE	Permission required for executing an operation on a node.
READ	Permission required for receiving message from a node.
WRITE	Permission required for sending messages to a node.

Method Summary

Modifier and Type	Method	Description
char	getCode()	Gets the single character representation for this activity.
static Activity	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Activity[]	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

READ

public static final Activity READ

Permission required for receiving message from a node.

WRITE

public static final Activity WRITE

Permission required for sending messages to a node.

EXECUTE

public static final Activity EXECUTE

Permission required for executing an operation on a node.

Method Details

values

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

getCode

public char getCode()

Gets the single character representation for this activity.

Returns:

The first character of this activity's name.