Package com.oracle.coherence.concurrent.executor

Class AbstractOrchestration<T,C extends TaskExecutorService>

java.lang.Object

com.oracle.coherence.concurrent.executor.AbstractOrchestration<T,C>

Type Parameters:

T - the type of results produced by a Task

C - the TaskExecutorService that created the Task.Orchestration

All Implemented Interfaces:

Task.Orchestration<T>, Task.SubscribedOrchestration<T>

Direct Known Subclasses:

ClusteredOrchestration

public abstract class AbstractOrchestration<T,C extends TaskExecutorService>
extends Object
implements Task.Orchestration<T>

A base implementation of a Task.Orchestration.

Since:

21.12

Author:

bo

Field Summary

Fields

Modifier and Type	Field	Description
protected OptionsByType<Task.Option>	m_optionsByType	The Task.Options for Task.Orchestration.
protected Task.Properties	m_properties	The Task.Properties for the orchestrated Task.
protected Duration	m_retainDuration	The optional Duration to retain the task after it is completed.
protected Set<Task.Subscriber<? super T>>	m_setSubscribers	The set of Task.Subscribers for the orchestrated Task.
protected String	m_sTaskId	The Task identity.
protected ExecutionStrategy	m_strategy	The ExecutionStrategy to determine the Executors to use for executing the Task.
protected ExecutionStrategyBuilder	m_strategyBuilder	The ExecutionStrategyBuilder used to build the ExecutionStrategy.
protected Task<T>	m_task	The Task to execute.
protected C	m_taskExecutorService	The TaskExecutorService that created the Task.Orchestration.

Constructor Summary

Constructors

Constructor	Description
AbstractOrchestration(C taskExecutorService, Task<T> task)	Constructs a Task.Orchestration.

Method Summary

Modifier and Type	Method	Description
Task.Orchestration<T>	as(String taskId)	Sets the unique identity for the Task when it is orchestrated.
protected abstract Task.Collectable<T,T>	collect()	Obtain a Task.Collectable using the default collection mechanism.
Task.Orchestration<T>	concurrently()	Specify that the Task should be executed concurrently on its assigned Executors.
<V extends Serializable> Task.Orchestration<T>	define(String sName, V value)	Defines the Task.Properties for the Task.
Task.Orchestration<T>	filter(com.tangosol.util.function.Remote.Predicate<? super TaskExecutorService.ExecutorInfo> predicate)	Limit the Executors to only those that satisfy the specified Remote.Predicate.
ExecutionStrategy	getAssignmentStrategy()	Obtains the ExecutionStrategy for the Task orchestration.
OptionsByType<Task.Option>	getOptionsByType()	Obtains the OptionsByType for the Task orchestration.
Task.Properties	getProperties()	Obtains the Task.Properties for the Task orchestration.
protected Supplier<Task.Properties>	getPropertiesSupplier()	Return a Supplier of a Task.Properties instance.
Duration	getRetainDuration()	Obtains the Duration the Task and it's results will live for once completed or an error occurs.
Task<T>	getTask()	Obtains the Task to orchestrate.
C	getTaskExecutorService()	Obtains the Task.Orchestration that created the Task.Orchestration.
String	getTaskId()	Obtains the Task identity.
Task.Orchestration<T>	limit(int cLimit)	Limit the number of Executors to use when executing the Task.
Task.Orchestration<T>	retain(Duration duration)	Sets the Duration to retain the task after it is completed.
Task.Orchestration<T>	sequentially()	Specify that the Task should be executed sequentially on its assigned Executors.
Task.Coordinator<T>	submit()	Submits the Task for orchestration by the TaskExecutorService.
Task.SubscribedOrchestration<T>	subscribe(Task.Subscriber<? super T> subscriber)	Registers the specified Task.Subscriber as part of the orchestration of the Task.
Task.Orchestration<T>	with(Task.Option... options)	Sets the Task.Options for orchestration.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.oracle.coherence.concurrent.executor.Task.Orchestration

collect

Field Detail

m_taskExecutorService

protected C extends TaskExecutorService m_taskExecutorService

The TaskExecutorService that created the Task.Orchestration.

m_task

protected Task<T> m_task

The Task to execute.

m_sTaskId

protected String m_sTaskId

The Task identity.

m_strategyBuilder

protected ExecutionStrategyBuilder m_strategyBuilder

The ExecutionStrategyBuilder used to build the ExecutionStrategy.

m_strategy

protected ExecutionStrategy m_strategy

The ExecutionStrategy to determine the Executors to use for executing the Task.

m_optionsByType

protected OptionsByType<Task.Option> m_optionsByType

The Task.Options for Task.Orchestration.

m_properties

protected Task.Properties m_properties

The Task.Properties for the orchestrated Task.

m_retainDuration

protected Duration m_retainDuration

The optional Duration to retain the task after it is completed. null when not required (to retain the task)

m_setSubscribers

protected Set<Task.Subscriber<? super T>> m_setSubscribers

The set of Task.Subscribers for the orchestrated Task.

Constructor Detail

AbstractOrchestration

public AbstractOrchestration(C taskExecutorService,
                             Task<T> task)

Constructs a Task.Orchestration.

Parameters:

taskExecutorService - the TaskExecutorService that created the Task.Orchestration

task - the Task to be orchestrated

Method Detail

