AsyncTask (stallion-core 1.0.0-SNAPSHOT API)

java.lang.Object
- io.stallion.dataAccess.ModelBase
- - io.stallion.asyncTasks.AsyncTask

All Implemented Interfaces:: Model, Comparable<AsyncTask>

public class AsyncTask
extends ModelBase
implements Comparable<AsyncTask>

Field Summary
- Fields inherited from class io.stallion.dataAccess.ModelBase
  meta

Constructor Summary

Constructors
Constructor and Description

AsyncTask()

AsyncTask(AsyncTaskHandler handler)

AsyncTask(AsyncTaskHandler handler, String customKey, long executeAt)

Constructors
Constructor and Description
`AsyncTask()`
`AsyncTask(AsyncTaskHandler handler)`
`AsyncTask(AsyncTaskHandler handler, String customKey, long executeAt)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(AsyncTask o)` Implements the comparable interface to see which task should be executed sooner.
`static AsyncTaskController`	`controller()`
`AsyncTask`	`enqueue()`
`long`	`getCompletedAt()` When the task successfully completed, in epoch milliseconds
`long`	`getCreatedAt()` When the task was created, in epoch milliseconds
`String`	`getCustomKey()` A user generated unique key for the task, used for updating the task or preventing duplicates.
`<V> V`	`getData(Class<? extends V> cls)` Parses getDataJson() and returns the resulting class.
`String`	`getDataJson()` The async handler instance will be serialized to this field during task creation.
`String`	`getErrorMessage()` The stack trace from the last failure.
`long`	`getExecuteAt()` When the task should execute, in epoch milliseconds.
`long`	`getFailedAt()` When the task last failed, in epoch milliseconds
`String`	`getHandlerName()` The name of the handler class.
`String`	`getLocalMode()`
`long`	`getLockedAt()` When the task was locked, in epoch milliseconds
`String`	`getLockUuid()` A unique lock key, generated by the async persister when locking a task.
`long`	`getOriginallyScheduledFor()` When the task was scheduled for originally, before any failures that made the coordinator reschedule it for a retried execution.
`String`	`getSecret()` A secret key, generated by the async persister, that can be used for looking up the task object.
`int`	`getTryCount()` How many times the task has been tried to execute, incremented every time the task fails.
`long`	`getUpdatedAt()` When the task was last updated, in epoch milliseconds
`boolean`	`isNeverRetry()` If true, the task should never be retried on failure.
`AsyncTask`	`setCompletedAt(long completedAt)`
`AsyncTask`	`setCreatedAt(long createdAt)`
`AsyncTask`	`setCustomKey(String customKey)`
`void`	`setData(Object o)` JSON Stringifys the object and sets this.dataJson
`AsyncTask`	`setDataJson(String data)`
`AsyncTask`	`setErrorMessage(String errorMessage)`
`AsyncTask`	`setExecuteAt(long executeAt)`
`AsyncTask`	`setFailedAt(long failedAt)`
`AsyncTask`	`setHandler(AsyncTaskHandler handler)` Will use the handler class name, for later reloading, and then convert the handler to JSON and assign the data to the dataJson field of this task.
`AsyncTask`	`setHandlerName(String handlerName)`
`AsyncTask`	`setLocalMode(String localMode)`
`AsyncTask`	`setLockedAt(long lockedAt)`
`AsyncTask`	`setLockUuid(String lockUuid)`
`AsyncTask`	`setNeverRetry(boolean neverRetry)`
`AsyncTask`	`setOriginallyScheduledFor(long originallyScheduledFor)`
`AsyncTask`	`setSecret(String secret)`
`AsyncTask`	`setTryCount(int tryCount)`
`AsyncTask`	`setUpdatedAt(long updatedAt)`

Methods inherited from class io.stallion.dataAccess.ModelBase
equals, getBucket, getCompoundId, getController, getDeleted, getId, getIsNewInsert, getLastModifiedMillis, getMeta, hashCode, setBucket, setDeleted, setId, setIsNewInsert, setLastModifiedMillis

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AsyncTask
```
public AsyncTask()
```
  - AsyncTask
```
public AsyncTask(AsyncTaskHandler handler)
```
  - AsyncTask
```
public AsyncTask(AsyncTaskHandler handler,
                 String customKey,
                 long executeAt)
```
- Method Detail
  - controller
```
public static AsyncTaskController controller()
```
  - enqueue
```
public AsyncTask enqueue()
```
  - getCreatedAt
```
public long getCreatedAt()
```
    When the task was created, in epoch milliseconds
    
    Returns:
  - setCreatedAt
```
public AsyncTask setCreatedAt(long createdAt)
```
  - getUpdatedAt
```
public long getUpdatedAt()
```
    When the task was last updated, in epoch milliseconds
    
    Returns:
  - setUpdatedAt
```
public AsyncTask setUpdatedAt(long updatedAt)
```
  - getHandlerName
```
public String getHandlerName()
```
    The name of the handler class. When loading a task after reboot, the handler class will be looked up and loaded by using this name.
    
    Returns:
  - setHandler
