Configure the Socket XML Output adapter by specifying values for the ESP connector, formatter, and transporter modules in the adapter configuration file.
| XML Element | Description |
|---|---|
| Log4jProperty |
Type: string (Optional) Specify a full path to the log4j.properties logging file you wish to use. The default value is $ESP_HOME/adapters/framework/config/log4j.properties. |
The ESP Subscriber module obtains data from an ESP project and passes it along to a transporter or formatter module.
| XML Element | Description |
|---|---|
| Module |
(Required) Element containing all information for this module. It contains a type attribute for specifying the module type. For example, espconnector. |
| InstanceName |
Type: string (Required) Instance name of the specific module you want to use. For example, MyInputTransporter. |
| Name |
Type: string (Required) Name of the module as defined in the modulesdefine.xml file. For example, <TransporterType>InputTransporter. |
| Next |
Type: string (Required) Instance name of the module that follows this one. |
| BufferMaxSize |
Type: integer (Advanced) Capacity of the buffer queue between this module and the next. The default value is 10240. |
| Parameters |
Element containing the EspSubscriberParameters element. |
| EspSubscriberParameters |
(Required) Element containing elements for the ESP subscriber. |
| ProjectName |
Type: string (Required if running adapter in standalone mode; optional if running in managed mode) Specifies the unique project tag of the ESP project to which the adapter is connected. For example, EspProject2. This is the same project tag that you specify later in the adapter configuration file in the Name element within the Event Stream Processor (EspProjects) element. If you are starting the adapter with the ESP project to which it is attached (running the adapter in managed mode), you do not need to set this element as the adapter automatically detects the project name. |
| StreamName |
Type: string (Required if running adapter in standalone mode; optional if running in managed mode) Name of the ESP stream from which the adapter subscribes to data. If you are starting the adapter with the ESP project to which it is attached (running the adapter in managed mode), you do not need to set this element as the adapter automatically detects the stream name. |
The ESP to XML String formatter translates AepRecord objects to ESP XML string.
| XML Element | Description |
|---|---|
| Module |
(Required) Element containing all information for this module. It contains a type attribute for specifying the module type. For example, formatter. |
| InstanceName |
Type: string (Required) Instance name of the specific module you want to use. For example, MyInputTransporter. |
| Name |
Type: string (Required) Name of the module as defined in the modulesdefine.xml file. For example, <TransporterType>InputTransporter. |
| Next |
Type: string (Required) Instance name of the module that follows this one. |
| BufferMaxSize |
Type: integer (Advanced) Capacity of the buffer queue between this module and the next. The default value is 10240. |
| Parallel |
Type: boolean (Optional) If set to true, the module runs as a separated thread. The default value is true. |
| Parameters |
(Required) Element containing the EspToXmlStringFormatterParameters element. |
| EspToXmlStringFormatterParameters |
(Required) Element containing the ESP to XML String formatter elements. |
| DateFormat |
Type: string (Optional) Format string for date values from an ESP project. For example, yyyy-MM-dd'T'HH:mm:ss. |
| TimestampFormat |
Type: string (Optional) Format string for timestamp values from an ESP project. For example, yyyy-MM-dd'T'HH:mm:ss.SSS. |
The String to Stream formatter writes Java strings to output streams.
| XML Element | Description |
|---|---|
| Module |
(Required) Element containing all information for this module. It contains a type attribute for specifying the module type. For example, formatter. |
| InstanceName |
Type: string (Required) Instance name of the specific module you want to use. For example, MyInputTransporter. |
| Name |
Type: string (Required) Name of the module as defined in the modulesdefine.xml file. For example, <TransporterType>InputTransporter. |
| Next |
Type: string (Required) Instance name of the module that follows this one. |
| BufferMaxSize |
Type: integer (Advanced) Capacity of the buffer queue between this module and the next. The default value is 10240. |
| Parameters |
(Required) Element containing the StringToStreamFormatterParameters element. |
| StringToStreamFormatterParameters |
(Required) Element containing elements for the String to Stream formatter elements. |
| Delimiter |
Type: string (Required) Specify the symbol that separates columns. The default value is "\n". |
| IncludeDelimiter |
Type: boolean (Required) If set to true, the delimiter is part of current row. If set to false, the delimiter is not part of the current row. The default value is false. |
| AppendString |
Type: string (Required if IncludeDelimiter is set to true) If set to true, specify the string to append to the end of each result row. No default value. |
| AppendPosition |
Type: string (Required if IncludeDelimiter is set to true) Specify the position to which the AppendString element takes effect. There are two valid values: front and end. The default value is front. |
| IgnoreSpace |
Type: boolean (Required) Specify whether to ignore the space char. The default value is false. |
| CharsetName |
Type: string (Advanced) Specify the name of a supported charset. The default value is US-ASCII. |
The Socket Output transporter obtains data from the previous module configured in the adapter configuration file, and outputs it using the socket interface.
| XML Element | Description |
|---|---|
| Module |
(Required) Element containing all information for this module. It contains a type attribute for specifying the module type. For example, transporter. |
| InstanceName |
Type: string (Required) Instance name of the specific module you want to use. For example, MyInputTransporter. |
| Name |
Type: string (Required) Name of the module as defined in the modulesdefine.xml file. For example, <TransporterType>InputTransporter. |
| BufferMaxSize |
Type: integer (Advanced) Capacity of the buffer queue between this module and the next. The default value is 10240. |
| Parameters |
(Required) Element containing the SocketOutputTransporterParameters element. |
| SocketOutputTransporterParameters |
(Required) Element containing the Socket Output transporter elements. |
| Host |
Type: string (Required if EpFile is set to null) If the transporter is acting as a socket client, specify the socket server name. If the transporter is acting as a socket server, do not set this element. No default value. |
| Port |
Type: integer (Required if EpFile is set to null) Specify the socket server port. If you set this to -1, the adapter reads from the ephemeral port file, which is specified in the EpFile element. The default value is 12345. |
| EpFile |
Type: string (Required if Host and Port are set to null) Specify the file that contains the socket server name/IP and port number. No default value. |
| Retryperiod |
Type: integer (Advanced) When the transporter is acting as a socket server, this element designates the length of time to wait for the first incoming connection before switching to the continuous state. When the transporter is acting as a socket client, this element designates the time period for attempting to reestablish an outgoing connection, in seconds. The default value is 0. |
| KeepAlive |
Type: boolean (Advanced) If set to true, the adapter disconnects from the socket server if there are no data transports for the duration of time specified in your router configuration. For example, if you set your router configuration to two hours and there are no messages during that time, the adapter disconnects from the socket server. The default value is false. |
Event Stream Processor elements configure communication between Event Stream Processor and the Socket XML Output adapter.
| XML Element | Description |
|---|---|
| EspProjects |
(Required) Element containing elements for connecting to Event Stream Processor. |
| EspProject |
(Required) Element containing the Name and Uri elements. Specifies information for the ESP project to which the adapter is connected. |
| Name |
Type: string (Required) Specifies the unique project tag of the ESP project which the EspConnector (publisher/subscriber) module references. |
| Uri |
Type: string (Required) Specifies the total project URI to connect to the ESP project. For example, esp://localhost:19011/ws1/p1. |
| Security |
(Required) Element containing all the authentication elements below. Specifies details for the authentication method used for Event Stream Processor. |
| User |
Type: string (Required) Specifies the user name required to log in to Event Stream Processor (see AuthType). No default value. |
| Password |
Type: string (Required) Specifies the password required to log in to Event Stream Processor (see espAuthType). Includes an "encrypted" attribute indicating whether the Password value is encrypted. The default value is false. If set to true, the password value is decrypted using RSAKeyStore and RSAKeyStorePassword. |
| AuthType |
Type: string (Required) Method used to authenticate to the Event Stream Processor. Valid values are:
If the adapter is operated as a Studio plug-in, AuthType is overridden by the Authentication Mode Studio start-up parameter. |
| RSAKeyStore |
Type: string (Dependent required) Specifies the location of the RSA keystore, and decrypts the password value. Required if AuthType is set to server_rsa, or the encrypted attribute for Password is set to true, or both. |
| RSAKeyStorePassword |
Type:string (Dependent required) Specifies the keystore password, and decrypts the password value. Required if AuthType is set to server_rsa, or the encrypted attribute for Password is set to true, or both. |
| KerberosKDC |
Type: string (Dependent required) Specifies host name of Kerberos key distribution center. Required if AuthType is set to kerberos. |
| KerberosRealm |
Type: string (Dependent required) Specifies the Kerberos realm setting. Required if AuthType is set to kerberos. |
| KerberosService |
Type: string (Dependent required) Specifies the Kerberos principal name that identifies an Event Stream Processor cluster. Required if AuthType is set to kerberos. |
| KerberosTicketCache |
Type: string (Dependent required) Specifies the location of the Kerberos ticket cache file. Required if AuthType is set to kerberos. |
| EncryptionAlgorithm |
Type: string (Optional) Used when the encrypted attribute for Password is set to true. If left blank, RSA is used as default. |