com.netflix.governator

Class LifecycleInjector

java.lang.Object

com.netflix.governator.DelegatingInjector

com.netflix.governator.LifecycleInjector

All Implemented Interfaces:

com.google.inject.Injector

public final class LifecycleInjector
extends DelegatingInjector

Wrapper for Guice's Injector with added shutdown methods. Invoking shutdown from outside the injector

 
    LifecycleInjector injector = new Governator().run();
    // ...
    injector.shutdown();
 
 

Blocking on the injector terminating

 
    LifecycleInjector injector = new Governator().run(;
    // ...
    injector.awaitTermination();
 
 

Triggering shutdown from a DI'd class

 
    @Singleton
    public class SomeShutdownService {
        @Inject
        SomeShutdownService(LifecycleManager lifecycleManager) {
            this.lifecycleManager = lifecycleManager;
        }
      
        void someMethodInvokedForShutdown() {
            this.lifecycleManager.shutdown();
        }
    }
 }
 
 

Triggering an external event from shutdown without blocking

 
    LifecycleInjector injector = new Governator().run(;
    injector.addListener(new LifecycleListener() {
        public void onShutdown() {
            // Do your shutdown handling here
        }
    });
 }
 
 

Method Summary

Methods

Modifier and Type	Method and Description
void	addListener(com.netflix.governator.spi.LifecycleListener listener) Register a single shutdown listener for async notification of the LifecycleManager terminating.
void	awaitTermination() Block until LifecycleManager terminates
static LifecycleInjector	createFailedInjector(LifecycleManager manager)
void	shutdown() Shutdown LifecycleManager on this Injector which will invoke all registered LifecycleListeners and unblock awaitTermination.
static LifecycleInjector	wrapInjector(com.google.inject.Injector injector, LifecycleManager manager)

Methods inherited from class com.netflix.governator.DelegatingInjector

createChildInjector, createChildInjector, findBindingsByType, getAllBindings, getBinding, getBinding, getBindings, getExistingBinding, getInstance, getInstance, getMembersInjector, getMembersInjector, getParent, getProvider, getProvider, getScopeBindings, getTypeConverterBindings, injectMembers

Methods inherited from class java.lang.Object

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

Method Detail

createFailedInjector

public static LifecycleInjector createFailedInjector(LifecycleManager manager)

wrapInjector

public static LifecycleInjector wrapInjector(com.google.inject.Injector injector,
                             LifecycleManager manager)

awaitTermination

public void awaitTermination()
                      throws java.lang.InterruptedException

Block until LifecycleManager terminates

Throws:

java.lang.InterruptedException

shutdown

public void shutdown()

Shutdown LifecycleManager on this Injector which will invoke all registered LifecycleListeners and unblock awaitTermination.

addListener

public void addListener(com.netflix.governator.spi.LifecycleListener listener)

Register a single shutdown listener for async notification of the LifecycleManager terminating.

Parameters:

listener -