org.quickfixj.jmx.mbean.session
Interface SessionAdminMBean

All Known Implementing Classes:
SessionAdmin

public interface SessionAdminMBean

This MBean provides the ability monitor session settings and to change some of them.


Method Summary
 void disconnect()
          Tell the session to disconnect (implies logoff)
 java.lang.String getBeginString()
          Get the begin string (FIX version) for the session
 boolean getCheckCompID()
           
 java.lang.String getConnectionRole()
           
 javax.management.ObjectName getConnectorName()
           
 boolean getEnabled()
           
 java.lang.String getLogClassName()
           
 int getLogonTimeout()
           
 int getLogoutTimeout()
           
 java.lang.String getMessageFactoryClassName()
           
 java.lang.String getMessageStoreClassName()
           
 int getNextSenderMsgSeqNum()
          Get the next sender message sequence number.
 int getNextTargetMsgSeqNum()
          Get the next target message sequence number.
 boolean getRedundantResendRequestsAllowed()
           
 boolean getRefreshOnLogon()
           
 boolean getResetOnDisconnect()
           
 boolean getResetOnLogout()
           
 java.lang.String getSenderCompID()
          Get the sender company ID for the session.
 java.lang.String getSenderLocationID()
          Get the sender company location ID for the session.
 java.lang.String getSenderSubID()
          Get the sender company subID for the session.
 java.lang.String getSessionID()
          Get the session ID.
 java.lang.String getStartTime()
           
 java.lang.String getTargetCompID()
          Get the target company ID for the session.
 java.lang.String getTargetLocationID()
          Get the target location ID for the session.
 java.lang.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 isUsingDataDictionary()
           
 void logoff()
          Tell the session to logoff.
 void logon()
          Tell the session to logon.
 void reset()
          Reset the session's sequence numbers and clear it's resend log.
 void resetSequence(int nextSeqNum)
          Reset current sequence number
 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.
 

Method Detail

getBeginString

java.lang.String getBeginString()
Get the begin string (FIX version) for the session

Returns:
the begin string for the session

getTargetCompID

java.lang.String getTargetCompID()
Get the target company ID for the session.

Returns:
the target company ID

getTargetSubID

java.lang.String getTargetSubID()
Get the target subID for the session.

Returns:
the target subID

getTargetLocationID

java.lang.String getTargetLocationID()
Get the target location ID for the session.

Returns:
the target location ID

getSenderCompID

java.lang.String getSenderCompID()
Get the sender company ID for the session.

Returns:
the sender company ID

getSenderSubID

java.lang.String getSenderSubID()
Get the sender company subID for the session.

Returns:
the sender subID

getSenderLocationID

java.lang.String getSenderLocationID()
Get the sender company location ID for the session.

Returns:
the sender location ID

getSessionID

java.lang.String getSessionID()
Get the session ID.

Returns:
the session ID

getNextSenderMsgSeqNum

int getNextSenderMsgSeqNum()
                           throws java.io.IOException
Get the next sender message sequence number.

Returns:
the next sender message sequence number
Throws:
java.io.IOException

setNextSenderMsgSeqNum

void setNextSenderMsgSeqNum(int next)
                            throws java.io.IOException
Set the next sender message sequence number. It's dangerous to use this operation on an active session.

Parameters:
next - next sender message sequence number
Throws:
java.io.IOException

getNextTargetMsgSeqNum

int getNextTargetMsgSeqNum()
                           throws java.io.IOException
Get the next target message sequence number.

Returns:
next target message sequence number
Throws:
java.io.IOException

setNextTargetMsgSeqNum

void setNextTargetMsgSeqNum(int next)
                            throws java.io.IOException
Set the next target message sequence number. It's dangerous to use this operation on an active session.

Parameters:
next - the next target message sequence number
Throws:
java.io.IOException

isLogonSent

boolean isLogonSent()

isLogonReceived

boolean isLogonReceived()

isLogonAlreadySent

boolean isLogonAlreadySent()

isLogonSendNeeded

boolean isLogonSendNeeded()

isLogonTimedOut

boolean isLogonTimedOut()

isLogoutSent

boolean isLogoutSent()

isLogoutReceived

boolean isLogoutReceived()

isLogoutTimedOut

boolean isLogoutTimedOut()

setLogoutTimeout

void setLogoutTimeout(int seconds)

setLogonTimeout

void setLogonTimeout(int seconds)

getLogoutTimeout

int getLogoutTimeout()

getLogonTimeout

int getLogonTimeout()

isLoggedOn

boolean isLoggedOn()

getRedundantResendRequestsAllowed

boolean getRedundantResendRequestsAllowed()

getLogClassName

java.lang.String getLogClassName()

getMessageFactoryClassName

java.lang.String getMessageFactoryClassName()

getMessageStoreClassName

java.lang.String getMessageStoreClassName()

isUsingDataDictionary

boolean isUsingDataDictionary()

getCheckCompID

boolean getCheckCompID()

getRefreshOnLogon

boolean getRefreshOnLogon()

getResetOnLogout

boolean getResetOnLogout()

getResetOnDisconnect

boolean getResetOnDisconnect()

reset

void reset()
           throws java.io.IOException
Reset the session's sequence numbers and clear it's resend log.

Throws:
java.io.IOException

logoff

void logoff()
Tell the session to logoff.


logon

void logon()
Tell the session to logon.


resetSequence

void resetSequence(int nextSeqNum)
                   throws SessionNotFound
Reset current sequence number

Throws:
SessionNotFound

disconnect

void disconnect()
                throws java.io.IOException
Tell the session to disconnect (implies logoff)

Throws:
java.io.IOException

getEnabled

boolean getEnabled()

getStartTime

java.lang.String getStartTime()

getConnectionRole

java.lang.String getConnectionRole()

getConnectorName

javax.management.ObjectName getConnectorName()