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>
,SessionDrainingStrategy
public enum SessionDrainingStrategyEnum extends Enum<SessionDrainingStrategyEnum> implements SessionDrainingStrategy
- Author:
- Paul Ferraro
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods 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.
-
-
-
Enum Constant Detail
-
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 Detail
-
values
public static SessionDrainingStrategyEnum[] 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 (SessionDrainingStrategyEnum c : SessionDrainingStrategyEnum.values()) System.out.println(c);
- 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 nameNullPointerException
- 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 interfaceSessionDrainingStrategy
- Parameters:
context
- a web application context- Returns:
- true, if sessions draining is enabled, false otherwise
- See Also:
SessionDrainingStrategy.isEnabled(org.jboss.modcluster.container.Context)
-
-