Package org.jboss.as.server.suspend

Interface ServerSuspendController

All Superinterfaces:

SuspensionStateProvider

All Known Implementing Classes:

SuspendController

public interface ServerSuspendController
extends SuspensionStateProvider

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	ServerSuspendController.Context

Nested classes/interfaces inherited from interface org.jboss.as.server.suspend.SuspensionStateProvider

SuspensionStateProvider.State

Field Summary

Fields

Modifier and Type	Field	Description
static final org.wildfly.service.descriptor.NullaryServiceDescriptor<ServerSuspendController>	SERVICE_DESCRIPTOR

Method Summary

Modifier and Type	Method	Description
void	addListener(OperationListener listener)	Adds the specified server suspension event listener to this controller.
void	removeListener(OperationListener listener)	Removes the specified server suspension event listener from this controller.
void	reset()	Resets the state of the suspend controller to SuspensionStateProvider.State.SUSPENDED.
CompletionStage<Void>	resume(ServerResumeContext context)	Resumes all registered activity and transitions the controller from SuspensionStateProvider.State.SUSPENDED to SuspensionStateProvider.State.RUNNING.
CompletionStage<Void>	suspend(ServerSuspendContext context)	Suspends all registered activity and Transitions the controller from SuspensionStateProvider.State.RUNNING to SuspensionStateProvider.State.SUSPENDED via the intermediate states: SuspensionStateProvider.State.PRE_SUSPEND and SuspensionStateProvider.State.SUSPENDING

Methods inherited from interface org.jboss.as.server.suspend.SuspensionStateProvider

getState

Field Details

SERVICE_DESCRIPTOR

static final org.wildfly.service.descriptor.NullaryServiceDescriptor<ServerSuspendController> SERVICE_DESCRIPTOR

Method Details

suspend

CompletionStage<Void> suspend(ServerSuspendContext context)

Suspends all registered activity and Transitions the controller from SuspensionStateProvider.State.RUNNING to SuspensionStateProvider.State.SUSPENDED via the intermediate states: SuspensionStateProvider.State.PRE_SUSPEND and SuspensionStateProvider.State.SUSPENDING

Returns:

a completion stage that completes after SuspendableActivity.prepare(ServerSuspendContext) completion, followed by SuspendableActivity.suspend(ServerSuspendContext) completion for all registered activity.

resume

CompletionStage<Void> resume(ServerResumeContext context)

Resumes all registered activity and transitions the controller from SuspensionStateProvider.State.SUSPENDED to SuspensionStateProvider.State.RUNNING.

Returns:

a stage that will complete after SuspendableActivity#cancel(ServerSuspendCancelContext) completion for all registered activity.

reset

void reset()

Resets the state of the suspend controller to SuspensionStateProvider.State.SUSPENDED.

addListener

void addListener(OperationListener listener)

Adds the specified server suspension event listener to this controller.

Parameters:

listener - a server suspension event listener

removeListener

void removeListener(OperationListener listener)

Removes the specified server suspension event listener from this controller.

Parameters:

listener - a server suspension event listener