Interface QThreadPoolExecutorMBean

All Superinterfaces:

QBean, QBeanSupportMBean, QPersist

All Known Implementing Classes:

QThreadPoolExecutor

public interface QThreadPoolExecutorMBean
extends QBeanSupportMBean

JMX management interface for the Q2 thread-pool executor QBean.

Field Summary

Fields inherited from interface QBean

DESTROYED, FAILED, STARTED, STARTING, stateString, STOPPED, STOPPING

Modifier and Type	Field	Description
static final int	DESTROYED	QBean has been destroyed.
static final int	FAILED	QBean has failed.
static final int	STARTED	QBean is running.
static final int	STARTING	QBean is in the process of starting.
static final String[]	stateString	Human-readable names for each QBean state, indexed by state constant.
static final int	STOPPED	QBean is stopped.
static final int	STOPPING	QBean is in the process of stopping.

Method Summary

Modifier and Type	Method	Description
int	getActiveCount()	Returns the approximate number of threads that are actively executing tasks.
long	getCompletedTaskCount()	Returns the approximate total number of tasks that have completed execution.
int	getCorePoolSize()	Returns the core number of threads.
String	getExecSrvType()	Returns the executor service type.
long	getKeepAliveTimeMS()	Returns the thread keep-alive time in milliseconds.
int	getLargestPoolSize()	Returns the largest number of threads that have ever simultaneously been in the pool.
int	getMaximumPoolSize()	Returns the maximum allowed number of threads.
int	getPoolSize()	Returns the current number of threads in the pool.
long	getTaskCount()	Returns the approximate total number of tasks that have been scheduled for execution.
int	getTerminationTimer()	Returns the await-termination delay in milliseconds.
boolean	isShutdown()	Returns whether this executor has been shut down.
boolean	isTerminated()	Returns whether all tasks have completed following shut down.
boolean	isTerminating()	Returns whether this executor is in the process of terminating after shutdown.

Methods inherited from interface QBean

destroy, getState, getStateAsString, init, start, stop

Modifier and Type	Method	Description
void	destroy()	destroy the service
int	getState()	Returns the current state of this QBean.
default String	getStateAsString()	Returns the current state as a human-readable string.
void	init()	init the service
void	start()	start the service
void	stop()	stop the service

Methods inherited from interface QBeanSupportMBean

getDump, getLoader, getLoaderURLS, getLogger, getName, getRealm, getServer, setLogger, setName, setPersist, setRealm, setServer

Modifier and Type	Method	Description
String	getDump()	Returns a human-readable dump of this bean's state.
QClassLoader	getLoader()	Returns the QClassLoader for this bean.
URL[]	getLoaderURLS()	Returns the URLs registered with the class loader.
String	getLogger()	Returns the logger name.
String	getName()	Returns the bean name.
String	getRealm()	Returns the logging realm.
Q2	getServer()	Returns the Q2 server instance.
void	setLogger(String name)	Sets the logger by name.
void	setName(String name)	Sets the bean name.
void	setPersist(org.jdom2.Element e)	Sets the persistent configuration element.
void	setRealm(String realm)	Sets the logging realm.
void	setServer(Q2 server)	Sets the Q2 server instance for this QBean.

Methods inherited from interface QPersist

getPersist, isModified

Modifier and Type	Method	Description
org.jdom2.Element	getPersist()	Returns the persistent configuration element for this QBean.
boolean	isModified()	Returns true if this QBean's configuration has been modified since last save.

Method Details

getExecSrvType

String getExecSrvType()

Returns the executor service type.

Returns:

executor service type

getTerminationTimer

int getTerminationTimer()

Returns the await-termination delay in milliseconds.

Returns:

await termination delay

getActiveCount

int getActiveCount()
            throws NameRegistrar.NotFoundException

Returns the approximate number of threads that are actively executing tasks.

Returns:

approximate number of threads that are actively executing tasks

Throws:

NameRegistrar.NotFoundException - if the executor cannot be found in the name registrar

getCompletedTaskCount

long getCompletedTaskCount()
                    throws NameRegistrar.NotFoundException

Returns the approximate total number of tasks that have completed execution.

Returns:

the approximate total number of tasks that have completed execution.

Throws:

NameRegistrar.NotFoundException - if the executor cannot be found in the name registrar

getCorePoolSize

int getCorePoolSize()
             throws NameRegistrar.NotFoundException

Returns the core number of threads.

Returns:

returns the core number of threads.

Throws:

NameRegistrar.NotFoundException - if the executor cannot be found in the name registrar

getKeepAliveTimeMS

long getKeepAliveTimeMS()
                 throws NameRegistrar.NotFoundException

Returns the thread keep-alive time in milliseconds.

Returns:

the thread keep-alive time, which is the amount of time (in milliseconds) which threads in excess of the core pool size may remain idle before being terminated

Throws:

NameRegistrar.NotFoundException - if the executor cannot be found in the name registrar

getLargestPoolSize

int getLargestPoolSize()
                throws NameRegistrar.NotFoundException

Returns the largest number of threads that have ever simultaneously been in the pool.

Returns:

the largest number of threads that have ever simultaneously been in the pool.

Throws:

NameRegistrar.NotFoundException - if the executor cannot be found in the name registrar

getMaximumPoolSize

int getMaximumPoolSize()
                throws NameRegistrar.NotFoundException

Returns the maximum allowed number of threads.

Returns:

the maximum allowed number of threads.

Throws:

NameRegistrar.NotFoundException - if the executor cannot be found in the name registrar

getPoolSize

int getPoolSize()
         throws NameRegistrar.NotFoundException

Returns the current number of threads in the pool.

Returns:

the current number of threads in the pool.

Throws:

NameRegistrar.NotFoundException - if the executor cannot be found in the name registrar

getTaskCount

long getTaskCount()
           throws NameRegistrar.NotFoundException

Returns the approximate total number of tasks that have been scheduled for execution.

Returns:

the approximate total number of tasks that have been scheduled for execution

Throws:

NameRegistrar.NotFoundException - if the executor cannot be found in the name registrar

isShutdown

boolean isShutdown()
            throws NameRegistrar.NotFoundException

Returns whether this executor has been shut down.

Returns:

true if this executor has been shut down.

Throws:

NameRegistrar.NotFoundException - if the executor cannot be found in the name registrar

isTerminated

boolean isTerminated()
              throws NameRegistrar.NotFoundException

Returns whether all tasks have completed following shut down.

Returns:

true if all tasks have completed following shut down

Throws:

NameRegistrar.NotFoundException - if the executor cannot be found in the name registrar

isTerminating

boolean isTerminating()
               throws NameRegistrar.NotFoundException

Returns whether this executor is in the process of terminating after shutdown.

Returns:

true if this executor is in the process of terminating after shutdown or shutdownNow but has not completely terminated.

Throws:

NameRegistrar.NotFoundException - if the executor cannot be found in the name registrar