com.netflix.governator.lifecycle

Class LifecycleManager

java.lang.Object

com.netflix.governator.lifecycle.LifecycleManager

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class LifecycleManager
extends java.lang.Object
implements java.io.Closeable

Main instance management container

Constructor Summary

Constructors

Constructor and Description
LifecycleManager()
LifecycleManager(LifecycleManagerArguments arguments)
LifecycleManager(LifecycleManagerArguments arguments, com.google.inject.Injector injector)

Method Summary

Methods

Modifier and Type	Method and Description
void	add(java.lang.Object... objects) Add the objects to the container.
void	add(java.lang.Object obj) Add the object to the container.
void	add(java.lang.Object obj, LifecycleMethods methods) Add the object to the container.
void	close()
DAGManager	getDAGManager()
java.util.Collection<LifecycleListener>	getListeners() Return the lifecycle listener if any
LifecycleState	getState(java.lang.Object obj) Return the current state of the given object or LATENT if unknown
boolean	hasStarted() Returns true if the lifecycle has started (i.e.
void	start() The manager MUST be started.
boolean	start(long maxWait, java.util.concurrent.TimeUnit unit) The manager MUST be started.
void	validate() Run the validations on the managed objects.
void	validate(java.lang.Object obj) Run validations on the given object

Methods inherited from class java.lang.Object

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

Constructor Detail

LifecycleManager

public LifecycleManager()

LifecycleManager

public LifecycleManager(LifecycleManagerArguments arguments)

LifecycleManager

@Inject
public LifecycleManager(LifecycleManagerArguments arguments,
                       com.google.inject.Injector injector)

Method Detail

getListeners

public java.util.Collection<LifecycleListener> getListeners()

Return the lifecycle listener if any

Returns:

listener or null

add

public void add(java.lang.Object... objects)
         throws java.lang.Exception

Add the objects to the container. Their assets will be loaded, post construct methods called, etc.

Parameters:

objects - objects to add

Throws:

java.lang.Exception - errors

add

public void add(java.lang.Object obj)
         throws java.lang.Exception

Add the object to the container. Its assets will be loaded, post construct methods called, etc.

Parameters:

obj - object to add

Throws:

java.lang.Exception - errors

add

public void add(java.lang.Object obj,
       LifecycleMethods methods)
         throws java.lang.Exception

Add the object to the container. Its assets will be loaded, post construct methods called, etc. This version helps performance when the lifecycle methods have already been calculated

Parameters:

obj - object to add

methods - calculated lifecycle methods

Throws:

java.lang.Exception - errors

hasStarted

public boolean hasStarted()

Returns true if the lifecycle has started (i.e. start() has been called).

Returns:

true/false

getState

public LifecycleState getState(java.lang.Object obj)

Return the current state of the given object or LATENT if unknown

Parameters:

obj - object to check

Returns:

state

start

public void start()
           throws java.lang.Exception

The manager MUST be started. Note: this method waits indefinitely for warm up methods to complete

Throws:

java.lang.Exception - errors

start

public boolean start(long maxWait,
            java.util.concurrent.TimeUnit unit)
              throws java.lang.Exception

The manager MUST be started. This version of start() has a maximum wait period for warm up methods.

Parameters:

maxWait - maximum wait time for warm up methods - if the time elapses, the warm up methods are interrupted

unit - time unit

Returns:

true if warm up methods successfully executed, false if the time elapses

Throws:

java.lang.Exception - errors

close

public void close()

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

validate

public void validate()
              throws ValidationException

Run the validations on the managed objects. This is done automatically when start() is called. But you can call this at any time you need.

Throws:

ValidationException

validate

public void validate(java.lang.Object obj)
              throws ValidationException

Run validations on the given object

Parameters:

obj - the object to validate

Throws:

ValidationException

getDAGManager

public DAGManager getDAGManager()

Returns:

the internal DAG manager