FIXEngineMBean

FIXEngineMBean provides generic functionality for engine and session creation.

MBean Details

Object Namecom.epam.fixengine:type=FIXEngine
Instances Per Node1


Operations:

NameDescriptionSignatureReturn Type
createInitiator

Create and register initiator FIX session.

Return true in operation is successful.


CompositeData should include next values (see more SessionParameters):

Field nameTypeDescription
idStringFIX session identifier
senderCompIdStringSenderCompId(49)
senderSubIdStringSenderSubId(50)
senderLocationIdStringSenderLocationId(142)
targetCompIdStringTargetCompId(56)
targetSubIdStringTargetSubId(57)
targetLocationIdStringTargetLocationId(143)
sessionQualifierStringAdditional session indentificator
fixVersionStringA version of FIX protocol for session level
applVersionStringA version of FIX protocol for applicaion level (for FIXT.1.1)
hbiIntegerHeartbeat inteval
remoteHostStringAddress of remote host t connect
remotePortIntegerA port on a remote host to connect
usernameStringUsername(553)
passwordStringPassword(554)
customLogonStringAdditional tags for Logon(a) message
inSeqNumIntegerAn initial incoming sequence number
outSeqNumIntegerAn initial outgoing sequence number
configurationCompositeDataFull list of options are described in the documentation: https://corp-web.b2bits.com/FAJ_doc/fixaj-manual/page15.html
CompositeDataboolean
createAcceptor

Create and register initiator FIX session.

Return true in operation is successful.


CompositeData should include next values (see more SessionParameters):

Field nameTypeDescription
idStringFIX session identifier
senderCompIdStringSenderCompId(49)
senderSubIdStringSenderSubId(50)
senderLocationIdStringSenderLocationId(142)
targetCompIdStringTargetCompId(56)
targetSubIdStringTargetSubId(57)
targetLocationIdStringTargetLocationId(143)
sessionQualifierStringAdditional session indentificator
fixVersionStringA version of FIX protocol for session level
applVersionStringA version of FIX protocol for applicaion level (for FIXT.1.1)
hbiIntegerHeartbeat inteval
usernameStringUsername(553)
passwordStringPassword(554)
customLogonStringAdditional tags for Logon(a) message
inSeqNumIntegerAn initial incoming sequence number
outSeqNumIntegerAn initial outgoing sequence number
configurationCompositeDataFull list of options are described in the documentation: https://corp-web.b2bits.com/FAJ_doc/fixaj-manual/page15.html
CompositeDataboolean

deleteAll

Disconnect and delete all active sessions.

Return true in operation is successful.

(no parameters)boolean


FIXServerProviderMBean

FIXServerProviderMBean allows FIXServer management and provides notification about its state.

MBean Details

Object Namecom.epam.fixengine:type=FIXServer,name=FIXServer-<listening_port>
Instances Per Node0..N

Attributes:

NameDescriptionTypeR/W
portsListening portsList<Integer>R
status

Current server status.

Possible values:

  • STOPPED
  • STARTED
StringR

Operations:

NameDescriptionSignatureReturn Type
start

Start this FIX server. Server start listening for incoming connections.

Return true if operation is successful.

(no parameters)boolean
stop

Stop this FIX server. Server stop listening for incoming connections.

Return true if operation is successful.

(no parameters)boolean

Notifications:

EventDescriptionNotification TypeAttribute TypeAttribute Name
Server status changedWhenever server status is changed (servers started or stopped) it sends notification.AttributeChangeNotificationStringstatus

InitiatorFIXSessionProviderMBean

InitiatorFIXSessionProviderMBean provides instruments for initiator session monitoring and management.

MBean Details

Object Namecom.epam.fixengine:type=FIXSession,subtype=initiator,name=<session_id>
Instances Per Node0..N

Attributes:

NameDescriptionTypeR/W
idUnique FIX session identificatorStringR
senderCompIdSenderCompID (49) tag value for this sessionStringR
senderSubIdSenderSubID (50) tag value for this sessionStringR
senderLocationIdSenderLocationID (142) tag value for this sessionStringR
targetCompIdTargetCompID (56) tag value for this sessionStringR
targetSubIdTargetSubID (47) tag value for this sessionStringR
targetLocationIdTargetLocationID (143) tag value for this sessionStringR
sessionQualifierExtra session identifierStringR
fixVersionFIX protocol versionStringR
applVersionApplication version of FIX protocolStringR
hbiHeartbeat interval sizeintR
remoteHostRemote host to connectStringR/W
remotePortRemote port to connectintR/W
inSeqNumCurrent incoming sequence numberlongR/W
outSeqNumCurrent outgoing sequence numberlongR/W
customLogonAdditional fields for outgoing Logon(A) messageStringR/W
encryptMethod

