Package de.espirit.firstspirit.agency

Interface RunLevelAgent

@NonExtendable
public interface RunLevelAgent

Agent providing information about the current FirstSpirit server RunLevel.

Since:

5.2.181205

Field Summary

Fields

Modifier and Type	Field	Description
static final SpecialistType<RunLevelAgent>	TYPE	Agent providing information about the current FirstSpirit server RunLevel.

Method Summary

Modifier and Type	Method	Description
@NotNull RunLevel	getRunLevel()	Returns the current RunLevel of the FirstSpirit server.
@NotNull RunLevel	waitForRunLevel(@NotNull RunLevel runLevel, @NotNull Duration maxWaitDuration)	Wait until the FirstSpirit server reaches a RunLevel or a timeout occurs.

Field Details

TYPE

static final SpecialistType<RunLevelAgent> TYPE

Agent providing information about the current FirstSpirit server RunLevel. The agent's technical type can be used to request the agent from a SpecialistsBroker.

Since:

5.2.181205

Method Details

getRunLevel

@NotNull
@NotNull RunLevel getRunLevel()

Returns the current RunLevel of the FirstSpirit server.

Since:

5.2.181205

waitForRunLevel

@NotNull
@NotNull RunLevel waitForRunLevel(@NotNull
 @NotNull RunLevel runLevel,
 @NotNull
 @NotNull Duration maxWaitDuration)
                           throws TimeoutException

Wait until the FirstSpirit server reaches a RunLevel or a timeout occurs.

Parameters:

runLevel - The minimum RunLevel to wait for.

maxWaitDuration - The maximum Duration to wait for the RunLevel.

Returns:

The reached RunLevel which is at least the wanted RunLevel and may be a higher RunLevel.

Throws:

TimeoutException - Thrown if the RunLevel was not reached within the maximum waiting time.

Since:

5.2.181205