biz.onixs.fix.scheduler

Class SessionScheduler

java.lang.Object

biz.onixs.fix.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.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
SessionScheduler	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 milliseconds.
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.
SessionScheduler	register(Session session, SchedulerSettings settings, String scheduleId) Registers acceptor session.
SessionScheduler	register(Session session, SchedulerSettings settings, String scheduleId, SessionConnection connection) Registers session.
SessionScheduler	register(Session session, SchedulerSettings settings, String scheduleId, String connectionId) Registers session.
SessionScheduler	register(Session session, SessionSchedule schedule, SchedulerSettings settings, String connectionId) Registers session.
SessionScheduler	register(Session session, SessionSchedule schedule, SessionConnection connection) Registers session.
SessionScheduler	registerAcceptor(Session session, SessionSchedule schedule) Registers acceptor session.
SessionScheduler	removeAllLogoutNotification() Removes all session logout notification intervals.
SessionScheduler	removeLogoutNotification(int interval) Removes session logout notification interval.
SessionScheduler	setConnectionRetriesInterval(int connectionRetriesInterval) Sets the time interval between the logon attempts in case of a logon failure in milliseconds.
SessionScheduler	setConnectionRetriesNumber(int connectionRetriesNumber) Sets the number of logon attempts in case of a logon failure.
SessionScheduler	setQuartzConfigFile(String quartzConfigFile) Sets Quartz configuration file.
SessionScheduler	start() Starts scheduler service.
SessionScheduler	stop() Stops scheduler service.
String	toString()
SessionScheduler	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()
                 throws SessionSchedulerException

Initializes scheduler service with default configuration.

Throws:

SessionSchedulerException - if creation failed

Method Detail

start

public SessionScheduler start()
                       throws SessionSchedulerException

Starts scheduler service.

Returns:

reference to this object.

Throws:

SessionSchedulerException - if start failed

stop

public SessionScheduler stop()
                      throws SessionSchedulerException

Stops scheduler service.

Returns:

reference to this object.

Throws:

SessionSchedulerException - if stop failed

registerAcceptor

public SessionScheduler registerAcceptor(Session session,
                                         SessionSchedule schedule)
                                  throws SessionSchedulerException

Registers acceptor session. This method is thread-safe.

Parameters:

session - FIX session

schedule - session schedule

Returns:

reference to this object.

Throws:

SessionSchedulerException - if scheduling failed

register

public SessionScheduler register(Session session,
                                 SchedulerSettings settings,
                                 String scheduleId)
                          throws SessionSchedulerException

Registers acceptor session. This method is thread-safe.

Parameters:

session - FIX session

settings - scheduler settings

scheduleId - schedule id in the scheduler settings

Returns:

reference to this object.

Throws:

SessionSchedulerException - if scheduling failed

IllegalArgumentException - if schedule with the scheduleId is not found in the settings

register

public SessionScheduler 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

Returns:

reference to this object.

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 SessionScheduler 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

Returns:

reference to this object.

Throws:

SessionSchedulerException - if scheduling failed

IllegalArgumentException - if connection with the connectionId is not found in the settings

register

public SessionScheduler 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

Returns:

reference to this object.

Throws:

SessionSchedulerException - if scheduling failed

IllegalArgumentException - if schedule with the scheduleId is not found in the settings

register

public SessionScheduler 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

Returns:

reference to this object.

Throws:

SessionSchedulerException - if scheduling failed

unregister

public SessionScheduler unregister(Session session)
                            throws SessionSchedulerException

Un-registers session. This method is thread-safe.

Parameters:

session - FIX session

Returns:

reference to this object.

Throws:

SessionSchedulerException - if un-register failed

getLogoutNotifications

public Set<Integer> getLogoutNotifications()

Returns session logout notification intervals.

Returns:

session logout notification intervals

addLogoutNotification

public SessionScheduler 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

Returns:

reference to this object.

Throws:

IllegalArgumentException - if (interval < 1)

removeLogoutNotification

public SessionScheduler 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

Returns:

reference to this object.

Throws:

IllegalArgumentException - if (interval < 1)

removeAllLogoutNotification

public SessionScheduler removeAllLogoutNotification()

Removes all session logout notification intervals. The removed intervals are not applied to sessions already registered.

Returns:

reference to this object.

getConnectionRetriesNumber

public int getConnectionRetriesNumber()

Returns the number of logon attempts in case of a logon failure.

Returns:

number of logon attempts.

setConnectionRetriesNumber

public SessionScheduler setConnectionRetriesNumber(int connectionRetriesNumber)

Sets the number of logon attempts in case of a logon failure.

Parameters:

connectionRetriesNumber - number of logon attempts

Returns:

reference to this object.

Throws:

IllegalArgumentException - if 0 > connectionRetriesNumber

getConnectionRetriesInterval

public int getConnectionRetriesInterval()

Returns the time interval between the logon attempts in case of a logon failure in milliseconds.

Returns:

the time interval between the logon attempts.

setConnectionRetriesInterval

public SessionScheduler setConnectionRetriesInterval(int connectionRetriesInterval)

Sets the time interval between the logon attempts in case of a logon failure in milliseconds.

Parameters:

connectionRetriesInterval - interval between the logon attempts

Returns:

reference to this object.

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 SessionScheduler setQuartzConfigFile(String quartzConfigFile)

Sets Quartz configuration file. Effective on start. The default value is QUARTZ_CONFIG_FILE_DEFAULT.

Parameters:

quartzConfigFile - configuration file

Returns:

reference to this object.

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