Engine (Java FIX Engine Package 2.13.5 API)

java.lang.Object
- biz.onixs.fix.engine.Engine

```
public class Engine
extends Object
```
FIX Engine.

Nested Class Summary

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

Field Summary

Fields
Modifier and Type	Field and Description
`static Engine.DynamicAcceptorListener`	`NULL_DYNAMIC_ACCEPTOR_LISTENER` Deprecated. will be removed soon as not necessary
`static Engine.ErrorListener`	`NULL_ERROR_LISTENER`
`static Engine.StateChangedListener`	`NULL_STATE_CHANGED_LISTENER`
`static Engine.WarningListener`	`NULL_WARNING_LISTENER`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addDynamicAcceptorListener(Engine.DynamicAcceptorListener listener)` Adds dynamic acceptor event listener.
`boolean`	`addListeningPort(int port)` Adds listen port for incoming FIX connections to the engine.
`boolean`	`addSslListeningPort(int port, SSLContext sslContext)` Adds SSL listen port for secure incoming FIX connections to the engine.
`void`	`addThreadStartedListener(ThreadStartedListener listener)` Adds thread started listener.
`DictionaryManager`	`getDictionaryManager()` Returns dictionary manager.
`Engine.DynamicAcceptorListener`	`getDynamicAcceptorListener()` Deprecated. will be removed soon as not necessary
`static Engine.ErrorListener`	`getErrorListener()` Returns error listener.
`static Engine`	`getInstance()` The instance of the engine.
`License`	`getLicense()`
`String`	`getProductName()` Returns product name
`String`	`getProductNameAndVersion()` Returns product name and version
`String`	`getProductVersion()` Returns Engine version
`EngineSettings`	`getSettings()` Returns Engine settings.
`static Engine.StateChangedListener`	`getStateChangedListener()` Returns state changed listener.
`StorageRepositoryManager`	`getStorageRepositoryManager()`
`static Engine.WarningListener`	`getWarningListener()` Returns warning listener.
`static Engine`	`init()` Initializes the engine.
`static Engine`	`init(EngineSettings settings)` Initializes the engine.
`static Engine`	`init(EngineSettings settings, SessionReactor sessionReactor)` Initializes the engine.
`static Engine`	`init(int listenPort)` Initializes the engine.
`static Engine`	`init(Properties settings)` Initializes the engine.
`static Engine`	`init(Settings settings)` Initializes the engine.
`static boolean`	`isInited()` Verify whether engine is inited.
`static boolean`	`isNotInited()` Verify whether engine is inited.
`void`	`removeDynamicAcceptorListener(Engine.DynamicAcceptorListener listener)` Removes dynamic acceptor event listener.
`boolean`	`removeListeningPort(int port)` Removes listen port for incoming FIX connections from the engine (SSL ports as well).
`void`	`removeThreadStartedListener(ThreadStartedListener listener)` Removes thread started listener.
`void`	`setDynamicAcceptorListener(Engine.DynamicAcceptorListener listener)` Deprecated. will be removed soon, please use `addDynamicAcceptorListener(biz.onixs.fix.engine.Engine.DynamicAcceptorListener)` instead
`static void`	`setErrorListener(Engine.ErrorListener listener)` Sets error listener.
`static void`	`setNetworkInterface(InetSocketAddress bindAddress)` Sets the network interface bind address for establishing acceptor sessions.
`static void`	`setSSLContext(SSLContext sslContext)` Sets the SSL context for establishing secure acceptor sessions.
`static void`	`setStateChangedListener(Engine.StateChangedListener listener)` Sets state changed listener.
`static void`	`setWarningListener(Engine.WarningListener listener)` Sets warning listener.
`void`	`shutdown()` Shut downs the engine.
`String`	`toString()`
`static void`	`verifyEngineInited()` Verifies that Engine inited
`static void`	`verifyEngineNotInited()` Verifies that Engine is not inited

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

- Field Detail
  - NULL_DYNAMIC_ACCEPTOR_LISTENER
```
public static final Engine.DynamicAcceptorListener NULL_DYNAMIC_ACCEPTOR_LISTENER
```
    Deprecated. will be removed soon as not necessary
  - NULL_STATE_CHANGED_LISTENER
```
public static final Engine.StateChangedListener NULL_STATE_CHANGED_LISTENER
```
  - NULL_WARNING_LISTENER
```
public static final Engine.WarningListener NULL_WARNING_LISTENER
```
  - NULL_ERROR_LISTENER
```
public static final Engine.ErrorListener NULL_ERROR_LISTENER
```
- Method Detail
  - init
```
public static Engine init()
```
    Initializes the engine. Must be called before any other method of the library.
    
    Returns:
    
    instance of the Engine.
  - init
```
public static Engine init(Properties settings)
```
    Initializes the engine. Must be called before any other method of the library.
    
    Parameters:
    
    settings - Configuration settings (e.g. Listen Port, FIX Dialect, etc.).
    
    Returns:
    
    instance of the Engine.
  - init
```
public static Engine init(Settings settings)
```
    Initializes the engine. Must be called before any other method of the library.
    
    Parameters:
    
    settings - Configuration settings (e.g. Listen Port, FIX Dialect, etc.).
    
    Returns:
    
    instance of the Engine.
  - init
```
public static Engine init(int listenPort)
```
    Initializes the engine. Must be called before any other method of the library.
    
    Parameters:
    
    listenPort - The engine listens on this port for incoming connections. If '0' then only session-initiators can be created. If '-1' then the telecommunication level is disabled and only message parsing/assembling can be used.
    
    Returns:
    
    instance of the Engine.
  - init
```
public static Engine init(EngineSettings settings)
```
    Initializes the engine. Must be called before any other method of the library.
    
    Parameters:
    
    settings - Engine configuration settings
    
    Returns:
    
    instance of the Engine.
  - init
```
public static Engine init(EngineSettings settings,
                          SessionReactor sessionReactor)
