SessionScheduler (OnixS CME iLink3 Handler Parent 1.0.8 API)

java.lang.Object
- biz.onixs.cme.ilink3.scheduler.SessionScheduler

```
public class SessionScheduler
extends Object
```
Session scheduler. The scheduler performs session connection maintenance according to the specified schedule. It monitors when a particular session must be active and automatically executes appropriate action.

Field Summary

Fields
Modifier and Type Field and Description

static String QUARTZ_CONFIG_FILE_DEFAULT
Default Quartz configuration file.

Fields
Modifier and Type	Field and Description
`static String`	`QUARTZ_CONFIG_FILE_DEFAULT` Default Quartz configuration file.

Constructor Summary

Constructors
Constructor and Description

SessionScheduler()
Initializes scheduler service with default configuration.

Constructors
Constructor and Description
`SessionScheduler()` Initializes scheduler service with default configuration.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addLogoutNotification(int interval)` Adds session logout notification interval.
`int`	`getConnectionRetriesInterval()` Returns the time interval between the logon attempts in case of a logon failure in seconds.
`int`	`getConnectionRetriesNumber()` Returns the number of logon attempts in case of a logon failure.
`ListenerManager`	`getListenerManager()` Returns listener manager to subscribe/unsubscribe from events.
`Set<Integer>`	`getLogoutNotifications()` Returns session logout notification intervals.
`String`	`getQuartzConfigFile()` Returns Quartz configuration file.
`void`	`register(Session session, SchedulerSettings settings, String scheduleId, SessionConnection connection)` Registers session.
`void`	`register(Session session, SchedulerSettings settings, String scheduleId, String connectionId)` Registers session.
`void`	`register(Session session, SessionSchedule schedule, SchedulerSettings settings, String connectionId)` Registers session.
`void`	`register(Session session, SessionSchedule schedule, SessionConnection connection)` Registers session.
`void`	`removeAllLogoutNotification()` Removes all session logout notification intervals.
`void`	`removeLogoutNotification(int interval)` Removes session logout notification interval.
`void`	`setConnectionRetriesInterval(int connectionRetriesInterval)` Sets the time interval between the logon attempts in case of a logon failure in seconds.
`void`	`setConnectionRetriesNumber(int connectionRetriesNumber)` Sets the number of logon attempts in case of a logon failure.
`void`	`setQuartzConfigFile(String quartzConfigFile)` Sets Quartz configuration file.
`void`	`start()` Starts scheduler service.
`void`	`stop()` Stops scheduler service.
`String`	`toString()`
`void`	`unregister(Session session)` Un-registers session.

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

- Field Detail
  - QUARTZ_CONFIG_FILE_DEFAULT
```
public static final String QUARTZ_CONFIG_FILE_DEFAULT
```
    Default Quartz configuration file.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SessionScheduler
```
public SessionScheduler()
```
    Initializes scheduler service with default configuration.
- Method Detail
  - start
```
public void start()
           throws SessionSchedulerException
```
    Starts scheduler service.
    
    Throws:
    
    SessionSchedulerException - if start failed
  - stop
```
public void stop()
          throws SessionSchedulerException
```
    Stops scheduler service.
    
    Throws:
    
    SessionSchedulerException - if stop failed
  - register
```
public void register(Session session,
                     SchedulerSettings settings,
                     String scheduleId,
                     String connectionId)
              throws SessionSchedulerException
```
    Registers session. This method is thread-safe.
    
    Parameters:
    
    session - FIX session
    
    settings - scheduler settings
    
    scheduleId - schedule id in the scheduler settings
    
    connectionId - connection id in the scheduler settings
    
    Throws:
    
    SessionSchedulerException - if scheduling failed
    
    IllegalArgumentException - if schedule with the scheduleId is not found in the settings or if connection with connectionId is not found in the settings
  - register
```
public void register(Session session,
                     SessionSchedule schedule,
                     SchedulerSettings settings,
                     String connectionId)
              throws SessionSchedulerException
```
    Registers session. This method is thread-safe.
    
    Parameters:
    
    session - FIX session
    
    schedule - session schedule
    
    settings - scheduler settings
    
    connectionId - connection id in the scheduler settings
    
    Throws:
    
    SessionSchedulerException - if scheduling failed
    
    IllegalArgumentException - if connection with the connectionId is not found in the settings
  - register
```
public void register(Session session,
                     SchedulerSettings settings,
                     String scheduleId,
                     SessionConnection connection)
              throws SessionSchedulerException
