Package com.oracle.coherence.concurrent.executor.management

Interface ExecutorMBean

public interface ExecutorMBean

ExecutorMBean provides a monitor interface for the Executor statistics.

Since:

21.12

Author:

bo, lh 2016.10.13

Field Summary

Fields

Modifier and Type	Field	Description
static String	EXECUTOR_NAME	A string representing the "name" part of ObjectName for the ExecutorMBean.
static String	EXECUTOR_TYPE	A string representing the "type" part of ObjectName for the ExecutorMBean.

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Return the description of the registered ExecutorService.
String	getId()	Return the unique ID of the registered ExecutorService.
String	getLocation()	Get the location where the executor is running.
String	getMemberId()	Get the member id where the executor is running.
String	getName()	Return the logical name of the registered ExecutorService.
String	getState()	Get the state of the executor.
int	getStateCode()	Get the state of the executor as an integer.
long	getTasksCompletedCount()	Get the completed tasks count for the executor.
long	getTasksInProgressCount()	Get the in progress tasks count for the executor.
long	getTasksRejectedCount()	Get the number of tasks rejected by the executor.
boolean	isTraceLogging()	Return a boolean to indicate whether the executor trace logging is enabled (true) or not (false).
void	resetStatistics()	Reset the statistics.
void	setTraceLogging(boolean fTrace)	Set the trace to true to enable executor trace logging; false to disable executor trace logging.

Field Detail

EXECUTOR_TYPE

static final String EXECUTOR_TYPE

A string representing the "type" part of ObjectName for the ExecutorMBean.

See Also:

Constant Field Values

EXECUTOR_NAME

static final String EXECUTOR_NAME

A string representing the "name" part of ObjectName for the ExecutorMBean.

See Also:

Constant Field Values

Method Detail

resetStatistics

void resetStatistics()

Reset the statistics.

getMemberId

String getMemberId()

Get the member id where the executor is running.

Returns:

the member id where the executor is running

getName

String getName()

Return the logical name of the registered ExecutorService.

Returns:

the logical name of the registered ExecutorService

getId

String getId()

Return the unique ID of the registered ExecutorService.

Returns:

the unique ID of the registered ExecutorService

getDescription

String getDescription()

Return the description of the registered ExecutorService.

Returns:

the unique description of the registered ExecutorService

getLocation

String getLocation()

Get the location where the executor is running.

Returns:

the location where the executor is running

getState

String getState()

Get the state of the executor.

Returns:

the executor state

getStateCode

int getStateCode()

Get the state of the executor as an integer.

Returns:

the executor state as an integer

Since:

22.06

getTasksCompletedCount

long getTasksCompletedCount()

Get the completed tasks count for the executor.

Returns:

the completed tasks count for the executor

getTasksRejectedCount

long getTasksRejectedCount()

Get the number of tasks rejected by the executor.

Returns:

the rejected tasks count for the executor

getTasksInProgressCount

long getTasksInProgressCount()

Get the in progress tasks count for the executor.

Returns:

the in progress tasks count for the executor

isTraceLogging

boolean isTraceLogging()

Return a boolean to indicate whether the executor trace logging is enabled (true) or not (false). By default, the executor trace logging is disabled. You can enable it by either setting the "coherence.executor.trace.logging" system property or the "TraceLogging" attribute in the ExecutorMBean through JMX or management over REST.

Returns:

whether executor trace logging is enabled (true) or not (false)

setTraceLogging

void setTraceLogging(boolean fTrace)

Set the trace to true to enable executor trace logging; false to disable executor trace logging.

Parameters:

fTrace - a flag to indicate whether to enable (true) executor trace logging or not (false)