Handler (OnixS CME iLink3 Handler Parent 1.0.8 API)

java.lang.Object
- biz.onixs.cme.ilink3.handler.Handler

```
public class Handler
extends Object
```
Handler singleton class.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Handler.ErrorArgs` Error event arguments.
`static interface`	`Handler.ErrorListener` Handler error listener interface.
`static class`	`Handler.ErrorReason` Handler error reason.
`static class`	`Handler.State` Handler state.
`static class`	`Handler.StateChangedArgs` State changed event arguments.
`static interface`	`Handler.StateChangedListener` Handler state changed listener interface.
`static class`	`Handler.WarningArgs` Warning event arguments.
`static interface`	`Handler.WarningListener` Handler warning listener interface.
`static class`	`Handler.WarningReason` Handler warning reason.

Field Summary

Fields
Modifier and Type	Field and Description
`static Handler.ErrorListener`	`NULL_ERROR_LISTENER`
`static Handler.StateChangedListener`	`NULL_STATE_CHANGED_LISTENER`
`static Handler.WarningListener`	`NULL_WARNING_LISTENER`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addThreadStartedListener(ThreadStartedListener listener)` Adds thread started listener.
`static Handler.ErrorListener`	`getErrorListener()` Returns error listener.
`static Handler`	`getInstance()` The instance of the handler.
`License`	`getLicense()`
`String`	`getProductName()` Returns product name
`String`	`getProductNameAndVersion()` Returns product name and version
`String`	`getProductVersion()` Returns handler version
`HandlerSettings`	`getSettings()` Returns handler settings.
`static Handler.StateChangedListener`	`getStateChangedListener()` Returns state changed listener.
`StorageRepositoryManager`	`getStorageRepositoryManager()`
`static Handler.WarningListener`	`getWarningListener()` Returns warning listener.
`static Handler`	`init()` Initializes the handler by default values.
`static Handler`	`init(HandlerSettings settings)` Initializes the handler by `HandlerSettings`.
`static Handler`	`init(Properties settings)` Initializes the handler by `Properties`.
`static Handler`	`init(Settings settings)` Initializes the handler by `Settings`.
`static boolean`	`isInited()` Verify whether handler is inited.
`static boolean`	`isNotInited()` Verify whether handler is inited.
`void`	`removeThreadStartedListener(ThreadStartedListener listener)` Removes thread started listener.
`static void`	`setErrorListener(Handler.ErrorListener listener)` Sets error listener.
`static void`	`setStateChangedListener(Handler.StateChangedListener listener)` Sets state changed listener.
`static void`	`setWarningListener(Handler.WarningListener listener)` Sets warning listener.
`void`	`shutdown()` Shut downs the handler.
`String`	`toString()`
`static void`	`verifyHandlerInited()` Verifies that handler inited
`static void`	`verifyHandlerNotInited()` Verifies that handler is not inited

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

- Field Detail
  - NULL_STATE_CHANGED_LISTENER
```
public static final Handler.StateChangedListener NULL_STATE_CHANGED_LISTENER
```
  - NULL_WARNING_LISTENER
```
public static final Handler.WarningListener NULL_WARNING_LISTENER
```
  - NULL_ERROR_LISTENER
```
public static final Handler.ErrorListener NULL_ERROR_LISTENER
```
- Method Detail
  - init
```
public static Handler init()
```
    Initializes the handler by default values.
    Must be called before any other method of the library.
    
    Returns:
    
    instance of the Handler.
  - init
```
public static Handler init(Properties settings)
```
    Initializes the handler by Properties.
    Must be called before any other method of the library.
    
    Parameters:
    
    settings - Configuration settings.
    
    Returns:
    
    instance of the Handler.
  - init
```
public static Handler init(Settings settings)
```
    Initializes the handler by Settings.
    Must be called before any other method of the library.
    
    Parameters:
    
    settings - Configuration settings.
    
    Returns:
    
    instance of the Handler.
  - init
