SessionAdminMBean (QuickFIX/J Distribution 2.3.0 API)

All Known Implementing Classes:

SessionAdmin
```
public interface SessionAdminMBean
```
This MBean provides the ability monitor session settings and to change some of them.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`disconnect()` Tell the session to disconnect (implies logoff)
`String`	`getBeginString()` Get the begin string (FIX version) for the session
`boolean`	`getCheckCompID()`
`String`	`getConnectionRole()`
`ObjectName`	`getConnectorName()`
`boolean`	`getEnabled()`
`String`	`getLogClassName()`
`int`	`getLogonTimeout()`
`int`	`getLogoutTimeout()`
`String`	`getMessageFactoryClassName()`
`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()`
`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`	`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`	`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.

- Method Detail
  - getBeginString
```
String getBeginString()
```
    Get the begin string (FIX version) for the session
    
    Returns:
    
    the begin string for the session
  - getTargetCompID
```
String getTargetCompID()
```
    Get the target company ID for the session.
    
    Returns:
    
    the target company ID
  - getTargetSubID
```
String getTargetSubID()
```
    Get the target subID for the session.
    
    Returns:
    
    the target subID
  - getTargetLocationID
```
String getTargetLocationID()
```
    Get the target location ID for the session.
    
    Returns:
    
    the target location ID
  - getSenderCompID
```
String getSenderCompID()
```
    Get the sender company ID for the session.
    
    Returns:
    
    the sender company ID
  - getSenderSubID
```
String getSenderSubID()
```
    Get the sender company subID for the session.
    
    Returns:
    
    the sender subID
  - getSenderLocationID
```
String getSenderLocationID()
```
    Get the sender company location ID for the session.
    
    Returns:
    
    the sender location ID
  - getSessionID
```
String getSessionID()
```
    Get the session ID.
    
    Returns:
    
    the session ID
  - getNextSenderMsgSeqNum
```
int getNextSenderMsgSeqNum()
                    throws IOException
```
    Get the next sender message sequence number.
    
    Returns:
    
    the next sender message sequence number
    
    Throws:
    
    IOException
  - setNextSenderMsgSeqNum
```
void setNextSenderMsgSeqNum(int next)
                     throws 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:
    
    IOException
  - getNextTargetMsgSeqNum
```
int getNextTargetMsgSeqNum()
                    throws IOException
```
    Get the next target message sequence number.
    
    Returns:
    
    next target message sequence number
    
    Throws:
    
    IOException
  - setNextTargetMsgSeqNum
```
void setNextTargetMsgSeqNum(int next)
                     throws 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:
    
    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
```
String getLogClassName()
```
  - getMessageFactoryClassName
```
String getMessageFactoryClassName()
```
  - getMessageStoreClassName
```
String getMessageStoreClassName()
```
  - isUsingDataDictionary
```
boolean isUsingDataDictionary()
```
  - getCheckCompID
```
boolean getCheckCompID()
```
  - getRefreshOnLogon
```
boolean getRefreshOnLogon()
```
  - getResetOnLogout
```
boolean getResetOnLogout()
```
  - getResetOnDisconnect
```
boolean getResetOnDisconnect()
```
  - reset
```
void reset()
    throws IOException
```
    Reset the session's sequence numbers and clear it's resend log.
    
    Throws:
    
    IOException
  - logoff
```
void logoff()
```
    Tell the session to logoff.
  - logon
```
void logon()
```
    Tell the session to logon.
  - sendTestRequest
```
void sendTestRequest()
```
    Send a test Request message
  - sendHeartBeat
```
void sendHeartBeat()
```
    Send a heartBeat message
  - sendLogoutMessage
```
void sendLogoutMessage()
```
    Send a logout message
  - resetSequence
```
void resetSequence(int nextSeqNum)
            throws SessionNotFound
```
    Reset current sequence number
    
    Throws:
    
    SessionNotFound
  - disconnect
```
void disconnect()
         throws IOException
```
    Tell the session to disconnect (implies logoff)
    
    Throws:
    
    IOException
  - getEnabled
```
boolean getEnabled()
```
  - getStartTime
```
String getStartTime()
```
  - getConnectionRole
```
String getConnectionRole()
```
  - getConnectorName
```
ObjectName getConnectorName()
```

Interface SessionAdminMBean

Method Summary

Method Detail

getBeginString

getTargetCompID

getTargetSubID

getTargetLocationID

getSenderCompID

getSenderSubID

getSenderLocationID

getSessionID

getNextSenderMsgSeqNum

setNextSenderMsgSeqNum

getNextTargetMsgSeqNum

setNextTargetMsgSeqNum

isLogonSent

isLogonReceived

isLogonAlreadySent

isLogonSendNeeded

isLogonTimedOut

isLogoutSent

isLogoutReceived

isLogoutTimedOut

setLogoutTimeout

setLogonTimeout

getLogoutTimeout

getLogonTimeout

isLoggedOn

getRedundantResendRequestsAllowed

getLogClassName

getMessageFactoryClassName

getMessageStoreClassName

isUsingDataDictionary

getCheckCompID

getRefreshOnLogon

getResetOnLogout

getResetOnDisconnect

reset

logoff

logon

sendTestRequest

sendHeartBeat

sendLogoutMessage

resetSequence

disconnect

getEnabled

getStartTime

getConnectionRole

getConnectorName