org.nuxeo.runtime.api

Class ServicePassivator

java.lang.Object

org.nuxeo.runtime.api.ServicePassivator

public class ServicePassivator
extends Object

Blocks service accesses in order to run an operation which alter the runtime. That gives a way to prevent service consumers to enter during the shutdown or the reload operation.

The invoke chain is split in the following steps

passivate

intercept service lookup

monitor

monitor service pass-through accesses

await

wait for the runtime being quiet before proceeding

proceed

proceed with the operation and handle termination hook

 ServicePassivator
         .passivate()
         .withQuietDelay(ChronoUnit.SECONDS.getDuration().multipliedBy(20))
         .monitor()
         .withTimeout(ChronoUnit.MINUTES.getDuration().multipliedBy(2))
         .await()
         .proceed(() -> System.out.println("do something"))
         .onFailure(failure -> System.out.println("failed " + failure))
         .onSuccess(() -> System.out.println("succeed"));*
 

Since:

8.1

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ServicePassivator.Monitor Monitors service lookups for stating about quiet status.
static class	ServicePassivator.Passivator Intercepts service lookups for implementing the quiet logic.
static interface	ServicePassivator.RunnableCheckException<X extends Exception>
static interface	ServicePassivator.Termination Terminates the pacification by a success or a failure action and release the lock.
static class	ServicePassivator.Waiter Terminates the chain by running the operation in a passivated context.

Constructor Summary

Constructors

Constructor and Description
ServicePassivator()

Method Summary

Modifier and Type	Method and Description
static ServicePassivator.Passivator	passivate()
static ServicePassivator.Termination	proceed(Duration quiet, Duration timeout, boolean enforce, Runnable runnable)
static <X extends Exception> void	proceed(Duration quiet, Duration timeout, boolean enforce, ServicePassivator.RunnableCheckException<Exception> runnable, Class<X> oftype)

Methods inherited from class java.lang.Object

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

Constructor Detail

ServicePassivator

public ServicePassivator()

Method Detail

passivate

public static ServicePassivator.Passivator passivate()

proceed

public static ServicePassivator.Termination proceed(Duration quiet,
                                                    Duration timeout,
                                                    boolean enforce,
                                                    Runnable runnable)

proceed

public static <X extends Exception> void proceed(Duration quiet,
                                                 Duration timeout,
                                                 boolean enforce,
                                                 ServicePassivator.RunnableCheckException<Exception> runnable,
                                                 Class<X> oftype)
                                          throws X extends Exception

Throws:

X extends Exception