io.druid.indexing.common.task

Class AbstractTask

java.lang.Object

io.druid.indexing.common.task.AbstractTask

All Implemented Interfaces:

Task

Direct Known Subclasses:

AbstractFixedIntervalTask, HadoopTask, IndexTask, KafkaIndexTask, NoopTask, RealtimeIndexTask

public abstract class AbstractTask
extends Object
implements Task

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractTask(String id, String dataSource, Map<String,Object> context)
protected	AbstractTask(String id, String groupId, String dataSource, Map<String,Object> context)
protected	AbstractTask(String id, String groupId, TaskResource taskResource, String dataSource, Map<String,Object> context)

Method Summary

Modifier and Type	Method and Description
boolean	canRestore() Returns whether or not this task can restore its progress from its on-disk working directory.
boolean	equals(Object o)
String	getClasspathPrefix() Returns an extra classpath that should be prepended to the default classpath when running this task.
Map<String,Object>	getContext()
Object	getContextValue(String key)
String	getDataSource() Returns the datasource this task operates on.
String	getGroupId() Returns group ID of this task.
String	getId() Returns ID of this task.
String	getNodeType() Get the nodeType for if/when this task publishes on zookeeper.
<T> QueryRunner<T>	getQueryRunner(Query<T> query) Returns query runners for this task.
protected Iterable<TaskLock>	getTaskLocks(TaskToolbox toolbox)
TaskResource	getTaskResource() Returns a TaskResource for this task.
int	hashCode()
static String	joinId(Object... objects) Start helper methods
static String	makeId(String id, String typeName, String dataSource, org.joda.time.Interval interval)
void	stopGracefully() Asks a task to arrange for its "run" method to exit promptly.
TaskStatus	success()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.druid.indexing.common.task.Task

getType, isReady, run

Constructor Detail

AbstractTask

protected AbstractTask(String id,
                       String dataSource,
                       Map<String,Object> context)

AbstractTask

protected AbstractTask(String id,
                       String groupId,
                       String dataSource,
                       Map<String,Object> context)

AbstractTask

protected AbstractTask(String id,
                       String groupId,
                       TaskResource taskResource,
                       String dataSource,
                       Map<String,Object> context)

Method Detail

makeId

public static String makeId(String id,
                            String typeName,
                            String dataSource,
                            org.joda.time.Interval interval)

getId

public String getId()

Description copied from interface: Task

Returns ID of this task. Must be unique across all tasks ever created.

Specified by:

getId in interface Task

Returns:

task ID

getGroupId

public String getGroupId()

Description copied from interface: Task

Returns group ID of this task. Tasks with the same group ID can share locks. If tasks do not need to share locks, a common convention is to set group ID equal to task ID.

Specified by:

getGroupId in interface Task

Returns:

task group ID

getTaskResource

public TaskResource getTaskResource()

Description copied from interface: Task

Returns a TaskResource for this task. Task resources define specific worker requirements a task may require.

Specified by:

getTaskResource in interface Task

Returns:

TaskResource for this task

getNodeType

public String getNodeType()

Description copied from interface: Task

Get the nodeType for if/when this task publishes on zookeeper.

Specified by:

getNodeType in interface Task

Returns:

the nodeType to use when publishing the server to zookeeper. null if the task doesn't expect to publish to zookeeper.

getDataSource

public String getDataSource()

Description copied from interface: Task

Returns the datasource this task operates on. Each task can operate on only one datasource.

Specified by:

getDataSource in interface Task

getQueryRunner

public <T> QueryRunner<T> getQueryRunner(Query<T> query)

Description copied from interface: Task

Returns query runners for this task. If this task is not meant to answer queries over its datasource, this method should return null.

Specified by:

getQueryRunner in interface Task

Type Parameters:

T - query result type

Returns:

query runners for this task

getClasspathPrefix

public String getClasspathPrefix()

Description copied from interface: Task

Returns an extra classpath that should be prepended to the default classpath when running this task. If no extra classpath should be prepended, this should return null or the empty string.

Specified by:

getClasspathPrefix in interface Task

canRestore

public boolean canRestore()

Description copied from interface: Task

Returns whether or not this task can restore its progress from its on-disk working directory. Restorable tasks may be started with a non-empty working directory. Tasks that exit uncleanly may still have a chance to attempt restores, meaning that restorable tasks should be able to deal with potentially partially written on-disk state.

Specified by:

canRestore in interface Task

stopGracefully

public void stopGracefully()

Description copied from interface: Task

Asks a task to arrange for its "run" method to exit promptly. This method will only be called if Task.canRestore() returns true. Tasks that take too long to stop gracefully will be terminated with extreme prejudice.

Specified by:

stopGracefully in interface Task

toString

public String toString()

Overrides:

toString in class Object

joinId

public static String joinId(Object... objects)

Start helper methods

Parameters:

objects - objects to join

Returns:

string of joined objects

success

public TaskStatus success()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getTaskLocks

protected Iterable<TaskLock> getTaskLocks(TaskToolbox toolbox)
                                   throws IOException

Throws:

IOException

getContext

public Map<String,Object> getContext()

Specified by:

getContext in interface Task

getContextValue

public Object getContextValue(String key)

Specified by:

getContextValue in interface Task