org.jboss.as.domain.http.server

Interface ConsoleAvailability

All Known Implementing Classes:

ConsoleAvailabilityService

public interface ConsoleAvailability

Allows callers to check the availability of the web console.

By default, the web console is not available until the process controller transitions to RUNNING. The callers can try to make the console available even before by using the isAvailable() method.

Author:

Yeray Borges

Field Summary

Fields

Modifier and Type	Field and Description
static RuntimeCapability<Void>	CONSOLE_AVAILABILITY_CAPABILITY Capability users of the controller use to read the web console availability and force it to make it available before the process controller is in RUNNING state.

Method Summary

Modifier and Type	Method and Description
boolean	isAvailable() Gets the availability of the web console.
void	setAvailable() Tries to make the console available.

Field Detail

CONSOLE_AVAILABILITY_CAPABILITY

static final RuntimeCapability<Void> CONSOLE_AVAILABILITY_CAPABILITY

Capability users of the controller use to read the web console availability and force it to make it available before the process controller is in RUNNING state. This capability isn't necessarily directly related to this class but we declare it here as it's as good a place as any at this time.

Method Detail

isAvailable

boolean isAvailable()

Gets the availability of the web console.

Returns:

Whether the console is available at this moment.

setAvailable

void setAvailable()

Tries to make the console available. The console will be available only if the process controller is not stopping.