org.jrebirth.af.core.service

Class AbstractService

java.lang.Object

org.jrebirth.af.core.link.AbstractReady<R>

org.jrebirth.af.core.link.AbstractWaveReady<Service>

org.jrebirth.af.core.service.AbstractService

All Implemented Interfaces:

FacadeReady<Service>, WaveReady<Service>, CommandReady, LinkMessages, ModelReady, ServiceReady, MessageContainer, Service, ServiceMessages

Direct Known Subclasses:

DefaultService

public abstract class AbstractService
extends AbstractWaveReady<Service>
implements Service, ServiceMessages

The class ServiceBase. Base implementation of the service.

Author:

Sébastien Bordes

Property Summary

Properties

Type	Property and Description
ObservableMap<String,ServiceTask<?>>	pendingTasks Return The Pending tasks map.

Field Summary

Fields

Modifier and Type	Field and Description
private static JRLogger	LOGGER The class logger.
private ObservableMap<String,ServiceTask<?>>	pendingTasks The map that stores pending tasks, useful to access to Worker implementation.
private static String	RATIO_SEPARATOR The string used to separate the workdone and total work of a service task.

Fields inherited from class org.jrebirth.af.core.link.AbstractWaveReady

PROCESS_WAVE_METHOD_NAME

Fields inherited from interface org.jrebirth.af.core.service.ServiceMessages

COUNT_LINES_ERROR, NO_RETURN_WAVE_CONSUMED, NO_RETURNED_WAVE_ITEM, NO_RETURNED_WAVE_TYPE_DEFINED, NO_WAVE_TYPE_DEFINED, SERVICE_TASK_ERROR, SERVICE_TASK_HAS_FAILED, SERVICE_TASK_RETURN_CONSUMES

Fields inherited from interface org.jrebirth.af.core.link.LinkMessages

CALL_ANNOTATED_METHOD_ERROR, COMMAND_NOT_FOUND_ERROR, COMMAND_NOT_FOUND_MESSAGE, COMPONENT_INJECTION_FAILURE, CUSTOM_METHOD_NOT_FOUND, LISTEN_WAVE_TYPE, MODEL_NOT_FOUND_ERROR, MODEL_NOT_FOUND_MESSAGE, NO_WAVE_LISTENER, NOTIFIER_CONSUMES, SEND_WAVE, SERVICE_NOT_FOUND_ERROR, SERVICE_NOT_FOUND_MESSAGE, UNLISTEN_WAVE_TYPE, USE_DEFAULT_WAVE_HANDLER, WAVE_BEAN_CREATION_ERROR, WAVE_DISPATCH_ERROR, WAVE_HANDLING_ERROR, WAVE_LOST, WAVE_LOST_CONTEXT, WAVE_SENDING_ERROR

Constructor Summary

Constructors

Constructor and Description
AbstractService()

Method Summary

Methods

Modifier and Type	Method and Description
private void	bindMessage(ServiceTask<?> task, StringProperty messageProperty) Bind a task to a string property that will display the task message.
private void	bindProgressBar(ServiceTask<?> task, ProgressBar progressBar) Bind a task to a progress bar widget to follow its progression.
private void	bindTitle(ServiceTask<?> task, StringProperty titleProperty) Bind a task to a string property that will display the task title.
protected void	finalize()
ServiceTask<?>	getPendingTask(String taskKey) Retrieve a task from the pending list.
Collection<ServiceTask<?>>	getPendingTaskList() Get pending task list.
protected abstract void	initService() Custom method used to initialize the service.
ObservableMap<String,ServiceTask<?>>	pendingTasksProperty() Return The Pending tasks map.
void	ready() The component is now ready to do custom initialization tasks.
void	removePendingTask(String taskKey) Remove a task from the pending list.
<T> ServiceTask<T>	returnData(Wave sourceWave) Do a specific action by processing the wave.
private <T> ServiceTask<T>	runTask(Wave sourceWave, Method method, Object[] parameterValues) Run the wave type method.
void	updateMessage(Wave wave, String message) Update the current message of the service task related to the given wave.
void	updateProgress(Wave wave, double workDone, double totalWork) Update the progress of the service task related to the given wave.
void	updateProgress(Wave wave, double workDone, double totalWork, double progressIncrement) Update the progress of the service task related to the given wave.
void	updateProgress(Wave wave, long workDone, long totalWork) Update the progress of the service task related to the given wave.
void	updateProgress(Wave wave, long workDone, long totalWork, double progressIncrement) Update the progress of the service task related to the given wave.
void	updateTitle(Wave wave, String title) Update the current message of the service task related to the given wave.

Methods inherited from class org.jrebirth.af.core.link.AbstractWaveReady

attachUi, callCommand, callCommand, getReturnCommand, getReturnWaveType, listen, listen, listen, processWave, registerCallback, registerCallback, registerCallback, release, returnData, sendWave, sendWave, setup, unlisten

Methods inherited from class org.jrebirth.af.core.link.AbstractReady

getCommand, getFirstKeyPart, getKey, getListKeyPart, getLocalFacade, getModel, getSecondKeyPart, getService, getThirdKeyPart, setKey, setLocalFacade

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jrebirth.af.core.facade.WaveReady

getReturnCommand, getReturnWaveType, listen, listen, listen, registerCallback, registerCallback, registerCallback, sendWave, sendWave, unlisten

