Apache Mina SSHD 2.15.0 · org.apache.sshd.common.util.threads.ThreadUtils

Modifier and Type	Field and Description
private static final ThreadLocal<Boolean>	IS_INTERNAL_THREAD Marks framework-internal threads.

Access	Constructor and Description
private	ThreadUtils()

Method Summary

Modifier and Type	Method and Description
public static <T> T	createDefaultInstance(Class<?> anchor, Class<? extends T> targetType, String className)
public static <T> T	createDefaultInstance(ClassLoader cl, Class<? extends T> targetType, String className)
public static <T> T	createDefaultInstance(Iterable<? extends ClassLoader> cls, Class<? extends T> targetType, String className)
public static boolean	Returns: `true` if the thread is considered internal to the framework; `false` if not isInternalThread() Tells whether the calling thread is an Apache MINA sshd framework-internal thread.
public static Iterator<ClassLoader>	iterateDefaultClassLoaders(Class<?> anchor)
public static CloseableExecutorService	newCachedThreadPool(String poolName)
public static CloseableExecutorService	newCachedThreadPoolIf(CloseableExecutorService executorService, String poolName)
public static CloseableExecutorService	newFixedThreadPool(String poolName, int nThreads)
public static CloseableExecutorService	newFixedThreadPoolIf(CloseableExecutorService executorService, String poolName, int nThreads)
public static CloseableExecutorService	newSingleThreadExecutor(String poolName)
public static ScheduledExecutorService	newSingleThreadScheduledExecutor(String poolName)
public static CloseableExecutorService	noClose(CloseableExecutorService executorService)
public static CloseableExecutorService	Returns: Either the original service or a wrapped one - depending on the value of the `shutdownOnExit` parameter protectExecutorServiceShutdown(CloseableExecutorService The original service - ignored if `null` executorService, boolean If `true` then it is OK to shutdown the executor so no wrapping takes place. shutdownOnExit) Wraps an `CloseableExecutorService` in such a way as to "protect" it for calls to the `CloseableExecutorService#shutdown()` or `CloseableExecutorService#shutdownNow()`.
public static Class<?>	resolveDefaultClass(Class<?> anchor, String className)
public static Class<?>	resolveDefaultClass(Iterable<? extends ClassLoader> cls, String className)
public static ClassLoader	resolveDefaultClassLoader(Object anchor)
public static ClassLoader	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`. resolveDefaultClassLoader(Class<?> The anchor `Class` to use if no current thread context class loader - ignored if `null` 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()`
public static Iterable<ClassLoader>	resolveDefaultClassLoaders(Object anchor)
public static Iterable<ClassLoader>	resolveDefaultClassLoaders(Class<?> anchor)
public static < return type V> V	Returns: the result of `code` runAsInternal(Callable<V> code to run 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.
public static < parameter type T, return type V> V	Returns: the result of `code` runAsInternal(T parameter for the function param, IOFunction<? super T, V> function to run code) Runs an `IOFunction` with a flag set indicating that the executing thread is an Apache MINA sshd framework-internal thread.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

IS_INTERNAL_THREAD	back to summary
private static final ThreadLocal<Boolean> IS_INTERNAL_THREAD Marks framework-internal threads.

ThreadUtils	back to summary
private ThreadUtils()

Method Detail

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

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

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

isInternalThread back to summary

isInternalThread	back to summary
public static boolean isInternalThread() Tells whether the calling thread is an Apache MINA sshd framework-internal thread. Returns:boolean `true` if the thread is considered internal to the framework; `false` if not See Also `runAsInternal(Callable)`

public static boolean isInternalThread()

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

Returns:boolean: true if the thread is considered internal to the framework; false if not
See Also: runAsInternal(Callable)

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

newCachedThreadPool	back to summary
public static CloseableExecutorService newCachedThreadPool(String poolName)

newCachedThreadPoolIf	back to summary
public static CloseableExecutorService newCachedThreadPoolIf(CloseableExecutorService executorService, String poolName)

newFixedThreadPool	back to summary
public static CloseableExecutorService newFixedThreadPool(String poolName, int nThreads)

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

newSingleThreadExecutor	back to summary
public static CloseableExecutorService newSingleThreadExecutor(String poolName)

newSingleThreadScheduledExecutor	back to summary
public static ScheduledExecutorService newSingleThreadScheduledExecutor(String poolName)

noClose	back to summary
public static CloseableExecutorService noClose(CloseableExecutorService executorService)

protectExecutorServiceShutdown back to summary

protectExecutorServiceShutdown	back to summary
public static CloseableExecutorService protectExecutorServiceShutdown(CloseableExecutorService executorService, boolean shutdownOnExit) Wraps an `CloseableExecutorService` in such a way as to "protect" it for calls to the `CloseableExecutorService#shutdown()` or `CloseableExecutorService#shutdownNow()`. All other calls are delegated as-is to the original service Note the exposed wrapped proxy will answer correctly the `CloseableExecutorService#isShutdown()` query if indeed one of the `shutdown` methods was invoked. Parameters executorService:CloseableExecutorService The original service - ignored if `null` shutdownOnExit:boolean If `true` then it is OK to shutdown the executor so no wrapping takes place. Returns:CloseableExecutorService Either the original service or a wrapped one - depending on the value of the `shutdownOnExit` parameter

public static CloseableExecutorService protectExecutorServiceShutdown(CloseableExecutorService executorService, boolean shutdownOnExit)

Wraps an CloseableExecutorService in such a way as to "protect" it for calls to the CloseableExecutorService#shutdown() or CloseableExecutorService#shutdownNow(). All other calls are delegated as-is to the original service

Note

the exposed wrapped proxy will answer correctly the CloseableExecutorService#isShutdown() query if indeed one of the shutdown methods was invoked.

Parameters

executorService:CloseableExecutorService: The original service - ignored if null
shutdownOnExit:boolean: If true then it is OK to shutdown the executor so no wrapping takes place.

Returns:CloseableExecutorService

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

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

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

resolveDefaultClassLoader	back to summary
public static ClassLoader resolveDefaultClassLoader(Object anchor)

resolveDefaultClassLoader back to summary

resolveDefaultClassLoader	back to summary
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:Class<?> The anchor `Class` to use if no current thread context class loader - ignored if `null` Returns:ClassLoader The resolved `ClassLoader` - Note: might still be `null` if went all the way "down" to the system class loader and it was also `null`.

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:Class<?>: The anchor Class to use if no current thread context class loader - ignored if null

Returns:ClassLoader

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

resolveDefaultClassLoaders	back to summary
public static Iterable<ClassLoader> resolveDefaultClassLoaders(Object anchor)

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

runAsInternal back to summary

runAsInternal	back to summary
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. Parameters <V> return type code:Callable<V> code to run Returns:V the result of `code` Exceptions Exception: propagated from `code.call()` See Also `isInternalThread()`

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.

Parameters

<V>: return type
code:Callable<V>: code to run

Returns:V

the result of code

Exceptions

Exception:: propagated from code.call()

See Also

isInternalThread()

runAsInternal back to summary

runAsInternal	back to summary
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. Parameters <T> parameter type <V> return type param:T parameter for the function code:IOFunction<? super T, V> function to run Returns:V the result of `code` Exceptions IOException: propagated from `code.apply()` See Also `isInternalThread()`

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.

Parameters

<T>: parameter type
<V>: return type
param:T: parameter for the function
code:IOFunction<? super T, V>: function to run

Returns:V

the result of code

Exceptions

IOException:: propagated from code.apply()

See Also

isInternalThread()

public final Class ThreadUtils

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail