Package org.cyclos.impl.utils.tasks

Interface PollingTask

All Superinterfaces:

HasMessageKey, Runnable

All Known Implementing Classes:

AbstractPollingTask, AbstractTransactionFeedbackNotificationPollingTask, AbstractTransactionFeedbackPollingTask, AccountVerificationPollingTask, AddressLocatingPollingTask, AdExpiredNotificationPollingTask, ArchiveImportsPollingTask, BackgroundTaskExecutionPollingTask, BaseEntityNotificationProcessingPollingTask, CleanAccountBalancesPollingTask, DbSchemaVerificationPollingTask, DispatchArchiveAccountFeesPollingTask, DispatchArchiveBulkActionsPollingTask, EntityBatchPollingTask, ExpireExternalPaymentPollingTask, ExpirePendingAuthorizationPaymentPollingTask, ExpireVouchersActivationPollingTask, ExpireVouchersPollingTask, FinishAccountFeeChargesPollingTask, InstallmentProcessingPollingTask, InstanceUpdatePollingTask, InternetAddressResolutionPollingTask, MoveUsersToGroupPollingTask, NotifyVoucherBuyingAboutToExpirePollingTask, NotifyVouchersAboutToExpirePollingTask, PaymentRequestProcessingPollingTask, PurgeDeviceActivationsPollingTask, PurgeExpiredPinsPollingTask, PurgeExpiredScriptStoragesPollingTask, PurgeExternalOperationExecutionsPollingTask, PurgeFailedPasswordLogsPollingTask, PurgeFailedPrincipalLogsPollingTask, PurgeFcmTokensPollingTask, PurgeForgotPasswordRequestLogsPollingTask, PurgeInviteTokensPollingTask, PurgeMessagesOnTrashPollingTask, PurgeOidcAuthorizationsPollingTask, PurgeOidcTokensPollingTask, PurgeOldErrorLogsPollingTask, PurgeOldNotificationsPollingTask, PurgeOrphanDataTranslationsPollingTask, PurgeRemoteAddressBlocksPollingTask, PurgeSessionsPollingTask, PurgeTempFilesPollingTask, PurgeUnconfirmedUsersPollingTask, PurgeWizardExecutionsPollingTask, RunScheduledPollingTask, ScheduledAccountFeesPollingTask, SimplePollingTask, TicketProcessingPollingTask, TokensPollingTask, TransactionFeedbackExpirationReminderPollingTask, TransactionFeedbackExpiredPollingTask, TransactionFeedbackReminderPollingTask, TransactionNotificationProcessingPollingTask, TransferNotificationProcessingPollingTask

public interface PollingTask
extends Runnable, HasMessageKey

A PollingTask is a task which keeps looking for available data to be processed. By definition, PollingTasks should be idempotent, that is, running the same task over and over again should only process data which hasn't been processed yet.
Each PollingTask runs in a task scheduler, and are scheduled on Cyclos startup. A PollingTask should resolve its first execution date and then the next execution date. However, a PollingTask can be awaken by services. So, if a service knows something will be immediately available for processing, it can use the PollingTaskHandler.scheduleAwake(Class) method. The will cause the polling task to run right after the service transaction is committed. This is important, because if the task would run before the service transaction commits, it wouldn't probably find the data to be processed.

Method Summary

Modifier and Type	Method	Description
PollingTaskFirstExecution	getFirstExecution()	Returns the polling task first execution
String	getName()	Returns the task name
PollingTaskRecurrence	getRecurrence()	Return the polling task recurrence

Methods inherited from interface org.cyclos.utils.HasMessageKey

getMessageKey

Methods inherited from interface java.lang.Runnable

run

Method Detail

getFirstExecution

PollingTaskFirstExecution getFirstExecution()

Returns the polling task first execution

getName

String getName()

Returns the task name

getRecurrence

PollingTaskRecurrence getRecurrence()

Return the polling task recurrence