Package com.oracle.coherence.concurrent.executor

Class ClusteredRegistration

java.lang.Object

com.oracle.coherence.concurrent.executor.ClusteredRegistration

All Implemented Interfaces:

TaskExecutorService.Registration, com.tangosol.util.MapListener, EventListener

public class ClusteredRegistration
extends Object
implements TaskExecutorService.Registration, com.tangosol.util.MapListener

A cluster-based implementation of an TaskExecutorService.Registration.

Since:

21.12

Author:

bo

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	ClusteredRegistration.ExecutorMBeanImpl	ExecutorMBean implementation.
protected class	ClusteredRegistration.TaskExecutor	A Runnable to execute an assigned Task.

Nested classes/interfaces inherited from interface com.oracle.coherence.concurrent.executor.TaskExecutorService.Registration

TaskExecutorService.Registration.Option

Field Summary

Fields

Modifier and Type	Field	Description
protected ClusteredExecutorService	f_clusteredExecutorService	The TaskExecutorService that created the TaskExecutorService.Registration.
protected ExecutorService	f_executor	The local ExecutorService that was registered.
protected AtomicBoolean	f_fCloseCalled	Track whether close() has been called.
protected AtomicBoolean	f_fShutdownCalled	Track whether shutdown() has been called.
protected com.tangosol.util.MapListener	f_listener	Listener to detect changes on the cache entry for the Executor.
protected ConcurrentHashMap<String,ClusteredRegistration.TaskExecutor>	f_mapTaskExecutors	The ClusteredRegistration.TaskExecutors representing the Tasks scheduled for execution with the Executor.
protected OptionsByType<TaskExecutorService.Registration.Option>	f_optionsByType	The TaskExecutorService.Registration.Options for the Executor.
protected String	f_sExecutorId	The identity of the registered Executor.
static long	INFO_UPDATE_DELAY	The delay between attempts to update the TaskExecutorService.ExecutorInfo.
static TimeUnit	INFO_UPDATE_DELAY_UNIT	The delay TimeUnit for INFO_UPDATE_DELAY.
protected com.tangosol.net.NamedCache<String,ClusteredRegistration.TaskExecutor>	m_cacheTasksTermination	The ClusteredRegistration.TaskExecutor NamedCache reference used by close() to avoid calling ensureCache on a service thread when terminating and executor.
protected long	m_cTasksCompletedCount	The tasks completed count.
protected long	m_cTasksInProgressCount	The tasks in progress count.
protected long	m_cTasksRejectedCount	The tasks rejected count.
protected ClusteredRegistration.ExecutorMBeanImpl	m_executorMBean	The MBean for the registered executor.
protected ScheduledFuture	m_scheduledFuture	A ScheduledFuture representing the TaskExecutorService.ExecutorInfo updater to update the status in the cluster.
protected ScheduledFuture	m_touchFuture	A ScheduledFuture representing the TaskExecutorService.ExecutorInfo touch updater to trigger checking for remaining assigned tasks during graceful close.
protected com.tangosol.net.NamedCache	m_viewAssignments	The NamedCache/View containing ClusteredAssignments for the Executor.
static boolean	s_fTraceLogging	The executor attribute to indicate whether trace logging is enabled.

Fields inherited from interface com.tangosol.util.MapListener

ASYNCHRONOUS, SYNCHRONOUS, VERSION_AWARE

Constructor Summary

Constructors

Constructor	Description
ClusteredRegistration(ClusteredExecutorService clusteredExecutorService, String sExecutorId, ExecutorService executor, OptionsByType<TaskExecutorService.Registration.Option> optionsByType)	Constructs a ClusteredRegistration.

Method Summary

