Configuring the socket transport

The socket transport allows the probe to connect to a target system and subscribe to receive all events sent to a specific port.

Socket transport properties

The following table describes the properties in the socketTransport.properties file.

Note: When using the Socket transport, you must specify values for the Host and Port properties in the message_bus.props file.
Table 1. Properties in the socketTransport.properties file

Property name

Description

serverPort

Use this property to specify the port on the server to which the target system sends events.

clientAddress

Use this property to specify the client address to which the probe connects.

subscribeMessages

Use this property to specify a list of the messages that the probe will send when subscribing as an asynchronous client.

subscribeResponses

Use this property to specify a list of response processors for the subscribe messages.

Note: This property must contain the same number of entries as the subscribeMessagesproperty.

disconnectMessages

Use this property to specify the messages sent when disconnecting an asynchronous client.

disconnectResponses

Use this property to specify response processors for the disconnect messages.

activeAlarmMessages

Use this property to specify the messages sent when requesting active alarms as an asynchronous client.

messageTerminator

Use this property to specify the regular expression that marks the end of each alert from the target system.

readResponseAttempts

Use this property to specify the number of times the probe should attempt to read a response sent as a result of subscribing, disconnecting, or getting active alarms.

readResponseDelay

Use this property to specify the interval (in seconds) that the probe should wait between successive read attempts.

threadPoolSize

Use this property to specify the maximum number of threads to use to process connections made to the probe when it is running as a server.

The following is an example of a socketTransport.properties file:
# Example format of Socket properties file
# serverPort=12345
# clientAddress=some.host.com:port
# subscribeMessages=/first/message.txt:/second/message.xml
# subscribeResponses=none:xslt("/second/response_processor.xsl","\n\n")
# disconnectMessages=/first/message.txt:/second/message.xml
# disconnectResponses=none:xslt("/second/response_processor.xsl","\n\n")
# activeAlarmMessages=/first/message.txt:/second/message.xml
# messageTerminator=\n\n
# readResponseAttempts = 60
# readResponseDelay = 1
# threadPoolSize = 10