org.cyclos.model.system.scripts

Enum SessionHandlingScriptFunction

java.lang.Object

java.lang.Enum<SessionHandlingScriptFunction>

org.cyclos.model.system.scripts.SessionHandlingScriptFunction

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SessionHandlingScriptFunction>, ScriptFunction, PrefixedEnum

public enum SessionHandlingScriptFunction
extends java.lang.Enum<SessionHandlingScriptFunction>
implements ScriptFunction

Functions for session handling scripts

Author:

luis

Nested Class Summary

Nested classes/interfaces inherited from interface org.cyclos.model.system.scripts.ScriptFunction

ScriptFunction.Mapping

Enum Constant Summary

Enum Constants

Enum Constant and Description
LOGIN Script code to login users (create a new session)
LOGOUT Script code to logout users (invalidate an existing session)
RESOLVE Script code to return the user for a given session
SEARCH Script code to search for connected (logged-in) users

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PREFIX

Method Summary

Modifier and Type	Method and Description
MessageKey	messageKey() Returns a message key to use for this function
java.lang.String	prefix() Returns the prefix used by this class
boolean	required() Returns whether the function is required
static SessionHandlingScriptFunction	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static SessionHandlingScriptFunction[]	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

Methods inherited from interface org.cyclos.model.system.scripts.ScriptFunction

name

Enum Constant Detail

LOGIN

public static final SessionHandlingScriptFunction LOGIN

Script code to login users (create a new session)

LOGOUT

public static final SessionHandlingScriptFunction LOGOUT

Script code to logout users (invalidate an existing session)

RESOLVE

public static final SessionHandlingScriptFunction RESOLVE

Script code to return the user for a given session

SEARCH

public static final SessionHandlingScriptFunction SEARCH

Script code to search for connected (logged-in) users

Field Detail

PREFIX

public static final java.lang.String PREFIX

See Also:

Constant Field Values

Method Detail

values

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

Returns:

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

valueOf

public static SessionHandlingScriptFunction valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

messageKey

public MessageKey messageKey()

Description copied from interface: ScriptFunction

Returns a message key to use for this function

Specified by:

messageKey in interface ScriptFunction

prefix

public java.lang.String prefix()

Description copied from interface: PrefixedEnum

Returns the prefix used by this class

Specified by:

prefix in interface PrefixedEnum

required

public boolean required()

Description copied from interface: ScriptFunction

Returns whether the function is required

Specified by:

required in interface ScriptFunction