TaskInternal (Brooklyn)

Overview

Package

Class

Deprecated

Index

Help

Brooklyn

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | METHOD

DETAIL: FIELD | METHOD

brooklyn.util.task
[Java] Interface TaskInternal

brooklyn.management.TaskAdaptable
  brooklyn.management.Task
      brooklyn.util.task.TaskInternal
          com.google.common.util.concurrent.ListenableFuture

All Superinterfaces:: TaskAdaptable, Task, ListenableFuture

@Beta
public interface TaskInternal
extends Task

All tasks being passed to the ExecutionManager should implement this. Users are strongly encouraged to use (or extend) BasicTask, rather than implementing a task from scratch. The methods on this interface will change in subsequent releases. Because this is marked as beta, the normal deprecation policy for these methods does not apply.

Authors:: aled

Method Summary
`void`	`applyTagModifier(Function modifier)`
`boolean`	`blockUntilStarted(Duration timeout)`
`boolean`	`cancel()`
`java.lang.String`	`getBlockingDetails()` returns a textual message giving details while the task is blocked
`Task`	`getBlockingTask()` returns a task that this task is blocked on
`ExecutionManager`	`getExecutionManager()`
`java.lang.Object`	`getExtraStatusText()`
`java.util.concurrent.Callable`	`getJob()`
`ExecutionList`	`getListeners()`
`java.util.Set`	`getMutableTags()`
`long`	`getQueuedTimeUtc()` if the job is queued for submission (e.g. by another task) it can indicate that fact (and time) here; note tasks can (and often are) submitted without any queueing, in which case this value may be -1
`java.util.concurrent.Future`	`getResult()`
`void`	`initExecutionManager(ExecutionManager em)`
`void`	`initResult(ListenableFuture result)`
`boolean`	`isQueuedAndNotSubmitted()`
`boolean`	`isQueuedOrSubmitted()`
`void`	`markQueued()` marks the task as queued for execution
`void`	`resetBlockingDetails()`
`void`	`resetBlockingTask()`
`void`	`runListeners()`
`void`	`setBlockingDetails(java.lang.String blockingDetails)` allows a task user to specify why a task is blocked; for use immediately before a blocking/wait, and typically cleared immediately afterwards; referenced by management api to inspect a task which is blocking
`void`	`setBlockingTask(Task blockingTask)`
`void`	`setEndTimeUtc(long val)`
`void`	`setExtraStatusText(java.lang.Object extraStatus)`
`void`	`setJob(java.util.concurrent.Callable job)`
`void`	`setStartTimeUtc(long currentTimeMillis)`
`void`	`setSubmitTimeUtc(long currentTimeMillis)`
`void`	`setSubmittedByTask(Task task)`
`void`	`setThread(java.lang.Thread thread)`

Methods inherited from interface Task
blockUntilEnded, blockUntilEnded, blockUntilStarted, get, getDescription, getDisplayName, getEndTimeUtc, getId, getStartTimeUtc, getStatusDetail, getStatusSummary, getSubmitTimeUtc, getSubmittedByTask, getTags, getThread, getUnchecked, getUnchecked, isBegun, isError, isSubmitted

Methods inherited from interface TaskAdaptable
asTask

Method Detail

applyTagModifier

public void applyTagModifier(Function modifier)

blockUntilStarted

public boolean blockUntilStarted(Duration timeout)

cancel

public boolean cancel()

getBlockingDetails

public java.lang.String getBlockingDetails()

returns a textual message giving details while the task is blocked

getBlockingTask

public Task getBlockingTask()

returns a task that this task is blocked on

getExecutionManager

public ExecutionManager getExecutionManager()

getExtraStatusText

public java.lang.Object getExtraStatusText()

getJob

public java.util.concurrent.Callable getJob()

getListeners

public ExecutionList getListeners()

getMutableTags

public java.util.Set getMutableTags()

getQueuedTimeUtc

public long getQueuedTimeUtc()

if the job is queued for submission (e.g. by another task) it can indicate that fact (and time) here; note tasks can (and often are) submitted without any queueing, in which case this value may be -1

getResult

public java.util.concurrent.Future getResult()

initExecutionManager

public void initExecutionManager(ExecutionManager em)

initResult

public void initResult(ListenableFuture result)

isQueuedAndNotSubmitted

public boolean isQueuedAndNotSubmitted()

isQueuedOrSubmitted

public boolean isQueuedOrSubmitted()

markQueued

public void markQueued()

marks the task as queued for execution

resetBlockingDetails

public void resetBlockingDetails()

resetBlockingTask

public void resetBlockingTask()

runListeners

public void runListeners()

setBlockingDetails

public void setBlockingDetails(java.lang.String blockingDetails)

allows a task user to specify why a task is blocked; for use immediately before a blocking/wait, and typically cleared immediately afterwards; referenced by management api to inspect a task which is blocking

setBlockingTask

public void setBlockingTask(Task blockingTask)

setEndTimeUtc

public void setEndTimeUtc(long val)

setExtraStatusText

public void setExtraStatusText(java.lang.Object extraStatus)

setJob

public void setJob(java.util.concurrent.Callable job)

setStartTimeUtc

public void setStartTimeUtc(long currentTimeMillis)

setSubmitTimeUtc

public void setSubmitTimeUtc(long currentTimeMillis)

setSubmittedByTask

public void setSubmittedByTask(Task task)

setThread

public void setThread(java.lang.Thread thread)

brooklyn.util.task [Java] Interface TaskInternal