StackUtils (prosys-opc-ua-sdk-client-server-pubsub 5.6.2-227 API)

java.lang.Object
- com.prosysopc.ua.stack.utils.StackUtils

```
public class StackUtils
extends Object
```
Utility methods for the OPC UA Java Stack.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`BLOCKING_WORK_EXECUTOR_NAME_PATTERN` Naming pattern for the `getBlockingWorkExecutor()` thread names.
`static String`	`NON_BLOCKING_WORK_EXECUTOR_NAME_PATTERN` Naming pattern for the `getNonBlockingWorkExecutor()` thread names.
`static Random`	`RANDOM` Deprecated. Use `ThreadLocalRandom` instead.
`static String`	`SELECTOR_NAME_PATTERN` Name used for the Thread of `getSelector()`.
`static int`	`TCP_PROTOCOL_VERSION` Constant `TCP_PROTOCOL_VERSION=0`
`static String`	`UA_TIMER_NAME_PATTERN` Name used for the Thread in `TimerUtil`.

Constructor Summary

Constructors
Constructor and Description

StackUtils()

Constructors
Constructor and Description
`StackUtils()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static boolean`	`barrierWait(AsyncResult<?>[] requests, long timeout)` Wait for a group to requests to go into final state
`static int`	`cores()` cores.
`static Executor`	`createBlockingWorkExecutor(String name, int maxThreadPoolSize)` Get Executor for long term and potentially blocking operations.
`static Integer`	`getAsyncSelectorThreadPriority()` See `setAsyncSelectorThreadPriority(Integer)`.
`static int`	`getBlockingWorkerThreadPoolCoreSize()` Getter for the field `blockingWorkerThreadPoolCoreSize`.
`static long`	`getBlockingWorkerThreadPoolTimeout()` Getter for the field `blockingWorkerThreadPoolTimeout`.
`static Executor`	`getBlockingWorkExecutor()` Get Executor for long term and potentially blocking operations.
`static Integer`	`getBlockingWorkExecutorThreadPriority()` See `setBlockingWorkExecutorThreadPriority(Integer)`.
`static Executor`	`getNonBlockingWorkExecutor()` Get Executor for non-blocking operations.
`static Integer`	`getNonBlockingWorkExecutorThreadPriority()` See `setNonBlockingWorkExecutorThreadPriority(Integer)`.
`static Executor`	`getRejectionExecutor()` Get Executor that handles tasks that are rejected by blocking work executor
`static UnsignedInteger`	`getSecurityTokenLifetimeMax()` Default maximum SecureChannel lifetime (in milliseconds) for `MessageSecurityMode`s other than `MessageSecurityMode.None`.
`static UnsignedInteger`	`getSecurityTokenLifetimeMin()` Default minimum SecureChannel lifetime (in milliseconds).
`static AsyncSelector`	`getSelector()` getSelector.
`static Thread.UncaughtExceptionHandler`	`getUncaughtExceptionHandler()` The handler that is called, if any of the worker threads encounter an exception that is not handled.
`static void`	`logStatus()` logStatus.
`static ThreadFactory`	`newNamedThreadFactory(String name)` newNamedThreadFactory.
`static void`	`setAsyncSelectorThreadPriority(Integer asyncSelectorThreadPriority)` Set given value is set for the Thread that `getSelector()` uses.
`static void`	`setBlockingWorkerThreadPoolCoreSize(int blockingWorkerThreadPoolCoreSize)` Setter for the field `blockingWorkerThreadPoolCoreSize`.
`static void`	`setBlockingWorkerThreadPoolTimeout(long blockingWorkerThreadPoolTimeout)` Define the timeout (in seconds) of the thread pool for BlockingWorkerExecutor.
`static void`	`setBlockingWorkExecutorThreadPriority(Integer blockingWorkExecutorThreadPriority)` Set given value is set for the Thread that `getBlockingWorkExecutor()` uses.
`static void`	`setNonBlockingWorkExecutorThreadPriority(Integer nonBlockingWorkExecutorThreadPriority)` Set given value is set for the Thread that `getNonBlockingWorkExecutor()` uses.
`static void`	`setSecurityTokenLifetimeMax(UnsignedInteger securityTokenLifetimeMax)` See `getSecurityTokenLifetimeMax()`.
`static void`	`setSecurityTokenLifetimeMin(UnsignedInteger securityTokenLifetimeMin)` See `getSecurityTokenLifetimeMin()`.
`static void`	`setUncaughtExceptionHandler(Thread.UncaughtExceptionHandler uncaughtexceptionhandler)` Define the handler that is called, if any of the worker threads encounter an exception that is not handled.
`static void`	`shutdown()` Perform a "context shutdown" to clean up the Stack resources.
`static ServiceResultException`	`toServiceResultException(Exception e)` toServiceResultException.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - RANDOM
```
@Deprecated
public static Random RANDOM
```
    Deprecated. Use ThreadLocalRandom instead.
    
    Use ThreadLocalRandom instead.
  - TCP_PROTOCOL_VERSION
