org.quickfixj.jmx.mbean.session

Class SessionAdmin

java.lang.Object

javax.management.NotificationBroadcasterSupport

org.quickfixj.jmx.mbean.session.SessionAdmin

All Implemented Interfaces:

MBeanRegistration, NotificationBroadcaster, NotificationEmitter, SessionAdminMBean, SessionStateListener

public class SessionAdmin
extends NotificationBroadcasterSupport
implements SessionAdminMBean, MBeanRegistration, SessionStateListener

Constructor Summary

Constructors

Constructor and Description
SessionAdmin(Session session, ObjectName connectorName, ObjectName settingsName)

Method Summary

Modifier and Type	Method and Description
void	disconnect() Tell the session to disconnect (implies logoff)
protected void	doSend(Message message, SessionID sessionID) Helper method to be overridden by tests that handles sending out the message.
String	getBeginString() Get the begin string (FIX version) for the session
boolean	getCheckCompID()
String	getConnectionRole()
ObjectName	getConnectorName()
boolean	getEnabled()
String	getHost()
String	getID()
String	getLogClassName()
int	getLogonTimeout()
int	getLogoutTimeout()
String	getMessageFactoryClassName()
String[]	getMessages(int startSequence, int endSequence)
String	getMessageStoreClassName()
int	getNextSenderMsgSeqNum() Get the next sender message sequence number.
int	getNextTargetMsgSeqNum() Get the next target message sequence number.
String	getProcessID()
boolean	getRedundantResendRequestsAllowed()
boolean	getRefreshOnLogon()
String	getRemoteIPAddress()
boolean	getResetOnDisconnect()
boolean	getResetOnLogout()
String	getSenderCompID() Get the sender company ID for the session.
String	getSenderLocationID() Get the sender company location ID for the session.
String	getSenderSubID() Get the sender company subID for the session.
String	getSessionID() Get the session ID.
String	getStartTime()
String	getTargetCompID() Get the target company ID for the session.
String	getTargetLocationID() Get the target location ID for the session.
String	getTargetSubID() Get the target subID for the session.
boolean	isLoggedOn()
boolean	isLogonAlreadySent()
boolean	isLogonReceived()
boolean	isLogonSendNeeded()
boolean	isLogonSent()
boolean	isLogonTimedOut()
boolean	isLogoutReceived()
boolean	isLogoutSent()
boolean	isLogoutTimedOut()
boolean	isReconnectEnabled()
boolean	isUsingDataDictionary()
void	logoff() Tell the session to logoff.
void	logon() Tell the session to logon.
void	onConnect() Called when connection has been established.
void	onDisconnect() Called when connection has been disconnected.
void	onHeartBeatTimeout() Called when Heartbeat timeout has been detected.
void	onLogon() Called when session has been logged on.
void	onLogout() Called when session has been logged out.
void	onMissedHeartBeat() Called when TestRequest is sent out due to missed Heartbeat.
void	onRefresh() Called when message store gets refreshed on Logon.
void	onResendRequestSatisfied(int beginSeqNo, int endSeqNo) Called when a received ResendRequest has been satisfied.
void	onResendRequestSent(int beginSeqNo, int endSeqNo, int currentEndSeqNo) Called when ResendRequest has been sent out.
void	onReset() Called when message store gets reset.
void	onSequenceResetReceived(int newSeqNo, boolean gapFillFlag) Called when SequenceReset has been received.
void	postDeregister()
void	postRegister(Boolean registrationDone)
void	preDeregister()
ObjectName	preRegister(MBeanServer server, ObjectName name)
void	reset() Reset the session's sequence numbers and clear it's resend log.
void	resetSequence(int nextSeqNum) Reset current sequence number
void	sendHeartBeat() Send a heartBeat message
void	sendLogoutMessage() Send a logout message
void	sendTestRequest() Send a test Request message
void	setLogonTimeout(int seconds)
void	setLogoutTimeout(int seconds)
void	setNextSenderMsgSeqNum(int next) Set the next sender message sequence number.
void	setNextTargetMsgSeqNum(int next) Set the next target message sequence number.

