Package org.cyclos.impl.system

Class CustomScheduledTaskServiceImpl

java.lang.Object

org.cyclos.impl.AbstractServerComponent

org.cyclos.impl.AbstractNetworkedServerComponent

org.cyclos.impl.BaseServiceImpl

org.cyclos.impl.CRUDServiceImpl<CustomScheduledTask,QCustomScheduledTask,CustomScheduledTaskDTO,CustomScheduledTaskData,Void>

org.cyclos.impl.system.CustomScheduledTaskServiceImpl

All Implemented Interfaces:

ApplicationInitializationListener, BaseApplicationInitializationListener, CRUDServiceLocal<CustomScheduledTask,CustomScheduledTaskDTO,CustomScheduledTaskData,Void>, CustomScheduledTaskServiceLocal, CRUDService<CustomScheduledTaskDTO,CustomScheduledTaskData,Void>, CRUDWithConfirmationPasswordService<CustomScheduledTaskDTO,CustomScheduledTaskData,Void>, Service, CustomScheduledTaskService

@Service
public class CustomScheduledTaskServiceImpl
extends CRUDServiceImpl<CustomScheduledTask,QCustomScheduledTask,CustomScheduledTaskDTO,CustomScheduledTaskData,Void>
implements CustomScheduledTaskServiceLocal, ApplicationInitializationListener

Implementation for CustomScheduledTaskService

Field Summary

Fields inherited from class org.cyclos.impl.CRUDServiceImpl

$, ATTR_CURRENT_COPY, cacheHandler, dtoClass, entityClass, extensionPointService, idPath, internalNamePath, namePath, ownerEntityIdPath, ownerEntityPath, ownerEntityPropertyName, passwordHandler, richTextHandler, withConfirmationPassword

Fields inherited from class org.cyclos.impl.AbstractNetworkedServerComponent

authHandler, conversionHandler, customFieldValueHandler, entityManagerHandler, groupsHandler, productsHandler, restBeanPropertyMapping, userLocatorHandler

Fields inherited from class org.cyclos.impl.AbstractServerComponent

accountHandler, configurationHandler, dataTranslationHandler, notificationHandler, profileFieldHandler, transactionHandler, translationHandler

Fields inherited from interface org.cyclos.impl.BaseApplicationInitializationListener

MAX_PRIORITY, MIN_PRIORITY, NORMAL_PRIORITY

Fields inherited from interface org.cyclos.impl.system.CustomScheduledTaskServiceLocal

ATTR_LOG, ATTR_SCHEDULED_TASK, ATTR_TASK

Constructor Summary

Constructors

Constructor	Description
CustomScheduledTaskServiceImpl()

Method Summary

Modifier and Type	Method	Description
protected CustomScheduledTaskData	getData(CustomScheduledTask customScheduledTask)	Returns details data for the given entity
Date	getNextExecution(CustomScheduledTask task)	Calculates the next execution date, given the parameters.
com.mysema.commons.lang.CloseableIterator<CustomScheduledTask>	iterateForRunningNow()	Iterates all custom scheduled tasks which should start running immediately
List<CustomScheduledTaskDetailedVO>	list()	Lists all available custom recurring tasks
CustomScheduledTask	newEntity(Void params)	Should be implemented in order to instantiate a new entity based on the given context parameters
void	onApplicationInitialization()	Invoked when the application service is initialized
protected Object	onBeforeSave(CustomScheduledTask task, CustomScheduledTask currentCopy)	May be overridden in order to perform custom logic before saving an entity.
protected void	registerNetworkMappings(NetworkPathRegistry networkPathRegistry)	Needs to be overridden by subclasses to register the path up to the network
protected Validator	resolveValidator(CustomScheduledTaskDTO dto)
boolean	run(Long taskId)	Runs the task with the given identifier, generating a log.
void	runNow(CustomScheduledTaskVO vo)	Triggers a manual execution of the given task
Page<CustomScheduledTaskLogVO>	searchLogs(CustomScheduledTaskLogQuery params)	Searches for a task execution logs

Methods inherited from class org.cyclos.impl.CRUDServiceImpl

addCustomInternalNameValidations, addCustomNameValidations, checkConfirmationPassword, doRemove, find, findAll, from, getConfirmationPasswordInput, getConfirmationPasswordInputForRemove, getData, getDataForNew, getDeviceConfirmationParams, getEntityClass, getEntityInternalNameKey, getExcludedPropertiesToDTO, getExcludedPropertiesToEntity, getNameLabel, getUniqueInternalNameQuery, getUniqueNameQuery, isEntityInternalNameRequired, isNameRequired, load, logEntity, onAfterRemove, onAfterSave, onBeforeRemove, preProcessCurrentCopy, remove, remove, removeAll, removeAll, removeAllWithConfirmationPassword, removeWithConfirmationPassword, resolveDTOType, resolveEntityType, resolveExtensionPointAccessor, save, saveOrder, saveSkippingEntityLog, saveWithConfirmationPassword, shouldCheckConfirmationPassword, subClassMappings, toDTO, toEntity, validate

Methods inherited from class org.cyclos.impl.BaseServiceImpl

initializeNetworkMappings

Methods inherited from class org.cyclos.impl.AbstractNetworkedServerComponent