```
public static Handler init(HandlerSettings settings)
```
    Initializes the handler by HandlerSettings.
    Must be called before any other method of the library.
    
    Parameters:
    
    settings - Handler configuration settings
    
    Returns:
    
    instance of the Handler.
  - shutdown
```
public void shutdown()
```
    Shut downs the handler.
  - getInstance
```
public static Handler getInstance()
```
    The instance of the handler.
    
    Returns:
    
    The instance of the handler.
  - isInited
```
public static boolean isInited()
```
    Verify whether handler is inited.
    
    Returns:
    
    handler inited status
  - isNotInited
```
public static boolean isNotInited()
```
    Verify whether handler is inited.
    
    Returns:
    
    handler inited status
  - verifyHandlerInited
```
public static void verifyHandlerInited()
```
    Verifies that handler inited
    
    Throws:
    
    HandlerException - if handler is not inited
  - verifyHandlerNotInited
```
public static void verifyHandlerNotInited()
```
    Verifies that handler is not inited
    
    Throws:
    
    HandlerException - if handler is inited
  - getStateChangedListener
```
public static Handler.StateChangedListener getStateChangedListener()
```
    Returns state changed listener.
    
    Returns:
    
    state changed listener
  - setStateChangedListener
```
public static void setStateChangedListener(Handler.StateChangedListener listener)
```
    Sets state changed listener.
    Warning. This is critical to avoid time-consuming tasks inside the listener.
    
    Parameters:
    
    listener - state change listener or NULL_STATE_CHANGED_LISTENER value to reset listener to default
  - getWarningListener
```
public static Handler.WarningListener getWarningListener()
```
    Returns warning listener.
    
    Returns:
    
    warning listener
  - setWarningListener
```
public static void setWarningListener(Handler.WarningListener listener)
```
    Sets warning listener.
    Warning. This is critical to avoid time-consuming tasks inside the listener.
    
    Parameters:
    
    listener - warning listener or NULL_WARNING_LISTENER value to reset listener to default
  - getErrorListener
```
public static Handler.ErrorListener getErrorListener()
```
    Returns error listener.
    
    Returns:
    
    error listener
  - setErrorListener
```
public static void setErrorListener(Handler.ErrorListener listener)
```
    Sets error listener.
    Warning. This is critical to avoid time-consuming tasks inside the listener.
    
    Parameters:
    
    listener - error listener or NULL_ERROR_LISTENER value to reset listener to default
  - addThreadStartedListener
```
public void addThreadStartedListener(ThreadStartedListener listener)
```
    Adds thread started listener.
    Warning. This is critical to avoid time-consuming tasks inside the listener.
    
    Parameters:
    
    listener - thread started listener
  - removeThreadStartedListener
```
public void removeThreadStartedListener(ThreadStartedListener listener)
```
    Removes thread started listener.
    
    Parameters:
    
    listener - thread started listener
  - getSettings
```
public HandlerSettings getSettings()
```
    Returns handler settings.
    
    Returns:
    
    the handler settings
  - getStorageRepositoryManager
```
public StorageRepositoryManager getStorageRepositoryManager()
```
  - getLicense
```
public License getLicense()
```
  - getProductVersion
```
public String getProductVersion()
```
    Returns handler version
    
    Returns:
    
    Handler version
  - getProductName
```
public String getProductName()
```
    Returns product name
    
    Returns:
    
    product name
  - getProductNameAndVersion
```
public String getProductNameAndVersion()
```
    Returns product name and version
    
    Returns:
    
    product name and version
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Handler

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NULL_STATE_CHANGED_LISTENER

NULL_WARNING_LISTENER

NULL_ERROR_LISTENER

Method Detail

init

init

init

init

shutdown

getInstance

isInited

isNotInited

verifyHandlerInited

verifyHandlerNotInited

getStateChangedListener

setStateChangedListener

getWarningListener

setWarningListener

getErrorListener

setErrorListener

addThreadStartedListener

removeThreadStartedListener

getSettings

getStorageRepositoryManager

getLicense

getProductVersion

getProductName

getProductNameAndVersion

toString