concurrently

public Task.Orchestration<T> concurrently()

Description copied from interface: Task.Orchestration

Specify that the Task should be executed concurrently on its assigned Executors.

This is the default setting for execution.

Specified by:

concurrently in interface Task.Orchestration<T>

Returns:

the Task.Orchestration to permit fluent-style method chaining

sequentially

public Task.Orchestration<T> sequentially()

Description copied from interface: Task.Orchestration

Specify that the Task should be executed sequentially on its assigned Executors.

Specified by:

sequentially in interface Task.Orchestration<T>

Returns:

the Task.Orchestration to permit fluent-style method chaining

filter

public Task.Orchestration<T> filter(com.tangosol.util.function.Remote.Predicate<? super TaskExecutorService.ExecutorInfo> predicate)

Description copied from interface: Task.Orchestration

Limit the Executors to only those that satisfy the specified Remote.Predicate.

Specified by:

filter in interface Task.Orchestration<T>

Parameters:

predicate - the TaskExecutorService.ExecutorInfo predicate

Returns:

the Task.Orchestration to permit fluent-style method chaining

limit

public Task.Orchestration<T> limit(int cLimit)

Description copied from interface: Task.Orchestration

Limit the number of Executors to use when executing the Task.

Specified by:

limit in interface Task.Orchestration<T>

Parameters:

cLimit - the number of Executors to use

Returns:

the Task.Orchestration to permit fluent-style method chaining

as

public Task.Orchestration<T> as(String taskId)

Description copied from interface: Task.Orchestration

Sets the unique identity for the Task when it is orchestrated.

Specified by:

as in interface Task.Orchestration<T>

Parameters:

taskId - the unique identity for the Task

Returns:

the Task.Orchestration to permit fluent-style method chaining

with

public Task.Orchestration<T> with(Task.Option... options)

Description copied from interface: Task.Orchestration

Sets the Task.Options for orchestration.

Specified by:

with in interface Task.Orchestration<T>

Parameters:

options - the Task.Option

Returns:

the Task.Orchestration to permit fluent-style method chaining

retain

public Task.Orchestration<T> retain(Duration duration)

Description copied from interface: Task.Orchestration

Sets the Duration to retain the task after it is completed.

Specified by:

retain in interface Task.Orchestration<T>

Parameters:

duration - the duration to retain the task after it is completed.

Returns:

the Task.Orchestration to permit fluent-style method chaining

subscribe

public Task.SubscribedOrchestration<T> subscribe(Task.Subscriber<? super T> subscriber)

Description copied from interface: Task.SubscribedOrchestration

Registers the specified Task.Subscriber as part of the orchestration of the Task.

This method may be used multiple times to register multiple Task.Subscribers.

This method is mutually exclusive to Task.Orchestration.collect(Collector). To subscribe when using a Task.Collector, use Task.Collectable.subscribe(Subscriber) on the Task.Collectable returned by Task.Orchestration.collect(Collector).

Specified by:

subscribe in interface Task.SubscribedOrchestration<T>

Parameters:

subscriber - the Task.Subscriber

Returns:

the Task.Orchestration to permit fluent-style method chaining

See Also:

Task.Collectable.subscribe(Subscriber)

submit

public Task.Coordinator<T> submit()

Description copied from interface: Task.SubscribedOrchestration

Submits the Task for orchestration by the TaskExecutorService.

Specified by:

submit in interface Task.SubscribedOrchestration<T>

Returns:

a Task.Coordinator for managing an orchestrated Task and publishing of collected results to Task.Subscribers

See Also:

Task.Collectable.subscribe(Subscriber)

define

public <V extends Serializable> Task.Orchestration<T> define(String sName,
                                                             V value)

Description copied from interface: Task.Orchestration

Defines the Task.Properties for the Task.

Specified by:

define in interface Task.Orchestration<T>

Type Parameters:

V - the value type of the property

Parameters:

sName - the name of the property

value - the value of the property

Returns:

the Task.Orchestration to permit fluent-style method chaining

collect

protected abstract Task.Collectable<T,T> collect()

Obtain a Task.Collectable using the default collection mechanism.

Returns:

a Task.Collectable

getTaskExecutorService

public C getTaskExecutorService()

Obtains the Task.Orchestration that created the Task.Orchestration.

Returns:

the Task.Orchestration

getTask

public Task<T> getTask()

Obtains the Task to orchestrate.

Returns:

the Task

getTaskId

public String getTaskId()

Obtains the Task identity.

Returns:

the Task identity

getAssignmentStrategy

public ExecutionStrategy getAssignmentStrategy()

Obtains the ExecutionStrategy for the Task orchestration.

Returns:

the ExecutionStrategy

getOptionsByType

public OptionsByType<Task.Option> getOptionsByType()

Obtains the OptionsByType for the Task orchestration.

Returns:

the OptionsByType

getProperties

public Task.Properties getProperties()

Obtains the Task.Properties for the Task orchestration.

Returns:

the Task.Properties

getRetainDuration

public Duration getRetainDuration()

Obtains the Duration the Task and it's results will live for once completed or an error occurs.

Returns:

the Duration

getPropertiesSupplier

protected Supplier<Task.Properties> getPropertiesSupplier()

Return a Supplier of a Task.Properties instance.

Returns:

a Supplier of a Task.Properties instance