Package de.espirit.firstspirit.access.schedule

Enum Class MaintenanceModeTask.MaintenanceStage

java.lang.Object

java.lang.Enum<MaintenanceModeTask.MaintenanceStage>

de.espirit.firstspirit.access.schedule.MaintenanceModeTask.MaintenanceStage

All Implemented Interfaces:

Serializable, Comparable<MaintenanceModeTask.MaintenanceStage>, Constable

Enclosing interface:

MaintenanceModeTask

public static enum MaintenanceModeTask.MaintenanceStage
extends Enum<MaintenanceModeTask.MaintenanceStage>

A maintenance mode task consists of up to five stages, from an initial preparation period up to activating the actual maintenance mode. Stages with a duration of 0 are skipped. The ordering of this enum represents the actual processing order of stages during execution.

Since:

5.2.516

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
DISPLAY_MESSAGE	Display an informational message containing the starting time and duration of the maintenance mode.
DISPLAY_SESSION_WARNING	Display a warning encouraging users to quit their sessions.
MAINTENANCE_MODE_ACTIVE	The maintenance mode is active.
PREPARATION	The planned maintenance mode will be listed in the server monitoring, but at this time, users will not be notified.
REJECT_NEW_SESSIONS	It is not possible to connect to the server or the selected projects anymore.

Method Summary

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

PREPARATION

public static final MaintenanceModeTask.MaintenanceStage PREPARATION

The planned maintenance mode will be listed in the server monitoring, but at this time, users will not be notified.

The default duration is 30 minutes.

Since:

5.2.516

DISPLAY_MESSAGE

public static final MaintenanceModeTask.MaintenanceStage DISPLAY_MESSAGE

Display an informational message containing the starting time and duration of the maintenance mode.

The default duration is 15 minutes.

Since:

5.2.516

See Also:

• MaintenanceModeTask.setMessageDisplayType(MessageDisplayType)

DISPLAY_SESSION_WARNING

public static final MaintenanceModeTask.MaintenanceStage DISPLAY_SESSION_WARNING

Display a warning encouraging users to quit their sessions.

The default duration is 5 minutes.

Since:

5.2.516

REJECT_NEW_SESSIONS

public static final MaintenanceModeTask.MaintenanceStage REJECT_NEW_SESSIONS

It is not possible to connect to the server or the selected projects anymore. The duration must not be 0.

The default duration is 5 minutes.

Since:

5.2.516

MAINTENANCE_MODE_ACTIVE

public static final MaintenanceModeTask.MaintenanceStage MAINTENANCE_MODE_ACTIVE

The maintenance mode is active. At the beginning of this stage, existing sessions will be disconnected if MaintenanceModeTask.getDisconnectMode() is MaintenanceModeTask.DisconnectMode.DISCONNECT_SESSIONS. The duration must not be 0.

The default duration is 15 minutes.

Since:

5.2.516

See Also:

• MaintenanceModeTask.setDisconnectMode(DisconnectMode)

Method Details

values

public static MaintenanceModeTask.MaintenanceStage[] 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 MaintenanceModeTask.MaintenanceStage 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