```
public static final int TCP_PROTOCOL_VERSION
```
    Constant TCP_PROTOCOL_VERSION=0
    
    See Also:
    
    Constant Field Values
  - NON_BLOCKING_WORK_EXECUTOR_NAME_PATTERN
```
public static String NON_BLOCKING_WORK_EXECUTOR_NAME_PATTERN
```
    Naming pattern for the getNonBlockingWorkExecutor() thread names. Can include a single %d for the number of the thread.
  - BLOCKING_WORK_EXECUTOR_NAME_PATTERN
```
public static String BLOCKING_WORK_EXECUTOR_NAME_PATTERN
```
    Naming pattern for the getBlockingWorkExecutor() thread names. Can include a single %d for the number of the thread.
  - UA_TIMER_NAME_PATTERN
```
public static String UA_TIMER_NAME_PATTERN
```
    Name used for the Thread in TimerUtil.
  - SELECTOR_NAME_PATTERN
```
public static String SELECTOR_NAME_PATTERN
```
    Name used for the Thread of getSelector().
- Constructor Detail
  - StackUtils
```
public StackUtils()
```
- Method Detail
  - barrierWait
```
public static boolean barrierWait(AsyncResult<?>[] requests,
                                  long timeout)
                           throws InterruptedException
```
    Wait for a group to requests to go into final state
    
    Parameters:
    
    requests - a group of requests
    
    timeout - timeout in seconds
    
    Returns:
    
    true if completed ok
    
    Throws:
    
    InterruptedException - if any.
  - cores
```
public static int cores()
```
    cores.
    
    Returns:
    
    a int.
  - createBlockingWorkExecutor
```
public static Executor createBlockingWorkExecutor(String name,
                                                  int maxThreadPoolSize)
```
    Get Executor for long term and potentially blocking operations. This method creates it if it didn't exist already.
  - getAsyncSelectorThreadPriority
```
public static Integer getAsyncSelectorThreadPriority()
```
    See setAsyncSelectorThreadPriority(Integer).
  - getBlockingWorkerThreadPoolCoreSize
```
public static int getBlockingWorkerThreadPoolCoreSize()
```
    Getter for the field blockingWorkerThreadPoolCoreSize.
    
    Returns:
    
    the core size of the thread pool for BlockingWorkerExecutor.
  - getBlockingWorkerThreadPoolTimeout
```
public static long getBlockingWorkerThreadPoolTimeout()
```
    Getter for the field blockingWorkerThreadPoolTimeout.
    
    Returns:
    
    the timeout in seconds of the thread pool for BlockingWorkerExecutor.
  - getBlockingWorkExecutor
```
public static Executor getBlockingWorkExecutor()
```
    Get Executor for long term and potentially blocking operations.
    Calls getBlockingWorkExecutor(getDefaultMaxBlockingWorkerThreadPoolSize())
    
    Returns:
    
    executor for blocking operations
  - getBlockingWorkExecutorThreadPriority
```
public static Integer getBlockingWorkExecutorThreadPriority()
```
    See setBlockingWorkExecutorThreadPriority(Integer).
  - getNonBlockingWorkExecutor
```
public static Executor getNonBlockingWorkExecutor()
```
    Get Executor for non-blocking operations. This executor has one thread for one core in the system.
    
    Returns:
    
    Executor that executes non-blocking short term operations.
  - getNonBlockingWorkExecutorThreadPriority
```
public static Integer getNonBlockingWorkExecutorThreadPriority()
```
    See setNonBlockingWorkExecutorThreadPriority(Integer).
  - getRejectionExecutor
```
public static Executor getRejectionExecutor()
```
    Get Executor that handles tasks that are rejected by blocking work executor
    
    Returns:
    
    the executor
  - getSecurityTokenLifetimeMax
```
public static UnsignedInteger getSecurityTokenLifetimeMax()
```
    Default maximum SecureChannel lifetime (in milliseconds) for MessageSecurityModes other than MessageSecurityMode.None. Default is 3600000 i.e. one hour. This is used to revise values the Client gives in OpenSecureChannelRequest.getRequestedLifetime() to the Server.
  - getSecurityTokenLifetimeMin
```
public static UnsignedInteger getSecurityTokenLifetimeMin()
```
    Default minimum SecureChannel lifetime (in milliseconds). Default is 600000 i.e. 10 minutes. This is used to revise values the Client gives in OpenSecureChannelRequest.getRequestedLifetime() to the Server.
  - getSelector
```
public static AsyncSelector getSelector()
```
    getSelector.
    
    Returns:
    
    a AsyncSelector object.
  - getUncaughtExceptionHandler
```
public static Thread.UncaughtExceptionHandler getUncaughtExceptionHandler()
```
    The handler that is called, if any of the worker threads encounter an exception that is not handled.
    
    Returns:
    
    the uncaughtexceptionhandler
  - logStatus
```
public static void logStatus()
```
    logStatus.
  - newNamedThreadFactory
```
public static ThreadFactory newNamedThreadFactory(String name)
```
    newNamedThreadFactory.
    
    Parameters:
    
    name - a String object.
    
    Returns:
    
    a ThreadFactory object.
  - setAsyncSelectorThreadPriority