Encryption method type:

  • NONE
  • PKCS
  • DES
  • PKCS_DES
  • PGP_DES
  • PGP_DES_MD5
  • PEM_DES_MD5
StringR
clientType

FIX session type:

  • GENERIC
  • CME_ILINK

String

R
statusOriginal session statusStringR
statusGroup

Unified session status.

Possible values:

  • DISCONNECTED
  • CONNECTING
  • RECONNECTING
  • ESTABLISHED
  • PLANNED

String

R
backupState

Indicate which connection parameters are active.

Possible values:

  • PRIMARY
  • BACKUP
StringR
configurationFull list of options are described in documentation: https://corp-web.b2bits.com/FAJ_doc/fixaj-manual/page15.htmlCompositeDataR

Operations:

NameDescriptionSignatureReturn Type
stop

Disconnect current FIX session.

Return true if operation is successful.

String reasonboolean
delete

Remove current FIX session.

Return true if operation is successful.

(no parameters)boolean

resetSeqNum

Reset session sequence number (force seqnum reset logon).

Return true if operation is successful.

(no parameters)boolean
sendHeartbeat

Send Heartbeat(0) message.

Return true if operation is successful.

(no parameters)boolean
sendTestRequest

Send TestRequest(1) message.

Return true if operation is successful.

String testRequestIdboolean
send

Send any custom FIX message (SOH should be included).

Return true if operation is successful.

String fixMessageboolean

Notifications:

EventDescriptionNotification TypeAttribute TypeAttribute Name
Session statusGroup changedWhenever session status group is changed it sends notification. Notification isn't sent if the session status changes within a same status group.AttributeChangeNotificationStringstatusGroup
Session status changedWhenever session status is changed (servers started or stopped) it sends notification.AttributeChangeNotificationStringstatus


AcceptorFIXSessionProviderMBean

FIXAcceptorSessionMBean provides instruments for initiator session monitoring and management.

MBean Details

Object Namecom.epam.fixengine:type=FIXSession,subtype=acceptor,name=<session_id>
Instances Per Node0..N

Attributes:

NameDescriptionTypeR/W
idUnique FIX session identificatorStringR
senderCompIdSenderCompID (49) tag value for this sessionStringR
senderSubIdSenderSubID (50) tag value for this sessionStringR
senderLocationIdSenderLocationID (142) tag value for this sessionStringR
targetCompIdTargetCompID (56) tag value for this sessionStringR
targetSubIdTargetSubID (47) tag value for this sessionStringR
targetLocationIdTargetLocationID (143) tag value for this sessionStringR
sessionQualifierExtra session identifierStringR
fixVersionFIX protocol versionStringR
applVersionApplication version of FIX protocolStringR
hbiHeartbeat interval sizeintR
inSeqNumCurrent incoming sequence numberlongR/W
outSeqNumCurrent outgoing sequence numberlongR/W
customLogonAdditional fields for outgoing Logon(A) messageStringR/W
encryptMethod

Encryption method type:

  • NONE
  • PKCS
  • DES
  • PKCS_DES
  • PGP_DES
  • PGP_DES_MD5
  • PEM_DES_MD5
StringR
clientType

FIX session type:

  • GENERIC
  • CME_ILINK

String

R
statusOriginal session statusStringR
statusGroup

Unified session status.

Possible values:

  • DISCONNECTED
  • CONNECTING
  • RECONNECTING
  • ESTABLISHED
  • PLANNED

String

R
configurationFull list of options are described in documentation: https://corp-web.b2bits.com/FAJ_doc/fixaj-manual/page15.htmlCompositeDataR

Operations:

NameDescriptionSignatureReturn Type
stop

Disconnect current FIX session.

Return true if operation is successful.

String reasonboolean
delete

Remove current FIX session.

Return true if operation is successful.

(no parameters)boolean

resetSeqNum

Reset session sequence number (force seqnum reset logon).

Return true if operation is successful.

(no parameters)boolean
sendHeartbeat

Send Heartbeat(0) message.

Return true if operation is successful.

(no parameters)boolean
sendTestRequest

Send TestRequest(1) message.

Return true if operation is successful.

String testRequestIdboolean
send

Send any custom FIX message (SOH should be included).

Return true if operation is successful.

String fixMessageboolean

Notifications:

EventDescriptionNotification TypeAttribute TypeAttribute Name
Session statusGroup changedWhenever session status group is changed it sends notification. Notification isn't sent if the session status changes within a same status group.AttributeChangeNotificationStringstatusGroup
Session status changedWhenever session status is changed (servers started or stopped) it sends notification.AttributeChangeNotificationStringstatus