Modifier and Type	Method	Description
protected com.tangosol.net.NamedCache	assignments()	Return the NamedCache storing ClusteredAssignment instances.
protected void	cleanupTask(String sTaskId)	Removes the task from the known task executors and adjusts metrics accordingly.
void	close()	Closes the Executor.
void	entryDeleted(com.tangosol.util.MapEvent mapEvent)
void	entryInserted(com.tangosol.util.MapEvent mapEvent)
void	entryUpdated(com.tangosol.util.MapEvent mapEvent)
protected void	executingTask(ClusteredRegistration.TaskExecutor taskExecutor, String sExecId, String sTaskId)	Execute the task and handle error/exception.
protected com.tangosol.net.NamedCache	executors()	Return the NamedCache storing ClusteredExecutorInfo instances.
protected static String	getExecutorServiceMBeanName(com.tangosol.net.management.Registry registry, String sName)	Get the MBean name for the named executor.
String	getId()	Obtains the unique identity for the registered ExecutorService.
<T extends TaskExecutorService.Registration.Option> T	getOption(Class<T> classOfOption, T defaultIfNotFound)	Obtains the TaskExecutorService.Registration.Option of the specified class when the ExecutorService was registered, or the default value if not found.
long	getTasksCompletedCount()	Return the number of completed tasks.
long	getTasksInProgressCount()	Return the number of tasks in progress.
long	getTasksRejectedCount()	Return the number of rejected tasks.
protected static void	registerExecutorMBean(com.tangosol.net.CacheService service, ExecutorMBean mbean, String sName)	Registers the provided MBean for the specified executor.
void	shutdown()	Gracefully close the Executor.
protected void	start()	Starts the TaskExecutorService.Registration for the Executor, allowing assigned Tasks to be executed and TaskExecutorService.ExecutorInfo state to be updated.
protected com.tangosol.net.NamedCache	tasks()	Return the NamedCache storing ClusteredTaskManager instances.
protected static void	unregisterExecutiveServiceMBean(com.tangosol.net.CacheService service, String sName)	Unregisters the MBean for the specified executor.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.tangosol.util.MapListener

characteristics, isAsynchronous, isSynchronous, isVersionAware, synchronous

Field Detail

INFO_UPDATE_DELAY

public static long INFO_UPDATE_DELAY

The delay between attempts to update the TaskExecutorService.ExecutorInfo.

INFO_UPDATE_DELAY_UNIT

public static TimeUnit INFO_UPDATE_DELAY_UNIT

The delay TimeUnit for INFO_UPDATE_DELAY.

s_fTraceLogging

public static boolean s_fTraceLogging

The executor attribute to indicate whether trace logging is enabled.

By default, the executor trace logging is disabled. logging can be enabled by either setting the coherence.executor.trace.logging system property or the TraceLogging attribute on the JMX ExecutorMBean or via Management over REST.

f_listener

protected final com.tangosol.util.MapListener f_listener

Listener to detect changes on the cache entry for the Executor.

f_fShutdownCalled

protected final AtomicBoolean f_fShutdownCalled

Track whether shutdown() has been called.

f_fCloseCalled

protected final AtomicBoolean f_fCloseCalled

Track whether close() has been called.

m_cTasksCompletedCount

protected long m_cTasksCompletedCount

The tasks completed count.

m_cTasksRejectedCount

protected long m_cTasksRejectedCount

The tasks rejected count.

m_cTasksInProgressCount

protected long m_cTasksInProgressCount

The tasks in progress count.

f_clusteredExecutorService

protected final ClusteredExecutorService f_clusteredExecutorService

The TaskExecutorService that created the TaskExecutorService.Registration.

f_sExecutorId

protected final String f_sExecutorId

The identity of the registered Executor.

f_executor

protected final ExecutorService f_executor

The local ExecutorService that was registered.

f_optionsByType

protected final OptionsByType<TaskExecutorService.Registration.Option> f_optionsByType

The TaskExecutorService.Registration.Options for the Executor.

m_scheduledFuture

protected volatile ScheduledFuture m_scheduledFuture

A ScheduledFuture representing the TaskExecutorService.ExecutorInfo updater to update the status in the cluster.

m_touchFuture

protected volatile ScheduledFuture m_touchFuture

A ScheduledFuture representing the TaskExecutorService.ExecutorInfo touch updater to trigger checking for remaining assigned tasks during graceful close.

m_viewAssignments

protected com.tangosol.net.NamedCache m_viewAssignments

The NamedCache/View containing ClusteredAssignments for the Executor.

m_cacheTasksTermination

protected com.tangosol.net.NamedCache<String,ClusteredRegistration.TaskExecutor> m_cacheTasksTermination

The ClusteredRegistration.TaskExecutor NamedCache reference used by close() to avoid calling ensureCache on a service thread when terminating and executor.

f_mapTaskExecutors

protected final ConcurrentHashMap<String,ClusteredRegistration.TaskExecutor> f_mapTaskExecutors

The ClusteredRegistration.TaskExecutors representing the Tasks scheduled for execution with the Executor.

m_executorMBean

protected ClusteredRegistration.ExecutorMBeanImpl m_executorMBean

The MBean for the registered executor.

Constructor Detail

ClusteredRegistration

public ClusteredRegistration(ClusteredExecutorService clusteredExecutorService,
                             String sExecutorId,
                             ExecutorService executor,
                             OptionsByType<TaskExecutorService.Registration.Option> optionsByType)