```
    Registers session. This method is thread-safe.
    
    Parameters:
    
    session - FIX session
    
    settings - scheduler settings
    
    scheduleId - schedule id in the scheduler settings
    
    connection - session connection
    
    Throws:
    
    SessionSchedulerException - if scheduling failed
    
    IllegalArgumentException - if schedule with the scheduleId is not found in the settings
  - register
```
public void register(Session session,
                     SessionSchedule schedule,
                     SessionConnection connection)
              throws SessionSchedulerException
```
    Registers session. This method is thread-safe.
    
    Parameters:
    
    session - FIX session
    
    schedule - schedule for the given session
    
    connection - connection settings for the given session
    
    Throws:
    
    SessionSchedulerException - if scheduling failed
  - unregister
```
public void unregister(Session session)
                throws SessionSchedulerException
```
    Un-registers session. This method is thread-safe.
    
    Parameters:
    
    session - FIX session
    
    Throws:
    
    SessionSchedulerException - if un-register failed
  - getLogoutNotifications
```
public Set<Integer> getLogoutNotifications()
```
    Returns session logout notification intervals.
    
    Returns:
    
    session logout notification intervals
  - addLogoutNotification
```
public void addLogoutNotification(int interval)
```
    Adds session logout notification interval. This added interval is not applied to sessions already registered.
    
    Parameters:
    
    interval - session logout notification interval, in seconds
    
    Throws:
    
    IllegalArgumentException - if (interval < 1)
  - removeLogoutNotification
```
public void removeLogoutNotification(int interval)
```
    Removes session logout notification interval. This removed interval is not applied to sessions already registered.
    
    Parameters:
    
    interval - session logout notification interval, in seconds
    
    Throws:
    
    IllegalArgumentException - if (interval < 1)
  - removeAllLogoutNotification
```
public void removeAllLogoutNotification()
```
    Removes all session logout notification intervals. The removed intervals are not applied to sessions already registered.
  - getConnectionRetriesNumber
```
public int getConnectionRetriesNumber()
```
    Returns the number of logon attempts in case of a logon failure.
    The default value is 3.
    
    Returns:
    
    number of logon attempts.
  - setConnectionRetriesNumber
```
public void setConnectionRetriesNumber(int connectionRetriesNumber)
```
    Sets the number of logon attempts in case of a logon failure.
    The default value is 3.
    
    Parameters:
    
    connectionRetriesNumber - number of logon attempts
    
    Throws:
    
    IllegalArgumentException - if 0 > connectionRetriesNumber
  - getConnectionRetriesInterval
```
public int getConnectionRetriesInterval()
```
    Returns the time interval between the logon attempts in case of a logon failure in seconds.
    The default value is 180.
    
    Returns:
    
    the time interval between the logon attempts.
  - setConnectionRetriesInterval
```
public void setConnectionRetriesInterval(int connectionRetriesInterval)
```
    Sets the time interval between the logon attempts in case of a logon failure in seconds.
    The default value is 180.
    
    Parameters:
    
    connectionRetriesInterval - interval between the logon attempts
    
    Throws:
    
    IllegalArgumentException - if 0 >= connectionRetriesInterval
  - getQuartzConfigFile
```
public String getQuartzConfigFile()
```
    Returns Quartz configuration file. The default value is QUARTZ_CONFIG_FILE_DEFAULT.
    
    Returns:
    
    Quartz configuration file.
  - setQuartzConfigFile
```
public void setQuartzConfigFile(String quartzConfigFile)
```
    Sets Quartz configuration file. Effective on start. The default value is QUARTZ_CONFIG_FILE_DEFAULT.
    
    Parameters:
    
    quartzConfigFile - configuration file
    
    Throws:
    
    NullPointerException - if (configFile == null)
  - getListenerManager
```
public ListenerManager getListenerManager()
```
    Returns listener manager to subscribe/unsubscribe from events.
    
    Returns:
    
    listener manager.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class SessionScheduler

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

QUARTZ_CONFIG_FILE_DEFAULT

Constructor Detail

SessionScheduler

Method Detail

start

stop

register

register

register

register

unregister

getLogoutNotifications

addLogoutNotification

removeLogoutNotification

removeAllLogoutNotification

getConnectionRetriesNumber

setConnectionRetriesNumber

getConnectionRetriesInterval

setConnectionRetriesInterval

getQuartzConfigFile

setQuartzConfigFile

getListenerManager

toString