Methods inherited from interface org.jrebirth.af.core.facade.FacadeReady

getKey, getLocalFacade, release, setKey, setLocalFacade, setup

Methods inherited from interface org.jrebirth.af.core.link.ModelReady

attachUi, getModel

Methods inherited from interface org.jrebirth.af.core.link.ServiceReady

getService, returnData

Methods inherited from interface org.jrebirth.af.core.link.CommandReady

callCommand, callCommand, getCommand

Property Detail

pendingTasks

Return The Pending tasks map.
Key is the wave UID, value is the ServiceTask

Specified by:

pendingTasksProperty in interface Service

Returns:

the pending tasks map

Field Detail

RATIO_SEPARATOR

private static final String RATIO_SEPARATOR

The string used to separate the workdone and total work of a service task.

See Also:

Constant Field Values

LOGGER

private static final JRLogger LOGGER

The class logger.

pendingTasks

private final ObservableMap<String,ServiceTask<?>> pendingTasks

The map that stores pending tasks, useful to access to Worker implementation.

Constructor Detail

AbstractService

public AbstractService()

Method Detail

ready

public final void ready()
                 throws CoreException

The component is now ready to do custom initialization tasks.

Specified by:

ready in class AbstractWaveReady<Service>

Throws:

CoreException - if an error occurred

initService

protected abstract void initService()

Custom method used to initialize the service. Called into JIT by ready method.

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable

returnData

public <T> ServiceTask<T> returnData(Wave sourceWave)

Do a specific action by processing the wave.

Specified by:

returnData in interface Service

Type Parameters:

T - The type of the object to return must be compatible with the WaveType contract that call this service

Parameters:

sourceWave - the wave that hold all related data

Returns:

the service task created that will perform the job

runTask

private <T> ServiceTask<T> runTask(Wave sourceWave,
                         Method method,
                         Object[] parameterValues)

Run the wave type method.

Type Parameters:

T - the type of the returned type

Parameters:

sourceWave - the source wave

parameterValues - values to pass to the method

method - method to call

Returns:

the service task created

bindProgressBar

private void bindProgressBar(ServiceTask<?> task,
                   ProgressBar progressBar)

Bind a task to a progress bar widget to follow its progression.

Parameters:

task - the service task that we need to follow the progression

progressBar - graphical progress bar

bindTitle

private void bindTitle(ServiceTask<?> task,
             StringProperty titleProperty)

Bind a task to a string property that will display the task title.

Parameters:

task - the service task that we need to follow the progression

titleProperty - the title presenter

bindMessage

private void bindMessage(ServiceTask<?> task,
               StringProperty messageProperty)

Bind a task to a string property that will display the task message.

Parameters:

task - the service task that we need to follow the progression

messageProperty - the message presenter

pendingTasksProperty

public ObservableMap<String,ServiceTask<?>> pendingTasksProperty()

Return The Pending tasks map.
Key is the wave UID, value is the ServiceTask

Specified by:

pendingTasksProperty in interface Service

Returns:

the pending tasks map

getPendingTaskList

public Collection<ServiceTask<?>> getPendingTaskList()

Get pending task list.

Specified by:

getPendingTaskList in interface Service

Returns:

the list of pending tasks

removePendingTask

public void removePendingTask(String taskKey)

Remove a task from the pending list.

Specified by:

removePendingTask in interface Service

Parameters:

taskKey - the key of the task, commonly the WaveUID

getPendingTask

public ServiceTask<?> getPendingTask(String taskKey)

Retrieve a task from the pending list.

Specified by:

getPendingTask in interface Service

Parameters:

taskKey - the key of the task, commonly the WaveUID

Returns:

the pending task for the given key (basically the Wave UID)

updateProgress

public void updateProgress(Wave wave,
                  long workDone,
                  long totalWork)

Update the progress of the service task related to the given wave. This method will use a 1.0 block increment

Parameters:

wave - the wave that trigger the service task call

workDone - the amount of overall work done

totalWork - the amount of total work to do

updateProgress

public void updateProgress(Wave wave,
                  long workDone,
                  long totalWork,
                  double progressIncrement)

Update the progress of the service task related to the given wave.

Parameters:

wave - the wave that trigger the service task call

workDone - the amount of overall work done

totalWork - the amount of total work to do

progressIncrement - the value increment used to filter useless progress event

updateProgress

public void updateProgress(Wave wave,
                  double workDone,
                  double totalWork)

Update the progress of the service task related to the given wave. This method will use a 1.0 block increment

Parameters:

wave - the wave that trigger the service task call

workDone - the amount of overall work done

totalWork - the amount of total work to do

updateProgress

public void updateProgress(Wave wave,
                  double workDone,
                  double totalWork,
                  double progressIncrement)

Update the progress of the service task related to the given wave.

Parameters:

wave - the wave that trigger the service task call

workDone - the amount of overall work done

totalWork - the amount of total work to do

progressIncrement - the value increment used to filter useless progress event

updateMessage

public void updateMessage(Wave wave,
                 String message)

Update the current message of the service task related to the given wave.

Parameters:

wave - the wave that trigger the service task call

message - the current message of the service task processed

updateTitle

public void updateTitle(Wave wave,
               String title)

Update the current message of the service task related to the given wave.

Parameters:

wave - the wave that trigger the service task call

title - the title of the service task processed