/
FIX Antenna Java JMX MBean reference

FIX Antenna Java JMX MBean reference

May 21, 2019

FIXEngineMBean

FIXEngineMBean provides generic functionality for engine and session creation.

MBean Details

Object Name

com.epam.fixengine:type=FIXEngine

Instances Per Node

1


Operations:

Name

Description

Signature

Return Type

Name

Description

Signature

Return Type

createInitiator

Create and register initiator FIX session.

Return true in operation is successful.

 

CompositeData should include next values (see more SessionParameters):

CompositeData

boolean

createAcceptor

Create and register initiator FIX session.

Return true in operation is successful.

 

CompositeData should include next values (see more SessionParameters):

CompositeData

boolean

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 Name

com.epam.fixengine:type=FIXServer,name=FIXServer-<listening_port>

Instances Per Node

0..N

Attributes:

Name

Description

Type

R/W

Name

Description

Type

R/W

ports

Listening ports

List<Integer>

R

status

Current server status.

Possible values:

  • STOPPED

  • STARTED

String

R

Operations:

Name

Description

Signature

Return Type

Name

Description

Signature

Return 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:

Event

Description

Notification Type

Attribute Type

Attribute Name

Event

Description

Notification Type

Attribute Type

Attribute Name

Server status changed

Whenever server status is changed (servers started or stopped) it sends notification.

AttributeChangeNotification

String

status

InitiatorFIXSessionProviderMBean

InitiatorFIXSessionProviderMBean provides instruments for initiator session monitoring and management.

MBean Details

Object Name

com.epam.fixengine:type=FIXSession,subtype=initiator,name=<session_id>

Instances Per Node

0..N

Attributes:

Name

Description

Type

R/W

Name

Description

Type

R/W

id

Unique FIX session identificator

String

R

senderCompId

SenderCompID (49) tag value for this session

String

R

senderSubId

SenderSubID (50) tag value for this session

String

R

senderLocationId

SenderLocationID (142) tag value for this session

String

R

targetCompId

TargetCompID (56) tag value for this session

String

R

targetSubId

TargetSubID (47) tag value for this session

String

R

targetLocationId

TargetLocationID (143) tag value for this session

String

R

sessionQualifier

Extra session identifier

String

R

fixVersion

FIX protocol version

String

R

applVersion

Application version of FIX protocol

String

R

hbi

Heartbeat interval size

int

R

remoteHost

Remote host to connect

String

R/W

remotePort

Remote port to connect

int

R/W

inSeqNum

Current incoming sequence number

long

R/W

outSeqNum

Current outgoing sequence number

long

R/W

customLogon

Additional fields for outgoing Logon(A) message

String

R/W

encryptMethod

Encryption method type:

  • NONE

  • PKCS

  • DES

  • PKCS_DES

  • PGP_DES

  • PGP_DES_MD5

  • PEM_DES_MD5

String

R

clientType

FIX session type:

  • GENERIC

  • CME_ILINK

String

R

status

Original session status

String

R

statusGroup

Unified session status.

Possible values:

  • DISCONNECTED

  • CONNECTING

  • RECONNECTING

  • ESTABLISHED

  • PLANNED

String

R

backupState

Indicate which connection parameters are active.

Possible values:

  • PRIMARY

  • BACKUP

String

R

configuration

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

CompositeData

R

Operations:

Name

Description

Signature

Return Type

Name

Description

Signature

Return Type

stop

Disconnect current FIX session.

Return true if operation is successful.

String reason

boolean

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 testRequestId

boolean

send

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

Return true if operation is successful.

String fixMessage

boolean

Notifications:

Event

Description

Notification Type

Attribute Type

Attribute Name

Event

Description

Notification Type

Attribute Type

Attribute Name

Session statusGroup changed

Whenever session status group is changed it sends notification. Notification isn't sent if the session status changes within a same status group.

AttributeChangeNotification

String

statusGroup

Session status changed

Whenever session status is changed (servers started or stopped) it sends notification.

AttributeChangeNotification

String

status

 

AcceptorFIXSessionProviderMBean

FIXAcceptorSessionMBean provides instruments for initiator session monitoring and management.

MBean Details

Object Name

com.epam.fixengine:type=FIXSession,subtype=acceptor,name=<session_id>

Instances Per Node

0..N

Attributes:

Name

Description

Type

R/W

Name

Description

Type

R/W

id

Unique FIX session identificator

String

R

senderCompId

SenderCompID (49) tag value for this session

String

R

senderSubId

SenderSubID (50) tag value for this session

String

R

senderLocationId

SenderLocationID (142) tag value for this session

String

R

targetCompId

TargetCompID (56) tag value for this session

String

R

targetSubId

TargetSubID (47) tag value for this session

String

R

targetLocationId

TargetLocationID (143) tag value for this session

String

R

sessionQualifier

Extra session identifier

String

R

fixVersion

FIX protocol version

String

R

applVersion

Application version of FIX protocol

String

R

hbi

Heartbeat interval size

int

R

inSeqNum

Current incoming sequence number

long

R/W

outSeqNum

Current outgoing sequence number

long

R/W