com.communote.server.core.tasks

Class ClientTaskHandler

java.lang.Object

com.communote.server.core.tasks.ClientTaskHandler

All Implemented Interfaces:

TaskHandler

Direct Known Subclasses:

DeleteActivitiesTaskHandler, DeleteOrphanedAttachmentsTaskHandler

public abstract class ClientTaskHandler
extends Object
implements TaskHandler

The ClientTaskHandler provides a method runOnClient(TaskTO) that will be executed for each client for a TaskTO. By default all active clients are used, however the behavior can be changed by overwriting checkRunOnClient(ClientTO)

Author:

Communote GmbH - http://communote.com/

Constructor Summary

Constructors

Constructor and Description
ClientTaskHandler()

Method Summary

Modifier and Type	Method and Description
protected boolean	checkRunOnClient(ClientTO client)
protected boolean	checkRunTask(TaskTO task) Check if the task should actually be run.
void	run(TaskTO task) Executes the Task with the given properties.
protected abstract void	runOnClient(TaskTO task) Is called for each client

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.communote.server.api.core.task.TaskHandler

getRescheduleDate

Constructor Detail

ClientTaskHandler

public ClientTaskHandler()

Method Detail

checkRunOnClient

protected boolean checkRunOnClient(ClientTO client)

Parameters:

client - the client to check

Returns:

true if the handle should be run on this client

checkRunTask

protected boolean checkRunTask(TaskTO task)

Check if the task should actually be run. Default implementation just returns true.

Parameters:

task - the task to check

Returns:

true if the task will actually be handled or false to skip

run

public final void run(TaskTO task)
               throws TaskHandlerException

Executes the Task with the given properties.

Specified by:

run in interface TaskHandler

Parameters:

task - The task.

Throws:

TaskHandlerException - Exception.

runOnClient

protected abstract void runOnClient(TaskTO task)
                             throws Exception

Is called for each client

Parameters:

task - the task

Throws:

Exception - in case something goes wrong