Methods inherited from class javax.management.NotificationBroadcasterSupport

addNotificationListener, getNotificationInfo, handleNotification, removeNotificationListener, removeNotificationListener, sendNotification

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface quickfix.SessionStateListener

onConnectException

Constructor Detail

SessionAdmin

public SessionAdmin(Session session,
                    ObjectName connectorName,
                    ObjectName settingsName)

Method Detail

getID

public String getID()

getTargetCompID

public String getTargetCompID()

Description copied from interface: SessionAdminMBean

Get the target company ID for the session.

Specified by:

getTargetCompID in interface SessionAdminMBean

Returns:

the target company ID

getTargetSubID

public String getTargetSubID()

Description copied from interface: SessionAdminMBean

Get the target subID for the session.

Specified by:

getTargetSubID in interface SessionAdminMBean

Returns:

the target subID

getTargetLocationID

public String getTargetLocationID()

Description copied from interface: SessionAdminMBean

Get the target location ID for the session.

Specified by:

getTargetLocationID in interface SessionAdminMBean

Returns:

the target location ID

getSenderCompID

public String getSenderCompID()

Description copied from interface: SessionAdminMBean

Get the sender company ID for the session.

Specified by:

getSenderCompID in interface SessionAdminMBean

Returns:

the sender company ID

getSenderSubID

public String getSenderSubID()

Description copied from interface: SessionAdminMBean

Get the sender company subID for the session.

Specified by:

getSenderSubID in interface SessionAdminMBean

Returns:

the sender subID

getSenderLocationID

public String getSenderLocationID()

Description copied from interface: SessionAdminMBean

Get the sender company location ID for the session.

Specified by:

getSenderLocationID in interface SessionAdminMBean

Returns:

the sender location ID

getBeginString

public String getBeginString()

Description copied from interface: SessionAdminMBean

Get the begin string (FIX version) for the session

Specified by:

getBeginString in interface SessionAdminMBean

Returns:

the begin string for the session

isLoggedOn

public boolean isLoggedOn()

Specified by:

isLoggedOn in interface SessionAdminMBean

getRemoteIPAddress

public String getRemoteIPAddress()

reset

public void reset()

Description copied from interface: SessionAdminMBean

Reset the session's sequence numbers and clear it's resend log.

Specified by:

reset in interface SessionAdminMBean

getNextSenderMsgSeqNum

public int getNextSenderMsgSeqNum()
                           throws IOException

Description copied from interface: SessionAdminMBean

Get the next sender message sequence number.

Specified by:

getNextSenderMsgSeqNum in interface SessionAdminMBean

Returns:

the next sender message sequence number

Throws:

IOException

setNextSenderMsgSeqNum

public void setNextSenderMsgSeqNum(int next)
                            throws IOException

Description copied from interface: SessionAdminMBean

Set the next sender message sequence number. It's dangerous to use this operation on an active session.

Specified by:

setNextSenderMsgSeqNum in interface SessionAdminMBean

Parameters:

next - next sender message sequence number

Throws:

IOException

setNextTargetMsgSeqNum

public void setNextTargetMsgSeqNum(int next)
                            throws IOException

Description copied from interface: SessionAdminMBean

Set the next target message sequence number. It's dangerous to use this operation on an active session.

Specified by:

setNextTargetMsgSeqNum in interface SessionAdminMBean

Parameters:

next - the next target message sequence number

Throws:

IOException

getNextTargetMsgSeqNum

public int getNextTargetMsgSeqNum()
                           throws IOException

Description copied from interface: SessionAdminMBean

Get the next target message sequence number.

Specified by:

getNextTargetMsgSeqNum in interface SessionAdminMBean

Returns:

next target message sequence number

Throws:

IOException

getMessages

public String[] getMessages(int startSequence,
                            int endSequence)
                     throws IOException

Throws:

IOException

disconnect

public void disconnect()
                throws IOException

Description copied from interface: SessionAdminMBean

Tell the session to disconnect (implies logoff)

Specified by:

