PurgeMessagesOnTrashPollingTask (Cyclos 4.15.15 Scripting API Documentation)

java.lang.Object
- org.cyclos.impl.AbstractServerComponent
- - org.cyclos.impl.AbstractGlobalServerComponent
  - - org.cyclos.impl.utils.tasks.AbstractTask
    - - org.cyclos.impl.utils.tasks.AbstractPollingTask
      - org.cyclos.impl.utils.tasks.SimplePollingTask
        
        org.cyclos.impl.messaging.PurgeMessagesOnTrashPollingTask

All Implemented Interfaces:

Runnable, PollingTask, HasMessageKey
```
@Component
public class PurgeMessagesOnTrashPollingTask
extends SimplePollingTask
```
A PollingTask which deletes messages on trash older than a given time frame

Field Summary
- Fields inherited from class org.cyclos.impl.utils.tasks.AbstractTask
  clusterHandler, errorLogService, invokerHandler, loggingHandler
- Fields inherited from class org.cyclos.impl.AbstractServerComponent
  accountHandler, configurationHandler, dataTranslationHandler, notificationHandler, profileFieldHandler, transactionHandler, translationHandler

Constructor Summary

Constructors
Constructor Description

PurgeMessagesOnTrashPollingTask()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected long`	`execute()`	Executes the task batch.
`MessageKey`	`getMessageKey()`
`PollingTaskRecurrence`	`getRecurrence()`	Return the polling task recurrence

Methods inherited from class org.cyclos.impl.utils.tasks.SimplePollingTask
doRun, isRunInTransaction, notifyIssueToLicense, notifyIssueToLicense

Methods inherited from class org.cyclos.impl.utils.tasks.AbstractPollingTask
getFirstExecution, getStorage, isVerbose, logName, run, toString

Methods inherited from class org.cyclos.impl.utils.tasks.AbstractTask
getLogConfiguration, getName, logTaskError, logTaskSuccess, resolveName, shouldGenerateErrorLog

Methods inherited from class org.cyclos.impl.AbstractGlobalServerComponent
getBaseEntityManagerHandler, getEntityManager

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, wait, wait, wait

Methods inherited from interface org.cyclos.impl.utils.tasks.PollingTask
getName

- Constructor Detail
  - PurgeMessagesOnTrashPollingTask
```
public PurgeMessagesOnTrashPollingTask()
```
- Method Detail
  - getMessageKey
```
public MessageKey getMessageKey()
```
  - getRecurrence
```
public PollingTaskRecurrence getRecurrence()
```
    Description copied from interface: PollingTask
    
    Return the polling task recurrence
    
    Specified by:
    
    getRecurrence in interface PollingTask
    
    Overrides:
    
    getRecurrence in class AbstractPollingTask
  - execute
```
protected long execute()
                throws Throwable
```
    Description copied from class: SimplePollingTask
    
    Executes the task batch. This method must be idempotent, which means that subsequent invocations should not cause side effects. For example, a task could expire data up to the current hour. If executed several times within any given hour, only the first execution should change data, while others should not affect anything. Should return the number of affected records
    
    Specified by:
    
    execute in class SimplePollingTask
    
    Throws:
    
    Throwable