JMS Object Array Output Adapter Configuration

Configure the JMS Object Array Output adapter by specifying values for the ESP connector, formatter, and transporter modules in the adapter configuration file.

Logging

Parameter Description
Log4jProperty

Type: string

(Optional) Specify the path to the log4j.properties logging file you wish to use. The default value is $ESP_HOME/adapters/framework/config/log4j.properties.

ESPConnector Module: ESP Subscriber

Parameter Description
Module

(Required) Section containing all information for this module. It contains a type attribute for specifying the module type.

For example, espconnector.

InstanceName

Type: string

(Required) Specify the instance name of the specific module you wish to use. For example, MyInputTransporter.

Name

Type: string

(Required) The name of the module as defined in the modulesdefine.xml file. For example, <TransporterType>InputTransporter.

Next

Type: string

(Required) Specify the instance name of the module that follows this one.

Parameters

Section containing the EspSubscriberParameters parameter.

EspSubscriberParameters

(Required) Section containing parameters 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 parameter of the Event Stream Processor (EspProjects) parameters section.

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 property 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 property as the adapter automatically detects the stream name.

Formatter Module: ESP to Object List Formatter

Parameter Description
Module

(Required) Section containing all information for this module. It contains a type attribute for specifying the module type.

For example, formatter.

InstanceName

Type: string

(Required) Specify the instance name of the specific module you wish to use. For example, MyInputTransporter.

Name

Type: string

(Required) The name of the module as defined in the modulesdefine.xml file. For example, <TransporterType>InputTransporter.

Next

Type: string

(Required) Specify the instance name of the module that follows this one.

Parallel

Type: boolean

(Optional) If set to true, the module runs as a separated thread. The default value is true.

Parameters

(Required) Section containing the EspToObjectListFormatterParameters parameter.

EspToObjectListFormatterParameters

(Required) Section containing the ESP to Object List formatter parameters.

OutputAsSQLDatetimeFormat

Type: boolean

(Optional) Specify whether the Event Stream Processor date, timestamp, and bigdatetime datatypes are output as java.sql.Date or java.sql.Timestamp.

The default output is java.util.Date.

Transporter Module: JMS Output Transporter

Parameter Description
Module

(Required) Section containing all information for this module. It contains a type attribute for specifying the module type.

For example, transporter.

InstanceName

Type: string

(Required) Specify the instance name of the specific module you wish to use. For example, MyInputTransporter.

Name

Type: string

(Required) The name of the module as defined in the modulesdefine.xml file. For example, <TransporterType>InputTransporter.

Parameters

(Required) Section containing the JMSOutputTransporterParameters parameter.

JMSOutputTransporterParameters

(Required) Section containing the JMS Output transporter parameters.

ConnectionFactory

Type: string

(Required) Specify the connection factory class name. No default value.

JndiContextFactory

Type: string

(Required) Specify the context factory for JNDI context initialization. No default value.

JndiUrl

Type: string

(Required) Specify the JNDI URL. No default value.

Destination Type

Type: string

(Required) Specify the destination type. Valid values are: QUEUE and TOPIC. The default value is QUEUE.

DestinationName

Type: string

(Required) Specify the destination name. No default value.

MessageType

Type: string

(Required) Specify the message type you want the JMS transporter to process. These types are supported:
  • TEXT - for receiving and sending messages in text string
  • OBJARRAY - for receiving and sending messages in custom format
No default value.
DeliveryMode

Type: string

(Optional) Specify the delivery mode type. Valid values are:
  • PERSISTENT
  • NON_PERSISTENT
Default value is PERSISTENT.

Event Stream Processor Parameters

Event Stream Processor parameters configure communication between Event Stream Processor and the JMS Object Array Output adapter.

Parameter Description
EspProjects

Section containing parameters for connecting to Event Stream Processor.

EspProject

Section containing the Name and Uri parameters. 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 Event Stream Processor cluster. For example, esp://localhost:19011/ws1/p1.

Security

Section containing all the authentication parameters 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. Default value is false. If set to true, the password value is decrypted using RSAKeyStore and RSAKeyStorePassword.

AuthType

Type: string

(Required) Specifies method used to authenticate to the Event Stream Processor. Valid values are:
  • server_rsa – RSA authentication using keystore
  • kerberos – Kerberos authentication using ticket-based authentication
  • user_password – LDAP, SAP BI, and Native OS (user name/password) authentication

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.