disconnect in interface SessionAdminMBean

Throws:

IOException

resetSequence

public void resetSequence(int nextSeqNum)
                   throws SessionNotFound

Description copied from interface: SessionAdminMBean

Reset current sequence number

Specified by:

resetSequence in interface SessionAdminMBean

Throws:

SessionNotFound

doSend

protected void doSend(Message message,
                      SessionID sessionID)
               throws SessionNotFound

Helper method to be overridden by tests that handles sending out the message.

Throws:

SessionNotFound

logon

public void logon()

Description copied from interface: SessionAdminMBean

Tell the session to logon.

Specified by:

logon in interface SessionAdminMBean

logoff

public void logoff()

Description copied from interface: SessionAdminMBean

Tell the session to logoff.

Specified by:

logoff in interface SessionAdminMBean

isReconnectEnabled

public boolean isReconnectEnabled()

getHost

public String getHost()

getProcessID

public String getProcessID()

getConnectorName

public ObjectName getConnectorName()

Specified by:

getConnectorName in interface SessionAdminMBean

getCheckCompID

public boolean getCheckCompID()

Specified by:

getCheckCompID in interface SessionAdminMBean

getLogClassName

public String getLogClassName()

Specified by:

getLogClassName in interface SessionAdminMBean

getLogonTimeout

public int getLogonTimeout()

Specified by:

getLogonTimeout in interface SessionAdminMBean

getLogoutTimeout

public int getLogoutTimeout()

Specified by:

getLogoutTimeout in interface SessionAdminMBean

getMessageFactoryClassName

public String getMessageFactoryClassName()

Specified by:

getMessageFactoryClassName in interface SessionAdminMBean

getMessageStoreClassName

public String getMessageStoreClassName()

Specified by:

getMessageStoreClassName in interface SessionAdminMBean

getRedundantResendRequestsAllowed

public boolean getRedundantResendRequestsAllowed()

Specified by:

getRedundantResendRequestsAllowed in interface SessionAdminMBean

getRefreshOnLogon

public boolean getRefreshOnLogon()

Specified by:

getRefreshOnLogon in interface SessionAdminMBean

getResetOnDisconnect

public boolean getResetOnDisconnect()

Specified by:

getResetOnDisconnect in interface SessionAdminMBean

getResetOnLogout

public boolean getResetOnLogout()

Specified by:

getResetOnLogout in interface SessionAdminMBean

isLogonAlreadySent

public boolean isLogonAlreadySent()

Specified by:

isLogonAlreadySent in interface SessionAdminMBean

isLogonReceived

public boolean isLogonReceived()

Specified by:

isLogonReceived in interface SessionAdminMBean

isLogonSendNeeded

public boolean isLogonSendNeeded()

Specified by:

isLogonSendNeeded in interface SessionAdminMBean

isLogonSent

public boolean isLogonSent()

Specified by:

isLogonSent in interface SessionAdminMBean

isLogonTimedOut

public boolean isLogonTimedOut()

Specified by:

isLogonTimedOut in interface SessionAdminMBean

isLogoutReceived

public boolean isLogoutReceived()

Specified by:

isLogoutReceived in interface SessionAdminMBean

isLogoutSent

public boolean isLogoutSent()

Specified by:

isLogoutSent in interface SessionAdminMBean

isLogoutTimedOut

public boolean isLogoutTimedOut()

Specified by:

isLogoutTimedOut in interface SessionAdminMBean

setLogonTimeout

public void setLogonTimeout(int seconds)

Specified by:

setLogonTimeout in interface SessionAdminMBean

setLogoutTimeout

public void setLogoutTimeout(int seconds)

Specified by:

setLogoutTimeout in interface SessionAdminMBean

isUsingDataDictionary

public boolean isUsingDataDictionary()

Specified by:

isUsingDataDictionary in interface SessionAdminMBean

getSessionID

public String getSessionID()

Description copied from interface: SessionAdminMBean

Get the session ID.

Specified by:

getSessionID in interface SessionAdminMBean

Returns:

the session ID

getEnabled

