StabilityMonitor (JBoss Modular Service Container 1.2.0.Beta2 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

JBoss Modular Service Container 1.2.0.Beta2

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.jboss.msc.service
Class StabilityMonitor

java.lang.Object
  org.jboss.msc.service.StabilityMonitor

public final class StabilityMonitor
extends Object
extends Object

A stability detection utility. It can be used to detect if all the registered controllers with StabilityMonitor are in REST state. The following controller substates are considered to be in REST state:

Sample bulk usage:

 Set<ServiceController<?>> controllers = ...
 StabilityMonitor monitor = new StabilityMonitor();
 for (ServiceController<?> controller : controllers) {
    monitor.addController(controller);
 }
 try {
    monitor.awaitStability();
 } finally {
    monitor.clear();
    // since now on the monitor can be reused for another stability detection
 }
 // do something after all the controllers are in REST state

Sample simple usage:

 ServiceController<?> controller = ...
 StabilityMonitor monitor = new StabilityMonitor();
 monitor.addController(controller);
 controller.setMode(REMOVE);
 try {
    monitor.awaitStability();
 } finally {
    monitor.removeController(controller);
 }
 // do something after controller have been removed from container

Author:: David M. Lloyd, Richard Opalka
See Also:: StabilityStatistics

Constructor Summary
`StabilityMonitor()`

Method Summary
`void`	`addController(ServiceController<?> controller)` Register controller with this monitor.
`void`	`awaitStability()` Causes the current thread to wait until the monitor is stable.
`boolean`	`awaitStability(long timeout, TimeUnit unit)` Causes the current thread to wait until the monitor is stable.
`boolean`	`awaitStability(long timeout, TimeUnit unit, Set<? super ServiceController<?>> failed, Set<? super ServiceController<?>> problems)` Causes the current thread to wait until the monitor is stable.
`boolean`	`awaitStability(long timeout, TimeUnit unit, Set<? super ServiceController<?>> failed, Set<? super ServiceController<?>> problems, StabilityStatistics statistics)` Causes the current thread to wait until the monitor is stable.
`boolean`	`awaitStability(long timeout, TimeUnit unit, StabilityStatistics statistics)` Causes the current thread to wait until the monitor is stable.
`void`	`awaitStability(Set<? super ServiceController<?>> failed, Set<? super ServiceController<?>> problems)` Causes the current thread to wait until the monitor is stable.
`void`	`awaitStability(Set<? super ServiceController<?>> failed, Set<? super ServiceController<?>> problems, StabilityStatistics statistics)` Causes the current thread to wait until the monitor is stable.
`void`	`awaitStability(StabilityStatistics statistics)` Causes the current thread to wait until the monitor is stable.
`void`	`clear()` Removes all the registered controllers in this monitor.
`void`	`removeController(ServiceController<?> controller)` Unregister controller with this monitor.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

StabilityMonitor

public StabilityMonitor()

Method Detail

addController

public void addController(ServiceController<?> controller)

Parameters:: controller - to be registered for stability detection.

removeController

public void removeController(ServiceController<?> controller)

Unregister controller with this monitor.

Parameters:: controller - to be unregistered from stability detection.

clear

public void clear()

Removes all the registered controllers in this monitor. The monitor can be later reused for stability detection again.