org.jrebirth.af.core.service

Class AbstractService

java.lang.Object

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

org.jrebirth.af.core.component.basic.AbstractComponent<C>

org.jrebirth.af.core.component.behavior.AbstractBehavioredComponent<Service>

org.jrebirth.af.core.service.AbstractService

All Implemented Interfaces:

Component<Service>, BehavioredComponent<Service>, FacadeReady<Service>, CommandReady, ModelReady, ServiceReady, Service, LinkMessages, MessageContainer, ServiceMessages, JRebirthItems

Direct Known Subclasses:

AbstractRestService, DefaultService

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

The class ServiceBase. Base implementation of the service.

Author:

Sébastien Bordes

Property Summary

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

Field Summary

Fields inherited from class org.jrebirth.af.core.component.basic.AbstractComponent

innerComponentMap, PROCESS_WAVE_METHOD_NAME, rootComponent

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_EXCEPTION, SERVICE_TASK_HANDLE_EXCEPTION, SERVICE_TASK_HAS_FAILED, SERVICE_TASK_NOT_MANAGED_EXCEPTION, SERVICE_TASK_RETURN_CONSUMES, SERVICE_TASK_RETURN_HANDLES

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

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

Fields inherited from interface org.jrebirth.af.core.wave.JRebirthItems

booleanItem, byteItem, characterItem, classItem, doubleItem, exceptionItem, floatItem, integerItem, longItem, shortItem, stringItem, voidItem

Constructor Summary

Constructors

Constructor and Description
AbstractService()

Method Summary

Modifier and Type	Method and Description
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.
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.component.behavior.AbstractBehavioredComponent

addBehavior, addBehavior, getBehavior, getBehaviorData, hasBehavior, manageOptionalData

Methods inherited from class org.jrebirth.af.core.component.basic.AbstractComponent

attachUi, callCommand, callCommand, findInnerComponent, getInnerComponentMap, initInnerComponents, initInternalInnerComponents, listen, listen, listen, processWave, release, returnData, rootComponent, rootComponent, sendWave, sendWave, sendWave, setup, unlisten

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

getCommand, getCommand, getCommands, getCommands, getFirstKeyPart, getKeyPart, getListKeyPart, getModel, getModel, getModels, getModels, getSecondKeyPart, getService, getService, getServices, getServices, getThirdKeyPart, key, key, localFacade, localFacade

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jrebirth.af.api.component.behavior.BehavioredComponent

addBehavior, addBehavior, getBehavior, getBehaviorData, hasBehavior

Methods inherited from interface org.jrebirth.af.api.component.basic.Component

findInnerComponent, listen, listen, listen, rootComponent, rootComponent, sendWave, sendWave, sendWave, unlisten

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

key, key, localFacade, localFacade, release, setup

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

attachUi, getModel, getModel, getModels, getModels

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

getService, getService, getServices, getServices, returnData

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

callCommand, callCommand, getCommand, getCommand, getCommands, getCommands

Property Detail

pendingTasks

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

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 AbstractComponent<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

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

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