Package com.zfabrik.workers.worker

Class HomeHandle

java.lang.Object

com.zfabrik.workers.worker.HomeHandle

public abstract class HomeHandle
extends Object

The Home Handle provides ways of interaction with the currently running home layout (see IHomeLayout) from a worker process perspective.

This interface allows to send messages to other worker processes, trigger a synchronization and more.

Field Summary

Fields

Modifier and Type	Field	Description
protected static HomeHandle	instance

Constructor Summary

Constructors

Constructor	Description
HomeHandle()

Method Summary

Modifier and Type	Method	Description
abstract void	broadcastInvalidations(Collection<String> invs, int scope)	post resource invalidations by fully qualified resource names.
abstract List<String>	getLastSynchronizationLog()
abstract IWorkerLease	getWorkerLease()	The worker lease is a way to control a worker's life time beyond a detach situation.
static HomeHandle	instance()
abstract Map<String,Serializable>	sendMessage(Map<String,Serializable> args, long timeout)	send a message.
protected static void	setInstance(HomeHandle h)
abstract void	triggerSynchronization(int scope)
abstract void	triggerVerification()

Methods inherited from class java.lang.Object

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

Field Details

instance

protected static HomeHandle instance

Constructor Details

HomeHandle

public HomeHandle()

Method Details

setInstance

protected static void setInstance(HomeHandle h)

instance

public static HomeHandle instance()

sendMessage

public abstract Map<String,Serializable> sendMessage(Map<String,Serializable> args,
 long timeout)
                                              throws IOException

send a message. See also IWorkerProcess

Parameters:

args -

timeout -

Returns:

Throws:

IOException

triggerSynchronization

public abstract void triggerSynchronization(int scope)
                                     throws IOException

Throws:

IOException

triggerVerification

public abstract void triggerVerification()
                                  throws IOException

Throws:

IOException

getLastSynchronizationLog

public abstract List<String> getLastSynchronizationLog()
                                                throws IOException

Throws:

IOException

broadcastInvalidations

public abstract void broadcastInvalidations(Collection<String> invs,
 int scope)

post resource invalidations by fully qualified resource names. These may be processed asynchronously. If local invalidation is mandatory, local invalidations should be forced additionally

Parameters:

invs -

getWorkerLease

public abstract IWorkerLease getWorkerLease()

The worker lease is a way to control a worker's life time beyond a detach situation. This can be used to implement session based worker life time extension for example.