io.druid.indexing.overlord

Class DbTaskStorage

java.lang.Object

io.druid.indexing.overlord.DbTaskStorage

All Implemented Interfaces:

TaskStorage

public class DbTaskStorage
extends Object
implements TaskStorage

Constructor Summary

Constructors

Constructor and Description
DbTaskStorage(com.fasterxml.jackson.databind.ObjectMapper jsonMapper, DbConnector dbConnector, DbTablesConfig dbTables, org.skife.jdbi.v2.IDBI dbi, TaskStorageConfig config)

Method Summary

Methods

Modifier and Type	Method and Description
<T> void	addAuditLog(Task task, TaskAction<T> taskAction) Add an action taken by a task to the audit log.
void	addLock(String taskid, TaskLock taskLock) Persists lock state in the storage facility.
List<Task>	getActiveTasks() Returns a list of currently running or pending tasks as stored in the storage facility.
List<TaskAction>	getAuditLogs(String taskid) Returns all actions taken by a task.
List<TaskLock>	getLocks(String taskid) Returns a list of locks for a particular task.
List<TaskStatus>	getRecentlyFinishedTaskStatuses() Returns a list of recently finished task statuses as stored in the storage facility.
com.google.common.base.Optional<TaskStatus>	getStatus(String taskid) Returns task status as stored in the storage facility.
com.google.common.base.Optional<Task>	getTask(String taskid) Returns task as stored in the storage facility.
void	insert(Task task, TaskStatus status) Adds a task to the storage facility with a particular status.
void	removeLock(String taskid, TaskLock taskLockToRemove) Removes lock state from the storage facility.
void	setStatus(TaskStatus status) Persists task status in the storage facility.
void	start()
void	stop()

Methods inherited from class java.lang.Object

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

Constructor Detail

DbTaskStorage

@Inject
public DbTaskStorage(com.fasterxml.jackson.databind.ObjectMapper jsonMapper,
                    DbConnector dbConnector,
                    DbTablesConfig dbTables,
                    org.skife.jdbi.v2.IDBI dbi,
                    TaskStorageConfig config)

Method Detail

start

public void start()

stop

public void stop()

insert

public void insert(Task task,
          TaskStatus status)
            throws TaskExistsException

Description copied from interface: TaskStorage

Adds a task to the storage facility with a particular status.

Specified by:

insert in interface TaskStorage

Parameters:

task - task to add

status - task status

Throws:

TaskExistsException - if the task ID already exists

setStatus

public void setStatus(TaskStatus status)

Description copied from interface: TaskStorage

Persists task status in the storage facility. This method should throw an exception if the task status lifecycle is not respected (absent -> RUNNING -> SUCCESS/FAILURE).

Specified by:

setStatus in interface TaskStorage

Parameters:

status - task status

getTask

public com.google.common.base.Optional<Task> getTask(String taskid)

Description copied from interface: TaskStorage

Returns task as stored in the storage facility. If the task ID does not exist, this will return an absentee Optional. NOTE: This method really feels like it should be combined with TaskStorage.getStatus(java.lang.String). Expect that in the future.

Specified by:

getTask in interface TaskStorage

Parameters:

taskid - task ID

Returns:

optional task

getStatus

public com.google.common.base.Optional<TaskStatus> getStatus(String taskid)

Description copied from interface: TaskStorage

Returns task status as stored in the storage facility. If the task ID does not exist, this will return an absentee Optional.

Specified by:

getStatus in interface TaskStorage

Parameters:

taskid - task ID

Returns:

task status

getActiveTasks

public List<Task> getActiveTasks()

Description copied from interface: TaskStorage

Returns a list of currently running or pending tasks as stored in the storage facility. No particular order is guaranteed, but implementations are encouraged to return tasks in ascending order of creation.

Specified by:

getActiveTasks in interface TaskStorage

Returns:

list of active tasks

getRecentlyFinishedTaskStatuses

public List<TaskStatus> getRecentlyFinishedTaskStatuses()

Description copied from interface: TaskStorage

Returns a list of recently finished task statuses as stored in the storage facility. No particular order is guaranteed, but implementations are encouraged to return tasks in descending order of creation. No particular standard of "recent" is guaranteed, and in fact, this method is permitted to simply return nothing.

Specified by:

getRecentlyFinishedTaskStatuses in interface TaskStorage

Returns:

list of recently finished tasks

addLock

public void addLock(String taskid,
           TaskLock taskLock)

Description copied from interface: TaskStorage

Persists lock state in the storage facility.

Specified by:

addLock in interface TaskStorage

Parameters:

taskid - task ID

taskLock - lock state

removeLock

public void removeLock(String taskid,
              TaskLock taskLockToRemove)

Description copied from interface: TaskStorage

Removes lock state from the storage facility. It is harmless to keep old locks in the storage facility, but this method can help reclaim wasted space.

Specified by:

removeLock in interface TaskStorage

Parameters:

taskid - task ID

taskLockToRemove - lock state

getLocks

public List<TaskLock> getLocks(String taskid)

Description copied from interface: TaskStorage

Returns a list of locks for a particular task.

Specified by:

getLocks in interface TaskStorage

Parameters:

taskid - task ID

Returns:

list of TaskLocks for the given task

addAuditLog

public <T> void addAuditLog(Task task,
                   TaskAction<T> taskAction)

Description copied from interface: TaskStorage

Add an action taken by a task to the audit log.

Specified by:

addAuditLog in interface TaskStorage

Type Parameters:

T - task action return type

Parameters:

task - task to record action for

taskAction - task action to record

getAuditLogs

public List<TaskAction> getAuditLogs(String taskid)

Description copied from interface: TaskStorage

Returns all actions taken by a task.

Specified by:

getAuditLogs in interface TaskStorage

Parameters:

taskid - task ID

Returns:

list of task actions