Constructs a ClusteredRegistration.

Parameters:

clusteredExecutorService - the TaskExecutorService that owns the TaskExecutorService.Registration

sExecutorId - the identity of the registered ExecutorService

executor - the registered Executor

optionsByType - the TaskExecutorService.Registration.Options for the Executor

Method Detail

getId

public String getId()

Description copied from interface: TaskExecutorService.Registration

Obtains the unique identity for the registered ExecutorService.

Specified by:

getId in interface TaskExecutorService.Registration

Returns:

the unique identity

getOption

public <T extends TaskExecutorService.Registration.Option> T getOption(Class<T> classOfOption,
                                                                       T defaultIfNotFound)

Description copied from interface: TaskExecutorService.Registration

Obtains the TaskExecutorService.Registration.Option of the specified class when the ExecutorService was registered, or the default value if not found.

Specified by:

getOption in interface TaskExecutorService.Registration

Type Parameters:

T - the type of the TaskExecutorService.Registration.Option

Parameters:

classOfOption - the class of TaskExecutorService.Registration.Option

defaultIfNotFound - the value to return if not found

Returns:

a TaskExecutorService.Registration.Option

getTasksCompletedCount

public long getTasksCompletedCount()

Return the number of completed tasks.

Returns:

the number of completed tasks.

getTasksRejectedCount

public long getTasksRejectedCount()

Return the number of rejected tasks.

Returns:

the number of rejected tasks.

getTasksInProgressCount

public long getTasksInProgressCount()

Return the number of tasks in progress.

Returns:

the number of tasks in progress

entryInserted

public void entryInserted(com.tangosol.util.MapEvent mapEvent)

Specified by:

entryInserted in interface com.tangosol.util.MapListener

entryUpdated

public void entryUpdated(com.tangosol.util.MapEvent mapEvent)

Specified by:

entryUpdated in interface com.tangosol.util.MapListener

entryDeleted

public void entryDeleted(com.tangosol.util.MapEvent mapEvent)

Specified by:

entryDeleted in interface com.tangosol.util.MapListener

shutdown

public void shutdown()

Gracefully close the Executor. Existing assigned tasks will not be canceled.

executors

protected com.tangosol.net.NamedCache executors()

Return the NamedCache storing ClusteredExecutorInfo instances.

Returns:

the NamedCache storing ClusteredExecutorInfo instances

tasks

protected com.tangosol.net.NamedCache tasks()

Return the NamedCache storing ClusteredTaskManager instances.

Returns:

the NamedCache storing ClusteredTaskManager instances

assignments

protected com.tangosol.net.NamedCache assignments()

Return the NamedCache storing ClusteredAssignment instances.

Returns:

the NamedCache storing ClusteredAssignment instances

registerExecutorMBean

protected static void registerExecutorMBean(com.tangosol.net.CacheService service,
                                            ExecutorMBean mbean,
                                            String sName)

Registers the provided MBean for the specified executor.

Parameters:

service - the cache service

mbean - the mbean to register

sName - the executor name

Throws:

NullPointerException - if any of service, mbean, or sName is null

unregisterExecutiveServiceMBean

protected static void unregisterExecutiveServiceMBean(com.tangosol.net.CacheService service,
                                                      String sName)

Unregisters the MBean for the specified executor.

Parameters:

service - the cache service

sName - the executor name

Throws:

NullPointerException - if either service or sName is null

getExecutorServiceMBeanName

protected static String getExecutorServiceMBeanName(com.tangosol.net.management.Registry registry,
                                                    String sName)

Get the MBean name for the named executor.

Parameters:

registry - the management registry

sName - the executor name

Returns:

the MBean name for the named executor

Throws:

NullPointerException - if either registry or sName is null

executingTask

protected void executingTask(ClusteredRegistration.TaskExecutor taskExecutor,
                             String sExecId,
                             String sTaskId)

Execute the task and handle error/exception.

Parameters:

taskExecutor - the ClusteredRegistration.TaskExecutor

sExecId - the executor ID

sTaskId - the task ID

cleanupTask

protected void cleanupTask(String sTaskId)

Removes the task from the known task executors and adjusts metrics accordingly.

Parameters:

sTaskId - the task ID

Since:

22.06

start

protected void start()

Starts the TaskExecutorService.Registration for the Executor, allowing assigned Tasks to be executed and TaskExecutorService.ExecutorInfo state to be updated.

close

public void close()

Closes the Executor.

Specified by:

close in interface TaskExecutorService.Registration