org.apache.aries.quiesce.manager
Interface QuiesceManager

public interface QuiesceManager

Interface for the quiesce manager. A quiesce manager provides the functionality to stop bundles in such a manner that currently running work can be safely finished. To exploit this above the quiesce manager individual containers / extenders (such as blueprint, jpa etc) need to quiesce aware and register QuiesceParticipant appropriately.

Method Summary

void	quiesce(List<Bundle> bundlesToQuiesce) Request a collection of bundles to be quiesced using the default timeout
void	quiesce(long timeout, List<Bundle> bundlesToQuiesce) Request a collection of bundles to be quiesced
Future<?>	quiesceWithFuture(List<Bundle> bundlesToQuiesce) Request a collection of bundles to be quiesced like quiesce(long, List<Bundle>) return a Future that the caller can block on instead of void
Future<?>	quiesceWithFuture(long timeout, List<Bundle> bundlesToQuiesce) Request a collection of bundles to be quiesced like quiesce(long, List<Bundle>) return a Future that the caller can block on instead of void

Method Detail

quiesce

void quiesce(long timeout,
             List<Bundle> bundlesToQuiesce)

Request a collection of bundles to be quiesced

Parameters:

timeout - time to wait (in milliseconds) for all the quiesce participants to finish before stopping the bundles. If some quiesce participants do not finish within the given timeout the bundles are stopped regardless at the timeout

bundlesToQuiesce -

quiesce

void quiesce(List<Bundle> bundlesToQuiesce)

Request a collection of bundles to be quiesced using the default timeout

Parameters:

bundlesToQuiesce -

quiesceWithFuture

Future<?> quiesceWithFuture(List<Bundle> bundlesToQuiesce)

Request a collection of bundles to be quiesced like quiesce(long, List<Bundle>) return a Future that the caller can block on instead of void

Parameters:

bundlesToQuiesce -

Returns:

a Future that captures the execution of quiesce. The returned Future does not support the cancel operation.

quiesceWithFuture

Future<?> quiesceWithFuture(long timeout,
                            List<Bundle> bundlesToQuiesce)

Request a collection of bundles to be quiesced like quiesce(long, List<Bundle>) return a Future that the caller can block on instead of void

Parameters:

timeout - time to wait (in milliseconds) for all the quiesce participants to finish before stopping the bundles. If some quiesce participants do not finish within the given timeout the bundles are stopped regardless at the timeout

bundlesToQuiesce -

Returns:

a Future that captures the execution of quiesce. The returned Future does not support the cancel operation.