cn.hippo4j.core.plugin.manager

接口 ThreadPoolPluginManager

所有已知子接口:

ThreadPoolPluginSupport

所有已知实现类:

DefaultThreadPoolPluginManager, DynamicThreadPoolExecutor, EmptyThreadPoolPluginManager, ExtensibleThreadPoolExecutor

public interface ThreadPoolPluginManager

Manager of ThreadPoolPlugin. Bind with the specified thread-pool instance to register and manage plugins. when the thread pool is destroyed, please ensure that the manager will also be destroyed.

另请参阅:

DefaultThreadPoolPluginManager

方法概要

限定符和类型	方法和说明
void	clear() Clear all.
static ThreadPoolPluginManager	empty() Get an empty manager.
default Collection<PluginRuntime>	getAllPluginRuntimes() Get PluginRuntime of all registered plugins.
Collection<ThreadPoolPlugin>	getAllPlugins() Get all registered plugins.
default <A extends ThreadPoolPlugin> Collection<A>	getAllPluginsOfType(Class<A> pluginType) Get all plugins of type.
Collection<ExecuteAwarePlugin>	getExecuteAwarePluginList() Get execute aware plugin list.
<A extends ThreadPoolPlugin> Optional<A>	getPlugin(String pluginId) Get ThreadPoolPlugin.
default <A extends ThreadPoolPlugin> Optional<A>	getPluginOfType(String pluginId, Class<A> pluginType) Get plugin of type.
Collection<RejectedAwarePlugin>	getRejectedAwarePluginList() Get rejected aware plugin list.
default Optional<PluginRuntime>	getRuntime(String pluginId) Get PluginRuntime of registered plugin.
Collection<ShutdownAwarePlugin>	getShutdownAwarePluginList() Get shutdown aware plugin list.
Collection<TaskAwarePlugin>	getTaskAwarePluginList() Get shutdown aware plugin list.
boolean	isRegistered(String pluginId) Whether the ThreadPoolPlugin has been registered.
void	register(ThreadPoolPlugin plugin) Register a ThreadPoolPlugin.
boolean	tryRegister(ThreadPoolPlugin plugin) Register plugin if it's not registered.
void	unregister(String pluginId) Unregister ThreadPoolPlugin.

方法详细资料

empty

static ThreadPoolPluginManager empty()

Get an empty manager.

返回:

EmptyThreadPoolPluginManager

clear

void clear()

Clear all.

getAllPlugins

Collection<ThreadPoolPlugin> getAllPlugins()

Get all registered plugins.

返回:

plugins

register

void register(ThreadPoolPlugin plugin)

Register a ThreadPoolPlugin.

参数:

plugin - plugin

抛出:

IllegalArgumentException - thrown when a plugin with the same ThreadPoolPlugin.getId() already exists in the registry

另请参阅:

ThreadPoolPlugin.getId()

tryRegister

boolean tryRegister(ThreadPoolPlugin plugin)

Register plugin if it's not registered.

参数:

plugin - plugin

返回:

return true if successful register new plugin, false otherwise

isRegistered

boolean isRegistered(String pluginId)

Whether the ThreadPoolPlugin has been registered.

参数:

pluginId - plugin id

返回:

ture if target has been registered, false otherwise

unregister

void unregister(String pluginId)

Unregister ThreadPoolPlugin.

参数:

pluginId - plugin id

getPlugin

<A extends ThreadPoolPlugin> Optional<A> getPlugin(String pluginId)

Get ThreadPoolPlugin.

类型参数:

A - target aware type

参数:

pluginId - plugin id

返回:

ThreadPoolPlugin

抛出:

ClassCastException - thrown when the object obtained by name cannot be converted to target type

getExecuteAwarePluginList

Collection<ExecuteAwarePlugin> getExecuteAwarePluginList()

Get execute aware plugin list.

返回:

ExecuteAwarePlugin

getRejectedAwarePluginList

Collection<RejectedAwarePlugin> getRejectedAwarePluginList()

Get rejected aware plugin list.

返回:

RejectedAwarePlugin

getShutdownAwarePluginList

Collection<ShutdownAwarePlugin> getShutdownAwarePluginList()

Get shutdown aware plugin list.

返回:

ShutdownAwarePlugin

getTaskAwarePluginList

Collection<TaskAwarePlugin> getTaskAwarePluginList()

Get shutdown aware plugin list.

返回:

ShutdownAwarePlugin

getPluginOfType

default <A extends ThreadPoolPlugin> Optional<A> getPluginOfType(String pluginId,
                                                                 Class<A> pluginType)

Get plugin of type.

参数:

pluginId - plugin id

pluginType - plugin type

返回:

target plugin

getAllPluginsOfType

default <A extends ThreadPoolPlugin> Collection<A> getAllPluginsOfType(Class<A> pluginType)

Get all plugins of type.

参数:

pluginType - plugin type

返回:

all plugins of type

getAllPluginRuntimes

default Collection<PluginRuntime> getAllPluginRuntimes()

Get PluginRuntime of all registered plugins.

返回:

PluginRuntime of all registered plugins

getRuntime

default Optional<PluginRuntime> getRuntime(String pluginId)

Get PluginRuntime of registered plugin.

返回:

PluginRuntime of registered plugin