org.apache.sshd.common.util.threads

Class ThreadUtils

java.lang.Object

org.apache.sshd.common.util.threads.ThreadUtils

public final class ThreadUtils
extends Object

Utility class for thread pools.

Author:

Apache MINA SSHD Project

Method Summary

Modifier and Type	Method and Description
static <T> T	createDefaultInstance(Class<?> anchor, Class<? extends T> targetType, String className)
static <T> T	createDefaultInstance(ClassLoader cl, Class<? extends T> targetType, String className)
static <T> T	createDefaultInstance(Iterable<? extends ClassLoader> cls, Class<? extends T> targetType, String className)
static boolean	isInternalThread() Tells whether the calling thread is an Apache MINA sshd framework-internal thread.
static Iterator<ClassLoader>	iterateDefaultClassLoaders(Class<?> anchor)
static CloseableExecutorService	newCachedThreadPool(String poolName)
static CloseableExecutorService	newCachedThreadPoolIf(CloseableExecutorService executorService, String poolName)
static CloseableExecutorService	newFixedThreadPool(String poolName, int nThreads)
static CloseableExecutorService	newFixedThreadPoolIf(CloseableExecutorService executorService, String poolName, int nThreads)
static CloseableExecutorService	newSingleThreadExecutor(String poolName)
static ScheduledExecutorService	newSingleThreadScheduledExecutor(String poolName)
static CloseableExecutorService	noClose(CloseableExecutorService executorService)
static CloseableExecutorService	protectExecutorServiceShutdown(CloseableExecutorService executorService, boolean shutdownOnExit) Wraps an CloseableExecutorService in such a way as to "protect" it for calls to the ExecutorService.shutdown() or ExecutorService.shutdownNow().
static Class<?>	resolveDefaultClass(Class<?> anchor, String className)
static Class<?>	resolveDefaultClass(Iterable<? extends ClassLoader> cls, String className)
static ClassLoader	resolveDefaultClassLoader(Class<?> anchor) Attempts to find the most suitable ClassLoader as follows:
static ClassLoader	resolveDefaultClassLoader(Object anchor)
static Iterable<ClassLoader>	resolveDefaultClassLoaders(Class<?> anchor)
static Iterable<ClassLoader>	resolveDefaultClassLoaders(Object anchor)
static <V> V	runAsInternal(Callable<V> code) Runs a piece of code given as a Callable with a flag set indicating that the executing thread is an Apache MINA sshd framework-internal thread.
static <T,V> V	runAsInternal(T param, IOFunction<? super T,V> code) Runs an IOFunction with a flag set indicating that the executing thread is an Apache MINA sshd framework-internal thread.

Methods inherited from class java.lang.Object

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

Method Detail

runAsInternal

public static <V> V runAsInternal(Callable<V> code)
                           throws Exception

Runs a piece of code given as a Callable with a flag set indicating that the executing thread is an Apache MINA sshd framework-internal thread.

Type Parameters:

V - return type

Parameters:

code - code to run

Returns:

the result of code

Throws:

Exception - propagated from code.call()

See Also:

isInternalThread()

runAsInternal

public static <T,V> V runAsInternal(T param,
                                    IOFunction<? super T,V> code)
                             throws IOException

Runs an IOFunction with a flag set indicating that the executing thread is an Apache MINA sshd framework-internal thread.

Type Parameters:

T - parameter type

V - return type

Parameters:

param - parameter for the function

code - function to run

Returns:

the result of code

Throws:

IOException - propagated from code.apply()

See Also:

isInternalThread()

isInternalThread

public static boolean isInternalThread()

Tells whether the calling thread is an Apache MINA sshd framework-internal thread.

Returns:

true if the thread is considered internal to the framework; false if not

See Also:

runAsInternal(Callable)

protectExecutorServiceShutdown

public static CloseableExecutorService protectExecutorServiceShutdown(CloseableExecutorService executorService,
                                                                      boolean shutdownOnExit)

Wraps an CloseableExecutorService in such a way as to "protect" it for calls to the ExecutorService.shutdown() or ExecutorService.shutdownNow(). All other calls are delegated as-is to the original service. Note: the exposed wrapped proxy will answer correctly the ExecutorService.isShutdown() query if indeed one of the shutdown methods was invoked.

Parameters:

executorService - The original service - ignored if null

shutdownOnExit - If true then it is OK to shutdown the executor so no wrapping takes place.

Returns:

Either the original service or a wrapped one - depending on the value of the shutdownOnExit parameter

noClose

public static CloseableExecutorService noClose(CloseableExecutorService executorService)

resolveDefaultClassLoader

public static ClassLoader resolveDefaultClassLoader(Object anchor)

resolveDefaultClassLoaders

public static Iterable<ClassLoader> resolveDefaultClassLoaders(Object anchor)

resolveDefaultClassLoaders

public static Iterable<ClassLoader> resolveDefaultClassLoaders(Class<?> anchor)

resolveDefaultClass

public static Class<?> resolveDefaultClass(Class<?> anchor,
                                           String className)

resolveDefaultClass

public static Class<?> resolveDefaultClass(Iterable<? extends ClassLoader> cls,
                                           String className)

createDefaultInstance

public static <T> T createDefaultInstance(Class<?> anchor,
                                          Class<? extends T> targetType,
                                          String className)
                                   throws ReflectiveOperationException

Throws:

ReflectiveOperationException

createDefaultInstance

public static <T> T createDefaultInstance(ClassLoader cl,
                                          Class<? extends T> targetType,
                                          String className)
                                   throws ReflectiveOperationException

Throws:

ReflectiveOperationException

createDefaultInstance

public static <T> T createDefaultInstance(Iterable<? extends ClassLoader> cls,
                                          Class<? extends T> targetType,
                                          String className)
                                   throws ReflectiveOperationException

Throws:

ReflectiveOperationException

resolveDefaultClassLoader

public static ClassLoader resolveDefaultClassLoader(Class<?> anchor)

Attempts to find the most suitable ClassLoader as follows:

• Check the Thread.getContextClassLoader() value

• If no thread context class loader then check the anchor class (if given) for its class loader

• If still no loader available, then use ClassLoader.getSystemClassLoader()

Parameters:

anchor - The anchor Class to use if no current thread context class loader - ignored if null

Returns:

The resolved ClassLoader - Note: might still be null if went all the way "down" to the system class loader and it was also null.

iterateDefaultClassLoaders

public static Iterator<ClassLoader> iterateDefaultClassLoaders(Class<?> anchor)

newFixedThreadPoolIf

public static CloseableExecutorService newFixedThreadPoolIf(CloseableExecutorService executorService,
                                                            String poolName,
                                                            int nThreads)

newFixedThreadPool

public static CloseableExecutorService newFixedThreadPool(String poolName,
                                                          int nThreads)

newCachedThreadPoolIf

public static CloseableExecutorService newCachedThreadPoolIf(CloseableExecutorService executorService,
                                                             String poolName)

newCachedThreadPool

public static CloseableExecutorService newCachedThreadPool(String poolName)

newSingleThreadScheduledExecutor

public static ScheduledExecutorService newSingleThreadScheduledExecutor(String poolName)

newSingleThreadExecutor

public static CloseableExecutorService newSingleThreadExecutor(String poolName)