public boolean getEnabled()

Specified by:

getEnabled in interface SessionAdminMBean

getStartTime

public String getStartTime()

Specified by:

getStartTime in interface SessionAdminMBean

getConnectionRole

public String getConnectionRole()

Specified by:

getConnectionRole in interface SessionAdminMBean

postDeregister

public void postDeregister()

Specified by:

postDeregister in interface MBeanRegistration

postRegister

public void postRegister(Boolean registrationDone)

Specified by:

postRegister in interface MBeanRegistration

preDeregister

public void preDeregister()
                   throws Exception

Specified by:

preDeregister in interface MBeanRegistration

Throws:

Exception

preRegister

public ObjectName preRegister(MBeanServer server,
                              ObjectName name)
                       throws Exception

Specified by:

preRegister in interface MBeanRegistration

Throws:

Exception

onConnect

public void onConnect()

Description copied from interface: SessionStateListener

Called when connection has been established.

Specified by:

onConnect in interface SessionStateListener

onDisconnect

public void onDisconnect()

Description copied from interface: SessionStateListener

Called when connection has been disconnected.

Specified by:

onDisconnect in interface SessionStateListener

onLogon

public void onLogon()

Description copied from interface: SessionStateListener

Called when session has been logged on.

Specified by:

onLogon in interface SessionStateListener

onLogout

public void onLogout()

Description copied from interface: SessionStateListener

Called when session has been logged out.

Specified by:

onLogout in interface SessionStateListener

onHeartBeatTimeout

public void onHeartBeatTimeout()

Description copied from interface: SessionStateListener

Called when Heartbeat timeout has been detected.

Specified by:

onHeartBeatTimeout in interface SessionStateListener

onMissedHeartBeat

public void onMissedHeartBeat()

Description copied from interface: SessionStateListener

Called when TestRequest is sent out due to missed Heartbeat.

Specified by:

onMissedHeartBeat in interface SessionStateListener

onRefresh

public void onRefresh()

Description copied from interface: SessionStateListener

Called when message store gets refreshed on Logon.

Specified by:

onRefresh in interface SessionStateListener

onResendRequestSent

public void onResendRequestSent(int beginSeqNo,
                                int endSeqNo,
                                int currentEndSeqNo)

Description copied from interface: SessionStateListener

Called when ResendRequest has been sent out.

Specified by:

onResendRequestSent in interface SessionStateListener

Parameters:

beginSeqNo - first seqnum that gets requested

endSeqNo - last seqnum that gets requested

currentEndSeqNo - last seqnum of range that gets requested on chunked ResendRequests

onSequenceResetReceived

public void onSequenceResetReceived(int newSeqNo,
                                    boolean gapFillFlag)

Description copied from interface: SessionStateListener

Called when SequenceReset has been received.

Specified by:

onSequenceResetReceived in interface SessionStateListener

Parameters:

newSeqNo - NewSeqNo from SequenceReset

gapFillFlag - GapFillFlag from SequenceReset

onResendRequestSatisfied

public void onResendRequestSatisfied(int beginSeqNo,
                                     int endSeqNo)

Description copied from interface: SessionStateListener

Called when a received ResendRequest has been satisfied.

Specified by:

onResendRequestSatisfied in interface SessionStateListener

Parameters:

beginSeqNo - first seqnum that was requested

endSeqNo - last seqnum that was requested

onReset

public void onReset()

Description copied from interface: SessionStateListener

Called when message store gets reset.

Specified by:

onReset in interface SessionStateListener

sendTestRequest

public void sendTestRequest()

Description copied from interface: SessionAdminMBean

Send a test Request message

Specified by:

sendTestRequest in interface SessionAdminMBean

sendHeartBeat

public void sendHeartBeat()

Description copied from interface: SessionAdminMBean

Send a heartBeat message

Specified by:

sendHeartBeat in interface SessionAdminMBean

sendLogoutMessage

public void sendLogoutMessage()

Description copied from interface: SessionAdminMBean

Send a logout message

Specified by:

sendLogoutMessage in interface SessionAdminMBean