Package com.oracle.coherence.concurrent.executor

Interface TaskExecutorService

All Superinterfaces:

RemoteExecutor

All Known Implementing Classes:

ClusteredExecutorService, NamedClusteredExecutorService

public interface TaskExecutorService
extends RemoteExecutor

An ExecutorService that orchestrates execution of submitted executables, for example Runnables, Callables and Tasks, across zero or more registered ExecutorServices. Specifically, TaskExecutorServices don't execute executables. They simply orchestrate submissions to other registered ExecutorServices for execution.

Since:

21.06

Author:

bo

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	TaskExecutorService.ExecutorInfo	Provides access to the currently available information for a registered ExecutorService.
static interface	TaskExecutorService.Registration	Provides registration information about an ExecutorService registration.

Field Summary

Fields inherited from interface com.oracle.coherence.concurrent.executor.RemoteExecutor

DEFAULT_EXECUTOR_NAME

Method Summary

Modifier and Type	Method	Description
<R> Task.Coordinator<R>	acquire(String taskId)	Attempts to acquire the Task.Coordinator for a previously submitted Task.
TaskExecutorService.Registration	deregister(ExecutorService executor)	De-registers a previously registered ExecutorService.
<T> Task.Orchestration<T>	orchestrate(Task<T> task)	Creates a pending Task.Orchestration for a Task.
TaskExecutorService.Registration	register(ExecutorService executor, TaskExecutorService.Registration.Option... options)	Registers an ExecutorService to commence execution of orchestrated tasks.
default <T> Task.Coordinator<T>	submit(Task<T> task)	Submits the Task for execution by the TaskExecutorService.

Methods inherited from interface com.oracle.coherence.concurrent.executor.RemoteExecutor

awaitTermination, execute, invokeAll, invokeAll, invokeAny, invokeAny, isShutdown, isTerminated, schedule, schedule, scheduleAtFixedRate, scheduleWithFixedDelay, shutdown, shutdownNow, submit, submit, submit

Method Detail

register

TaskExecutorService.Registration register(ExecutorService executor,
                                          TaskExecutorService.Registration.Option... options)

Registers an ExecutorService to commence execution of orchestrated tasks.

Parameters:

executor - the ExecutorService to register

options - the TaskExecutorService.Registration.Options for the ExecutorService

Returns:

the TaskExecutorService.Registration created for the registered ExecutorService, or the existing TaskExecutorService.Registration when the ExecutorService is already registered

deregister

TaskExecutorService.Registration deregister(ExecutorService executor)

De-registers a previously registered ExecutorService.

Upon execution, all allocated executables are deemed to be suspended. Any results made towards completing said executables will be ignored. Executables specifically allocated to the identified ExecutorService will be lost, unless they were submitted as being retained. All other executables will be re-allocated and submitted to other available and appropriate subscribed ExecutorServices.

Parameters:

executor - the ExecutorService to deregister

Returns:

the TaskExecutorService.Registration that was originally created for the registered ExecutorService, or null if the ExecutorService is unknown/not registered

orchestrate

<T> Task.Orchestration<T> orchestrate(Task<T> task)

Creates a pending Task.Orchestration for a Task.

Type Parameters:

T - the type result produced by the Task

Parameters:

task - the Task

Returns:

an Task.Orchestration

submit

default <T> Task.Coordinator<T> submit(Task<T> task)

Submits the Task for execution by the TaskExecutorService.

The default implementation is orchestrate(task).submit()

Type Parameters:

T - the type result produced by the Task

Parameters:

task - the Task

Returns:

a Task.Coordinator for the Task

See Also:

Task.SubscribedOrchestration.submit(), Task.Collectable.submit()

acquire

<R> Task.Coordinator<R> acquire(String taskId)

Attempts to acquire the Task.Coordinator for a previously submitted Task.

Type Parameters:

R - the collected result type published by the Task.Coordinator

Parameters:

taskId - the unique identity originally allocated to the Task (available by calling Task.Coordinator.getTaskId())

Returns:

the Task.Coordinator for the specified Task or null if the Task is unknown