```
public AsyncTask setHandler(AsyncTaskHandler handler)
```
    Will use the handler class name, for later reloading, and then convert the handler to JSON and assign the data to the dataJson field of this task.
    
    Parameters:
    
    handler -
    
    Returns:
  - setHandlerName
```
public AsyncTask setHandlerName(String handlerName)
```
  - getCustomKey
```
public String getCustomKey()
```
    A user generated unique key for the task, used for updating the task or preventing duplicates.
    
    Returns:
  - setCustomKey
```
public AsyncTask setCustomKey(String customKey)
```
  - getLockedAt
```
public long getLockedAt()
```
    When the task was locked, in epoch milliseconds
    
    Returns:
  - setLockedAt
```
public AsyncTask setLockedAt(long lockedAt)
```
  - getFailedAt
```
public long getFailedAt()
```
    When the task last failed, in epoch milliseconds
    
    Returns:
  - setFailedAt
```
public AsyncTask setFailedAt(long failedAt)
```
  - getCompletedAt
```
public long getCompletedAt()
```
    When the task successfully completed, in epoch milliseconds
    
    Returns:
  - setCompletedAt
```
public AsyncTask setCompletedAt(long completedAt)
```
  - getOriginallyScheduledFor
```
public long getOriginallyScheduledFor()
```
    When the task was scheduled for originally, before any failures that made the coordinator reschedule it for a retried execution. For a task that has never been run, this time will equal the executeAt time.
    
    Returns:
  - setOriginallyScheduledFor
```
public AsyncTask setOriginallyScheduledFor(long originallyScheduledFor)
```
  - getExecuteAt
```
public long getExecuteAt()
```
    When the task should execute, in epoch milliseconds.
    
    Returns:
  - setExecuteAt
```
public AsyncTask setExecuteAt(long executeAt)
```
  - isNeverRetry
```
public boolean isNeverRetry()
```
    If true, the task should never be retried on failure.
    
    Returns:
  - setNeverRetry
```
public AsyncTask setNeverRetry(boolean neverRetry)
```
  - getLockUuid
```
public String getLockUuid()
```
    A unique lock key, generated by the async persister when locking a task.
    
    Returns:
  - setLockUuid
```
public AsyncTask setLockUuid(String lockUuid)
```
  - getSecret
```
public String getSecret()
```
    A secret key, generated by the async persister, that can be used for looking up the task object.
    
    Returns:
  - setSecret
```
public AsyncTask setSecret(String secret)
```
  - getTryCount
```
public int getTryCount()
```
    How many times the task has been tried to execute, incremented every time the task fails.
    
    Returns:
  - setTryCount
```
public AsyncTask setTryCount(int tryCount)
```
  - getErrorMessage
```
public String getErrorMessage()
```
    The stack trace from the last failure.
    
    Returns:
  - setErrorMessage
```
public AsyncTask setErrorMessage(String errorMessage)
```
  - getDataJson
```
public String getDataJson()
```
    The async handler instance will be serialized to this field during task creation. When the task is executed, the this field will be deserialized and used to hydrate the fields of the handler class.
    
    Returns:
  - setDataJson
```
public AsyncTask setDataJson(String data)
```
  - getData
```
public <V> V getData(Class<? extends V> cls)
```
    Parses getDataJson() and returns the resulting class.
    
    Type Parameters:
    
    V -
    
    Parameters:
    
    cls -
    
    Returns:
  - setData
```
public void setData(Object o)
```
    JSON Stringifys the object and sets this.dataJson
    
    Parameters:
    
    o -
  - compareTo
```
public int compareTo(AsyncTask o)
```
    Implements the comparable interface to see which task should be executed sooner.
    
    Specified by:
    
    compareTo in interface Comparable<AsyncTask>
    
    Parameters:
    
    o -
    
    Returns:
  - getLocalMode
```
public String getLocalMode()
```
  - setLocalMode
```
public AsyncTask setLocalMode(String localMode)
```

Class AsyncTask

Field Summary

Fields inherited from class io.stallion.dataAccess.ModelBase

Constructor Summary

Method Summary

Methods inherited from class io.stallion.dataAccess.ModelBase

Methods inherited from class java.lang.Object

Constructor Detail

AsyncTask

AsyncTask

AsyncTask

Method Detail

controller

enqueue

getCreatedAt

setCreatedAt

getUpdatedAt

setUpdatedAt

getHandlerName

setHandler

setHandlerName

getCustomKey

setCustomKey

getLockedAt

setLockedAt

getFailedAt

setFailedAt

getCompletedAt

setCompletedAt

getOriginallyScheduledFor

setOriginallyScheduledFor

getExecuteAt

setExecuteAt

isNeverRetry

setNeverRetry

getLockUuid

setLockUuid

getSecret

setSecret

getTryCount

setTryCount

getErrorMessage

setErrorMessage

getDataJson

setDataJson

getData

setData

compareTo

getLocalMode

setLocalMode