co.paralleluniverse.common.spring

Class Service

java.lang.Object

co.paralleluniverse.common.spring.Component

co.paralleluniverse.common.spring.Service

All Implemented Interfaces:

org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean

public abstract class Service
extends Component

A component that may have dependencies, and can signal its readiness to its dependents.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Service(String name) Constructs a service with a given name.

Method Summary

Methods

Modifier and Type	Method and Description
void	addDependency(Service service) Adds a service this service depends on.
protected void	available(boolean value) Called when this service becomes available (it is ready and all its dependencies are available) or unavailable.
void	awaitAvailable() Availability changes between calls to this method are the responsibility of the user code, which must be able to handle a short interruption (e.g.
List<String>	getDependedBy()
String	getDependencyGraph()
List<String>	getDependsOn()
protected void	init() Called after bean properties have been set.
boolean	isAvailable()
boolean	isReady()
protected void	postInit() Called after bean properties have been set, and init() called.
protected void	removeDependency(Service service) Removes a dependency.
protected void	setReady(boolean ready) Sets the readiness of this service.

Methods inherited from class co.paralleluniverse.common.spring.Component

afterPropertiesSet, assertDuringInitialization, assertInitialized, destroy, getName, getType, isInitialized, shutdown, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

Service

protected Service(String name)

Constructs a service with a given name.

Parameters:

name - The service's name.

Method Detail

addDependency

public void addDependency(Service service)

Adds a service this service depends on.

Parameters:

service - The service this service depends on.

removeDependency

protected void removeDependency(Service service)

Removes a dependency. This method must be called in the init() method.

Parameters:

service -

getDependedBy

@ManagedAttribute(currencyTimeLimit=0,
                  description="Services that depend on this service")
public List<String> getDependedBy()

getDependsOn

@ManagedAttribute(currencyTimeLimit=0,
                  description="Services this service depends on")
public List<String> getDependsOn()

init

protected void init()
             throws Exception

Description copied from class: Component

Called after bean properties have been set. If a derived class overrides this methid, it must call super.init() before doing anything else in the method.

Overrides:

init in class Component

Throws:

Exception

postInit

protected void postInit()
                 throws Exception

Description copied from class: Component

Called after bean properties have been set, and init() called. If a derived class overrides this method, it must call super.postInit() after doing anything else in the method.

Overrides:

postInit in class Component

Throws:

Exception

available

protected void available(boolean value)

Called when this service becomes available (it is ready and all its dependencies are available) or unavailable.

Parameters:

value - true if this service is now available; false otherwise.

setReady

protected void setReady(boolean ready)

Sets the readiness of this service. If this service is ready and all its dependencies are available, than this service becomes available.

Parameters:

ready -

awaitAvailable

public void awaitAvailable()
                    throws InterruptedException

Availability changes between calls to this method are the responsibility of the user code, which must be able to handle a short interruption (e.g. comm services buffer their messages etc.).

Throws:

InterruptedException

isReady

@ManagedAttribute(currencyTimeLimit=0)
public boolean isReady()

isAvailable

@ManagedAttribute(currencyTimeLimit=0)
public boolean isAvailable()

getDependencyGraph

@ManagedAttribute
public String getDependencyGraph()