TaskInternal (Apache Brooklyn)

All Superinterfaces:

java.util.concurrent.Future<T>, com.google.common.util.concurrent.ListenableFuture<T>, Task<T>, TaskAdaptable<T>

All Known Implementing Classes:

BasicTask, CompoundTask, DynamicSequentialTask, ForwardingTask, ParallelTask, ScheduledTask, SequentialTask
```
@Beta
public interface TaskInternal<T>
extends Task<T>
```
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.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`applyTagModifier(com.google.common.base.Function<java.util.Set<java.lang.Object>,java.lang.Void> 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
`java.lang.Object`	`getExtraStatusText()`
`java.util.concurrent.Future<T>`	`getInternalFuture()` returns the underlying future where this task's results will come in; see `initInternalFuture(ListenableFuture)`
`java.util.concurrent.Callable<T>`	`getJob()`
`com.google.common.util.concurrent.ExecutionList`	`getListeners()`
`java.util.Set<java.lang.Object>`	`getMutableTags()`
`Task<?>`	`getProxyTarget()` if a task is a proxy for another one (used mainly for internal tasks), this returns the "real" task represented by this one
`long`	`getQueuedTimeUtc()` if the job is queued for submission (e.g.
`void`	`initInternalFuture(com.google.common.util.concurrent.ListenableFuture<T> result)` sets the internal future object used to record the association to a job submitted to an `ExecutorService`
`boolean`	`isQueued()`
`boolean`	`isQueuedAndNotSubmitted()`
`boolean`	`isQueuedOrSubmitted()`
`void`	`markQueued()` marks the task as queued for execution
`void`	`resetBlockingDetails()`
`void`	`resetBlockingTask()`
`void`	`runListeners()`
`java.lang.String`	`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
`Task<?>`	`setBlockingTask(Task<?> blockingTask)` as `setBlockingDetails(String)` but records a task which is blocking, for use e.g.
`void`	`setEndTimeUtc(long val)`
`void`	`setExtraStatusText(java.lang.Object extraStatus)`
`void`	`setJob(java.util.concurrent.Callable<T> job)`
`void`	`setStartTimeUtc(long currentTimeMillis)`
`void`	`setSubmittedByTask(Task<?> task)`
`void`	`setSubmitTimeUtc(long currentTimeMillis)`
`void`	`setThread(java.lang.Thread thread)`

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

Methods inherited from interface com.google.common.util.concurrent.ListenableFuture
addListener

Methods inherited from interface java.util.concurrent.Future
get, get, isCancelled, isDone

Methods inherited from interface brooklyn.management.TaskAdaptable
asTask

- Method Detail
  - initInternalFuture
```
void initInternalFuture(com.google.common.util.concurrent.ListenableFuture<T> result)
```
    sets the internal future object used to record the association to a job submitted to an ExecutorService
  - getInternalFuture
```
java.util.concurrent.Future<T> getInternalFuture()
```
    returns the underlying future where this task's results will come in; see initInternalFuture(ListenableFuture)
  - getQueuedTimeUtc
```
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
  - isQueuedOrSubmitted
```
boolean isQueuedOrSubmitted()
```
  - isQueuedAndNotSubmitted
```
boolean isQueuedAndNotSubmitted()
```
  - isQueued
```
boolean isQueued()
```
  - markQueued
```
void markQueued()
```
    marks the task as queued for execution
  - cancel
```
boolean cancel()
```
  - blockUntilStarted
```
boolean blockUntilStarted(Duration timeout)
```
  - setBlockingDetails
```
java.lang.String 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
    returns previous details, in case caller wishes to recall and restore it (e.g. if it is doing a sub-blocking)
  - setBlockingTask
```
Task<?> setBlockingTask(Task<?> blockingTask)
```
    as setBlockingDetails(String) but records a task which is blocking, for use e.g. in a gui to navigate to the current active subtask
    returns previous blocking task, in case caller wishes to recall and restore it
  - resetBlockingDetails
```
void resetBlockingDetails()
```
  - resetBlockingTask
```
void resetBlockingTask()
```
  - getBlockingDetails
```
java.lang.String getBlockingDetails()
```
    returns a textual message giving details while the task is blocked
  - getBlockingTask
```
Task<?> getBlockingTask()
```
    returns a task that this task is blocked on
  - setExtraStatusText
```
void setExtraStatusText(java.lang.Object extraStatus)
```
  - getExtraStatusText
```
java.lang.Object getExtraStatusText()
```
  - runListeners
```
void runListeners()
```
  - setEndTimeUtc
```
void setEndTimeUtc(long val)
```
  - setThread
```
void setThread(java.lang.Thread thread)
```
  - getJob
```
java.util.concurrent.Callable<T> getJob()
```
  - setJob
```
void setJob(java.util.concurrent.Callable<T> job)
```
  - getListeners
```
com.google.common.util.concurrent.ExecutionList getListeners()
```
  - setSubmitTimeUtc
```
void setSubmitTimeUtc(long currentTimeMillis)
```
  - setSubmittedByTask
```
void setSubmittedByTask(Task<?> task)
```
  - getMutableTags
```
java.util.Set<java.lang.Object> getMutableTags()
```
  - setStartTimeUtc
```
void setStartTimeUtc(long currentTimeMillis)
```
  - applyTagModifier
```
void applyTagModifier(com.google.common.base.Function<java.util.Set<java.lang.Object>,java.lang.Void> modifier)
```
  - getProxyTarget
```
Task<?> getProxyTarget()
```
    if a task is a proxy for another one (used mainly for internal tasks), this returns the "real" task represented by this one

Interface TaskInternal<T>

Method Summary

Methods inherited from interface brooklyn.management.Task

Methods inherited from interface com.google.common.util.concurrent.ListenableFuture

Methods inherited from interface java.util.concurrent.Future

Methods inherited from interface brooklyn.management.TaskAdaptable

Method Detail

initInternalFuture

getInternalFuture

getQueuedTimeUtc

isQueuedOrSubmitted

isQueuedAndNotSubmitted

isQueued

markQueued

cancel

blockUntilStarted

setBlockingDetails

setBlockingTask

resetBlockingDetails

resetBlockingTask

getBlockingDetails

getBlockingTask

setExtraStatusText

getExtraStatusText

runListeners

setEndTimeUtc

setThread

getJob

setJob

getListeners

setSubmitTimeUtc

setSubmittedByTask

getMutableTags

setStartTimeUtc

applyTagModifier

getProxyTarget