canManage, checkManagesUser, checkPermission, checkRelatesToUser, checkValue, clearAlreadyValidated, getBaseEntityManagerHandler, getConfiguration, getLoggedBasicUser, getLoggedUser, getProducts, getTranslatedName, getTranslatedValue, hasPermission, hasValue, inSameNetwork, inSameNetworkOrGlobal, isAdmin, isAlreadyValidated, isBroker, isGlobalAdmin, isGlobalAdminInNetwork, isGuest, isLoggedIn, isMember, isMemberOnly, isNetworkAdmin, isOperator, isRelatedToUser, isSystem, isUserManager, isUserManagerOf, message, message, permission, permission, permissionOptionalValue, permissionOptionalValue, setAlreadyValidated, toDate, toDateTime, validate

Methods inherited from class org.cyclos.impl.AbstractServerComponent

dataTranslationProxy, dataTranslationProxy, delete, detach, doDataTranslationProxy, find, flush, from, getApplicationContext, getFormatter, getFormatter, getFormatter, getLogger, getRemoteAddress, getSessionData, mailContentBuilder, message, message, persist, processBatch, processBatch, refresh, remove, selectFrom, subQuery, update

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.cyclos.impl.BaseApplicationInitializationListener

applicationInitializationPriority, getInitializationId

Methods inherited from interface org.cyclos.services.CRUDService

getData, getDataForNew, load, remove, removeAll, save

Methods inherited from interface org.cyclos.impl.CRUDServiceLocal

find, findAll, getEntityClass, remove, removeAll, saveEntity, saveSkippingEntityLog, toDTO, toEntity, validate

Constructor Detail

CustomScheduledTaskServiceImpl

public CustomScheduledTaskServiceImpl()

Method Detail

getNextExecution

public Date getNextExecution(CustomScheduledTask task)

Description copied from interface: CustomScheduledTaskServiceLocal

Calculates the next execution date, given the parameters. Is a separated method to allow testing

Specified by:

getNextExecution in interface CustomScheduledTaskServiceLocal

iterateForRunningNow

public com.mysema.commons.lang.CloseableIterator<CustomScheduledTask> iterateForRunningNow()

Description copied from interface: CustomScheduledTaskServiceLocal

Iterates all custom scheduled tasks which should start running immediately

Specified by:

iterateForRunningNow in interface CustomScheduledTaskServiceLocal

list

public List<CustomScheduledTaskDetailedVO> list()
                                         throws FrameworkException

Description copied from interface: CustomScheduledTaskService

Lists all available custom recurring tasks

Specified by:

list in interface CustomScheduledTaskService

Throws:

FrameworkException

newEntity

public CustomScheduledTask newEntity(Void params)

Description copied from class: CRUDServiceImpl

Should be implemented in order to instantiate a new entity based on the given context parameters

Specified by:

newEntity in interface CRUDServiceLocal<CustomScheduledTask,CustomScheduledTaskDTO,CustomScheduledTaskData,Void>

Specified by:

newEntity in class CRUDServiceImpl<CustomScheduledTask,QCustomScheduledTask,CustomScheduledTaskDTO,CustomScheduledTaskData,Void>

onApplicationInitialization

public void onApplicationInitialization()

Description copied from interface: ApplicationInitializationListener

Invoked when the application service is initialized

Specified by:

onApplicationInitialization in interface ApplicationInitializationListener

run

public boolean run(Long taskId)

Description copied from interface: CustomScheduledTaskServiceLocal

Runs the task with the given identifier, generating a log. Assumes there is no current transaction.

Specified by:

run in interface CustomScheduledTaskServiceLocal

runNow

public void runNow(CustomScheduledTaskVO vo)
            throws FrameworkException

Description copied from interface: CustomScheduledTaskService

Triggers a manual execution of the given task

Specified by:

runNow in interface CustomScheduledTaskService

Throws:

FrameworkException

searchLogs

public Page<CustomScheduledTaskLogVO> searchLogs(CustomScheduledTaskLogQuery params)
                                          throws FrameworkException

Description copied from interface: CustomScheduledTaskService

Searches for a task execution logs

Specified by:

searchLogs in interface CustomScheduledTaskService

Throws:

FrameworkException

getData

protected CustomScheduledTaskData getData(CustomScheduledTask customScheduledTask)

Description copied from class: CRUDServiceImpl

Returns details data for the given entity

Specified by:

getData in class CRUDServiceImpl<CustomScheduledTask,QCustomScheduledTask,CustomScheduledTaskDTO,CustomScheduledTaskData,Void>

onBeforeSave

protected Object onBeforeSave(CustomScheduledTask task,
                              CustomScheduledTask currentCopy)

Description copied from class: CRUDServiceImpl

May be overridden in order to perform custom logic before saving an entity. Any returned value will be passed to the CRUDServiceImpl.onAfterSave(BaseEntity, BaseEntity, Object) method

Overrides:

onBeforeSave in class CRUDServiceImpl<CustomScheduledTask,QCustomScheduledTask,CustomScheduledTaskDTO,CustomScheduledTaskData,Void>

registerNetworkMappings

protected void registerNetworkMappings(NetworkPathRegistry networkPathRegistry)

Description copied from class: BaseServiceImpl

Needs to be overridden by subclasses to register the path up to the network

Specified by:

registerNetworkMappings in class BaseServiceImpl

resolveValidator

protected Validator resolveValidator(CustomScheduledTaskDTO dto)

Specified by:

resolveValidator in class CRUDServiceImpl<CustomScheduledTask,QCustomScheduledTask,CustomScheduledTaskDTO,CustomScheduledTaskData,Void>