org.jboss.as.domain.http.server

Class ConsoleAvailabilityService

java.lang.Object

org.jboss.as.domain.http.server.ConsoleAvailabilityService

All Implemented Interfaces:

PropertyChangeListener, EventListener, ConsoleAvailability, org.jboss.msc.Service

public final class ConsoleAvailabilityService
extends Object
implements org.jboss.msc.Service, ConsoleAvailability, PropertyChangeListener

Exposes a ConsoleAvailability to check the availability of the web console.

By default the console is not available, this service listen to changes in the process controller state. The web console is available as soon as the process controller transitions to running. This service allows to make the console available even before than the process controller is running by using setAvailable() method.

Author:

@author Yeray Borges

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ConsoleAvailabilityService.LogAdminConsole

Field Summary

Fields inherited from interface org.jboss.msc.Service

NULL

Fields inherited from interface org.jboss.as.domain.http.server.ConsoleAvailability

CONSOLE_AVAILABILITY_CAPABILITY

Constructor Summary

Constructors

Constructor and Description
ConsoleAvailabilityService(Consumer<ConsoleAvailability> serviceConsumer, Supplier<ProcessStateNotifier> notifier, ConsoleAvailabilityService.LogAdminConsole logMessageAction)

Method Summary

Modifier and Type	Method and Description
static void	addService(org.jboss.msc.service.ServiceTarget serviceTarget, ConsoleAvailabilityService.LogAdminConsole logMessageAction)
boolean	isAvailable() Gets the availability of the web console.
void	propertyChange(PropertyChangeEvent evt)
void	setAvailable() Tries to make the console available.
void	start(org.jboss.msc.service.StartContext context)
void	stop(org.jboss.msc.service.StopContext context)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.jboss.msc.Service

newInstance

Constructor Detail

ConsoleAvailabilityService

public ConsoleAvailabilityService(Consumer<ConsoleAvailability> serviceConsumer,
                                  Supplier<ProcessStateNotifier> notifier,
                                  ConsoleAvailabilityService.LogAdminConsole logMessageAction)

Method Detail

addService

public static void addService(org.jboss.msc.service.ServiceTarget serviceTarget,
                              ConsoleAvailabilityService.LogAdminConsole logMessageAction)

start

public void start(org.jboss.msc.service.StartContext context)
           throws org.jboss.msc.service.StartException

Specified by:

start in interface org.jboss.msc.Service

Throws:

org.jboss.msc.service.StartException

stop

public void stop(org.jboss.msc.service.StopContext context)

Specified by:

stop in interface org.jboss.msc.Service

isAvailable

public boolean isAvailable()

Gets the availability of the web console.

Specified by:

isAvailable in interface ConsoleAvailability

Returns:

Whether the console is available at this moment.

setAvailable

public void setAvailable()

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

Specified by:

setAvailable in interface ConsoleAvailability

propertyChange

public void propertyChange(PropertyChangeEvent evt)

Specified by:

propertyChange in interface PropertyChangeListener