Package org.jboss.modcluster.config.impl

Enum SessionDrainingStrategyEnum

java.lang.Object

java.lang.Enum<SessionDrainingStrategyEnum>

org.jboss.modcluster.config.impl.SessionDrainingStrategyEnum

All Implemented Interfaces:

Serializable, Comparable<SessionDrainingStrategyEnum>, java.lang.constant.Constable, SessionDrainingStrategy

public enum SessionDrainingStrategyEnum
extends Enum<SessionDrainingStrategyEnum>
implements SessionDrainingStrategy

Author:

Paul Ferraro

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
ALWAYS	Always drain sessions
DEFAULT	Drain sessions only if the target context is non-distributable, i.e.
NEVER	Never drain sessions

Method Summary

Modifier and Type	Method	Description
boolean	isEnabled(Context context)	Indicates whether or not to drain sessions prior to stopping the specified context.
static SessionDrainingStrategyEnum	valueOf(String name)	Returns the enum constant of this type with the specified name.
static SessionDrainingStrategyEnum[]	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, 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

DEFAULT

public static final SessionDrainingStrategyEnum DEFAULT

Drain sessions only if the target context is non-distributable, i.e. its sessions are not replicated

ALWAYS

public static final SessionDrainingStrategyEnum ALWAYS

Always drain sessions

NEVER

public static final SessionDrainingStrategyEnum NEVER

Never drain sessions

Method Details

values

public static SessionDrainingStrategyEnum[] values()

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

Returns:

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

valueOf

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

isEnabled

public boolean isEnabled(Context context)

Description copied from interface: SessionDrainingStrategy

Indicates whether or not to drain sessions prior to stopping the specified context.

Specified by:

isEnabled in interface SessionDrainingStrategy

Parameters:

context - a web application context

Returns:

true, if sessions draining is enabled, false otherwise

See Also:

• SessionDrainingStrategy.isEnabled(org.jboss.modcluster.container.Context)