```
    Initializes the engine. Must be called before any other method of the library.
    
    Parameters:
    
    settings - Engine configuration settings
    
    sessionReactor - an instance of an externally managed reactor for acceptor sessions.
    
    Returns:
    
    instance of the Engine.
  - shutdown
```
public void shutdown()
```
    Shut downs the engine.
  - getInstance
```
public static Engine getInstance()
```
    The instance of the engine.
    
    Returns:
    
    The instance of the engine.
  - isInited
```
public static boolean isInited()
```
    Verify whether engine is inited.
    
    Returns:
    
    engine inited status
  - isNotInited
```
public static boolean isNotInited()
```
    Verify whether engine is inited.
    
    Returns:
    
    engine inited status
  - verifyEngineInited
```
public static void verifyEngineInited()
```
    Verifies that Engine inited
    
    Throws:
    
    EngineException - if engine is not inited
  - verifyEngineNotInited
```
public static void verifyEngineNotInited()
```
    Verifies that Engine is not inited
    
    Throws:
    
    EngineException - if engine is inited
  - setSSLContext
```
public static void setSSLContext(SSLContext sslContext)
```
    Sets the SSL context for establishing secure acceptor sessions. This is effective for all acceptor sessions.
    
    Parameters:
    
    sslContext - SSL context
  - setNetworkInterface
```
public static void setNetworkInterface(InetSocketAddress bindAddress)
```
    Sets the network interface bind address for establishing acceptor sessions.
    
    Parameters:
    
    bindAddress - bind address
  - getStateChangedListener
```
public static Engine.StateChangedListener getStateChangedListener()
```
    Returns state changed listener.
    
    Returns:
    
    state changed listener
  - setStateChangedListener
```
public static void setStateChangedListener(Engine.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 Engine.WarningListener getWarningListener()
```
    Returns warning listener.
    
    Returns:
    
    warning listener
  - setWarningListener
```
public static void setWarningListener(Engine.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 Engine.ErrorListener getErrorListener()
```
    Returns error listener.
    
    Returns:
    
    error listener
  - setErrorListener
```
public static void setErrorListener(Engine.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
  - addListeningPort
```
public boolean addListeningPort(int port)
```
    Adds listen port for incoming FIX connections to the engine.
    
    Parameters:
    
    port - Listener port number to be added.
    
    Returns:
    
    true if it is successfully added, false otherwise.
  - addSslListeningPort
```
public boolean addSslListeningPort(int port,
                                   SSLContext sslContext)
```
    Adds SSL listen port for secure incoming FIX connections to the engine.
    
    Parameters:
    
    port - Listener port number to be added.
    
    sslContext - SSL context to be used for the port.
    
    Returns:
    
    true if it is successfully added, false otherwise.
  - removeListeningPort
```
public boolean removeListeningPort(int port)
```
    Removes listen port for incoming FIX connections from the engine (SSL ports as well).
    
    Parameters:
    
    port - Listener port number to be removed.
    
    Returns:
    
    true if it is successfully removed, false otherwise.
  - addDynamicAcceptorListener
```
public void addDynamicAcceptorListener(Engine.DynamicAcceptorListener listener)
```
    Adds dynamic acceptor event listener. Warning. This is critical to avoid time-consuming tasks inside the listener.
    
    Parameters:
    
    listener - listener to add
    
    See Also:
    
    removeDynamicAcceptorListener(biz.onixs.fix.engine.Engine.DynamicAcceptorListener)
  - removeDynamicAcceptorListener
```
public void removeDynamicAcceptorListener(Engine.DynamicAcceptorListener listener)
```
    Removes dynamic acceptor event listener.
    
    Parameters:
    
    listener - listener to remove
  - getDynamicAcceptorListener
```
public Engine.DynamicAcceptorListener getDynamicAcceptorListener()
```
    Deprecated. will be removed soon as not necessary
    
    Returns dynamic acceptor event listener.
    
    Returns:
    
    listener
  - setDynamicAcceptorListener
```
public void setDynamicAcceptorListener(Engine.DynamicAcceptorListener listener)
```
    Deprecated. will be removed soon, please use addDynamicAcceptorListener(biz.onixs.fix.engine.Engine.DynamicAcceptorListener) instead
    
    Sets dynamic acceptor event listener. Warning. This is critical to avoid time-consuming tasks inside the listener.
    
    Parameters:
    
    listener - listener to set
  - getSettings
```
public EngineSettings getSettings()
```
    Returns Engine settings.
    
    Returns:
    
    the Engine settings
  - getDictionaryManager
```
public DictionaryManager getDictionaryManager()
```
    Returns dictionary manager.
    
    Returns:
    
    dictionary manager
  - getStorageRepositoryManager
```
public StorageRepositoryManager getStorageRepositoryManager()
```
  - getLicense
```
public License getLicense()
```
  - getProductVersion
```
public String getProductVersion()
```
    Returns Engine version
    
    Returns:
    
    Engine 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 Engine

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NULL_DYNAMIC_ACCEPTOR_LISTENER

NULL_STATE_CHANGED_LISTENER

NULL_WARNING_LISTENER

NULL_ERROR_LISTENER

Method Detail

init

init

init

init

init

init

shutdown

getInstance

isInited

isNotInited

verifyEngineInited

verifyEngineNotInited

setSSLContext

setNetworkInterface

getStateChangedListener

setStateChangedListener

getWarningListener

setWarningListener

getErrorListener

setErrorListener

addThreadStartedListener

removeThreadStartedListener

addListeningPort

addSslListeningPort

removeListeningPort

addDynamicAcceptorListener

removeDynamicAcceptorListener

getDynamicAcceptorListener

setDynamicAcceptorListener

getSettings

getDictionaryManager

getStorageRepositoryManager

getLicense

getProductVersion

getProductName

getProductNameAndVersion

toString