Package org.opendaylight.controller.md.sal.common.util.jmx

Class ThreadExecutorStatsMXBeanImpl

java.lang.Object

org.opendaylight.controller.md.sal.common.util.jmx.AbstractMXBean

org.opendaylight.controller.md.sal.common.util.jmx.ThreadExecutorStatsMXBeanImpl

All Implemented Interfaces:

ThreadExecutorStatsMXBean

public class ThreadExecutorStatsMXBeanImpl
extends AbstractMXBean
implements ThreadExecutorStatsMXBean

MXBean implementation of the ThreadExecutorStatsMXBean interface that retrieves statistics from a backing ExecutorService.

Author:

Thomas Pantelis

Field Summary

Fields inherited from class org.opendaylight.controller.md.sal.common.util.jmx.AbstractMXBean

BASE_JMX_PREFIX

Constructor Summary

Constructors

Constructor	Description
ThreadExecutorStatsMXBeanImpl(ThreadPoolExecutor executor, String beanName, String beanType, @Nullable String beanCategory)	Constructs an instance for the given Executor.

Method Summary

Modifier and Type	Method	Description
static ThreadExecutorStatsMXBeanImpl	create(Executor executor)	Creates a new bean if the backing executor is a ThreadPoolExecutor.
static ThreadExecutorStatsMXBeanImpl	create(Executor executor, String beanName, String beanType)	Creates a new bean if the backing executor is a ThreadPoolExecutor and registers it.
static ThreadExecutorStatsMXBeanImpl	create(Executor executor, String beanName, String beanType, @Nullable String beanCategory)	Creates a new bean if the backing executor is a ThreadPoolExecutor and registers it.
long	getActiveThreadCount()	Returns the active thread count.
long	getCompletedTaskCount()	Returns the completed task count.
long	getCurrentQueueSize()	Returns the current queue size.
long	getCurrentThreadPoolSize()	Returns the current thread pool size.
Long	getLargestQueueSize()	Returns the largest queue size, if available.
long	getLargestThreadPoolSize()	Returns the largest thread pool size.
long	getMaxQueueSize()	Returns the maximum queue size.
long	getMaxThreadPoolSize()	Returns the maximum thread pool size.
Long	getRejectedTaskCount()	Returns the rejected task count, if available.
long	getTotalTaskCount()	Returns the total task count.
ThreadExecutorStats	toThreadExecutorStats()	Returns a ThreadExecutorStats instance containing a snapshot of the statistic metrics.

Methods inherited from class org.opendaylight.controller.md.sal.common.util.jmx.AbstractMXBean

getMBeanCategory, getMBeanName, getMBeanType, register, registerMBean, unregister, unregisterMBean

Methods inherited from class java.lang.Object

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

Constructor Detail

ThreadExecutorStatsMXBeanImpl

public ThreadExecutorStatsMXBeanImpl(ThreadPoolExecutor executor,
                                     String beanName,
                                     String beanType,
                                     @Nullable String beanCategory)

Constructs an instance for the given Executor.

Parameters:

executor - the backing Executor

beanName - Used as the name property in the bean's ObjectName.

beanType - Used as the type property in the bean's ObjectName.

beanCategory - Used as the Category property in the bean's ObjectName.

Method Detail

create

public static ThreadExecutorStatsMXBeanImpl create(Executor executor,
                                                   String beanName,
                                                   String beanType,
                                                   @Nullable String beanCategory)

Creates a new bean if the backing executor is a ThreadPoolExecutor and registers it.

Parameters:

executor - the backing Executor

beanName - Used as the name property in the bean's ObjectName.

beanType - Used as the type property in the bean's ObjectName.

beanCategory - Used as the Category property in the bean's ObjectName.

Returns:

a registered ThreadExecutorStatsMXBeanImpl instance if the backing executor is a ThreadPoolExecutor, otherwise null.

create

public static ThreadExecutorStatsMXBeanImpl create(Executor executor,
                                                   String beanName,
                                                   String beanType)

Creates a new bean if the backing executor is a ThreadPoolExecutor and registers it.

Parameters:

executor - the backing Executor

beanName - Used as the name property in the bean's ObjectName.

beanType - Used as the type property in the bean's ObjectName.

Returns:

a registered ThreadExecutorStatsMXBeanImpl instance if the backing executor is a ThreadPoolExecutor, otherwise null.

create

public static ThreadExecutorStatsMXBeanImpl create(Executor executor)

Creates a new bean if the backing executor is a ThreadPoolExecutor.

Parameters:

executor - the backing Executor

Returns:

a ThreadExecutorStatsMXBeanImpl instance if the backing executor is a ThreadPoolExecutor, otherwise null.

getCurrentThreadPoolSize

public long getCurrentThreadPoolSize()

Description copied from interface: ThreadExecutorStatsMXBean

Returns the current thread pool size.

Specified by:

getCurrentThreadPoolSize in interface ThreadExecutorStatsMXBean

getLargestThreadPoolSize

public long getLargestThreadPoolSize()

Description copied from interface: ThreadExecutorStatsMXBean

Returns the largest thread pool size.

Specified by:

getLargestThreadPoolSize in interface ThreadExecutorStatsMXBean

getMaxThreadPoolSize

public long getMaxThreadPoolSize()

Description copied from interface: ThreadExecutorStatsMXBean

Returns the maximum thread pool size.

Specified by:

getMaxThreadPoolSize in interface ThreadExecutorStatsMXBean

getCurrentQueueSize

public long getCurrentQueueSize()

Description copied from interface: ThreadExecutorStatsMXBean

Returns the current queue size.

Specified by:

getCurrentQueueSize in interface ThreadExecutorStatsMXBean

getLargestQueueSize

public Long getLargestQueueSize()

Description copied from interface: ThreadExecutorStatsMXBean

Returns the largest queue size, if available.

Specified by:

getLargestQueueSize in interface ThreadExecutorStatsMXBean

getMaxQueueSize

public long getMaxQueueSize()

Description copied from interface: ThreadExecutorStatsMXBean

Returns the maximum queue size.

Specified by:

getMaxQueueSize in interface ThreadExecutorStatsMXBean

getActiveThreadCount

public long getActiveThreadCount()

Description copied from interface: ThreadExecutorStatsMXBean

Returns the active thread count.

Specified by:

getActiveThreadCount in interface ThreadExecutorStatsMXBean

getCompletedTaskCount

public long getCompletedTaskCount()

Description copied from interface: ThreadExecutorStatsMXBean

Returns the completed task count.

Specified by:

getCompletedTaskCount in interface ThreadExecutorStatsMXBean

getTotalTaskCount

public long getTotalTaskCount()

Description copied from interface: ThreadExecutorStatsMXBean

Returns the total task count.

Specified by:

getTotalTaskCount in interface ThreadExecutorStatsMXBean

getRejectedTaskCount

public Long getRejectedTaskCount()

Description copied from interface: ThreadExecutorStatsMXBean

Returns the rejected task count, if available.

Specified by:

getRejectedTaskCount in interface ThreadExecutorStatsMXBean

toThreadExecutorStats

public ThreadExecutorStats toThreadExecutorStats()

Returns a ThreadExecutorStats instance containing a snapshot of the statistic metrics.