```
public static void setAsyncSelectorThreadPriority(Integer asyncSelectorThreadPriority)
```
    Set given value is set for the Thread that getSelector() uses. Values must be between Thread.MIN_PRIORITY and Thread.MAX_PRIORITY. If null is given (is also the default value), then the Threads use default priority. IMPORTANT! Must be called before other calls to the SDK, otherwise the set values are only used after shutdown() is called.
  - setBlockingWorkerThreadPoolCoreSize
```
public static void setBlockingWorkerThreadPoolCoreSize(int blockingWorkerThreadPoolCoreSize)
```
    Setter for the field blockingWorkerThreadPoolCoreSize.
    
    Parameters:
    
    blockingWorkerThreadPoolCoreSize - a int.
  - setBlockingWorkerThreadPoolTimeout
```
public static void setBlockingWorkerThreadPoolTimeout(long blockingWorkerThreadPoolTimeout)
```
    Define the timeout (in seconds) of the thread pool for BlockingWorkerExecutor.
    Default: 3
    
    Parameters:
    
    blockingWorkerThreadPoolTimeout - a long.
  - setBlockingWorkExecutorThreadPriority
```
public static void setBlockingWorkExecutorThreadPriority(Integer blockingWorkExecutorThreadPriority)
```
    Set given value is set for the Thread that getBlockingWorkExecutor() uses. Values must be between Thread.MIN_PRIORITY and Thread.MAX_PRIORITY. If null is given (is also the default value), then the Threads use default priority. IMPORTANT! Must be called before other calls to the SDK, otherwise the set values are only used after shutdown() is called.
  - setNonBlockingWorkExecutorThreadPriority
```
public static void setNonBlockingWorkExecutorThreadPriority(Integer nonBlockingWorkExecutorThreadPriority)
```
    Set given value is set for the Thread that getNonBlockingWorkExecutor() uses. Values must be between Thread.MIN_PRIORITY and Thread.MAX_PRIORITY. If null is given (is also the default value), then the Threads use default priority. IMPORTANT! Must be called before other calls to the SDK, otherwise the set values are only used after shutdown() is called.
  - setSecurityTokenLifetimeMax
```
public static void setSecurityTokenLifetimeMax(UnsignedInteger securityTokenLifetimeMax)
```
    See getSecurityTokenLifetimeMax(). Throws IllegalArgumentException if given null.
  - setSecurityTokenLifetimeMin
```
public static void setSecurityTokenLifetimeMin(UnsignedInteger securityTokenLifetimeMin)
```
    See getSecurityTokenLifetimeMin(). Throws IllegalArgumentException if given null.
  - setUncaughtExceptionHandler
```
public static void setUncaughtExceptionHandler(Thread.UncaughtExceptionHandler uncaughtexceptionhandler)
```
    Define the handler that is called, if any of the worker threads encounter an exception that is not handled.
    The default handler will just log the exception with ERROR level to the log.
    Set the handler to provide custom behavior in your application.
    The handler is set when new worker threads are started and setting the value will not affect already running threads.
    
    Parameters:
    
    uncaughtexceptionhandler - the uncaughtexceptionhandler to set
  - shutdown
```
public static void shutdown()
```
    Perform a "context shutdown" to clean up the Stack resources. Necessary for web service modules, etc.
    Shuts down BLOCKING_EXECUTOR and NON_BLOCKING_EXECUTOR, closes SELECTOR and cancels TimerUtil.getTimer().
  - toServiceResultException
```
public static ServiceResultException toServiceResultException(Exception e)
```
    toServiceResultException.
    
    Parameters:
    
    e - a Exception object.
    
    Returns:
    
    a ServiceResultException object.

Class StackUtils

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

RANDOM

TCP_PROTOCOL_VERSION

NON_BLOCKING_WORK_EXECUTOR_NAME_PATTERN

BLOCKING_WORK_EXECUTOR_NAME_PATTERN

UA_TIMER_NAME_PATTERN

SELECTOR_NAME_PATTERN

Constructor Detail

StackUtils

Method Detail

barrierWait

cores

createBlockingWorkExecutor

getAsyncSelectorThreadPriority

getBlockingWorkerThreadPoolCoreSize

getBlockingWorkerThreadPoolTimeout

getBlockingWorkExecutor

getBlockingWorkExecutorThreadPriority

getNonBlockingWorkExecutor

getNonBlockingWorkExecutorThreadPriority

getRejectionExecutor

getSecurityTokenLifetimeMax

getSecurityTokenLifetimeMin

getSelector

getUncaughtExceptionHandler

logStatus

newNamedThreadFactory

setAsyncSelectorThreadPriority

setBlockingWorkerThreadPoolCoreSize

setBlockingWorkerThreadPoolTimeout

setBlockingWorkExecutorThreadPriority

setNonBlockingWorkExecutorThreadPriority

setSecurityTokenLifetimeMax

setSecurityTokenLifetimeMin

setUncaughtExceptionHandler

shutdown

toServiceResultException