com.scaleoutsoftware.soss.client

Enum LogoutScope

java.lang.Object

java.lang.Enum<LogoutScope>

com.scaleoutsoftware.soss.client.LogoutScope

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<LogoutScope>

public enum LogoutScope
extends java.lang.Enum<LogoutScope>

Indicates the scope of a logout operation on NamedCache.

Enum Constant Summary

Enum Constants

Enum Constant and Description
Local The user should be logged out from the cache in only the currently running client application.
StoreWide The user should be logged out from the cache in every client application accessing the StateServer store.

Method Summary

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

Local

public static final LogoutScope Local

The user should be logged out from the cache in only the currently running client application.

StoreWide

public static final LogoutScope StoreWide

The user should be logged out from the cache in every client application accessing the StateServer store.

Method Detail

values

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

Returns:

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

valueOf

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