Adapter properties and commands

This section lists the properties supported by the adapter.

This section lists the properties supported by the adapter.

URL

Specifies the URL or the Broker URI that allows to run a configured broker using a single URI for all the configuration (example of default broker URL: tcp://localhost:61616). This required parameter is needed at the time of setting the connection. This is mandatory parameter. The URL can be used with -URL command.

Login Username

Specifies the username to use for authentication when connecting to the message broker. The corresponding adapter command is -U username (or -USERNAME username).

Login Password

Specifies the password value to use for authentication when connecting to the message broker. The corresponding adapter command is -P password (or -PASSWORD password).

Truststore File

Specifies the path to the truststore in PKCS#12 or JKS format that the adapter uses to validate the broker certificate when SSL/TLS is enabled. The truststore must contain the chain of certificates up to the CA certificate that is used to sign the broker certificate. The corresponding adapter command is -TSL path (or -TRUSTSTORELOCATION path).

Truststore Password

Specifies the password for the adapter to use to access the specified truststore when SSL/TLS is enabled. The corresponding adapter command is -TSP password (or -TRUSTSTOREPASSWORD password).

Truststore Type

Specifies the type of truststore (PKCS#12 or JKS). The corresponding adapter command is -TST type (or -TRUSTSTORETYPE type).

Keystore File

Specifies the path to the keystore in PKCS#12 or JKS format that the adapter uses to retrieve the private key and certificate with the public key. Which is required, if the broker is configured to request clients to provide a certificate for SSL/TLS connections. The corresponding adapter command is -KSL path (or -KEYSTORELOCATION path).

Keystore Password

pecifies the password for the adapter to access the specified keystore when SSL/TLS is enabled. The corresponding adapter command is -KSP password (or –KEYSTOREPASSWORD password).

Key Password

Specifies the password for the adapter to access the private key in the specified keystore when SSL/ TLS is enabled. The password is required, if the private key is secured with a password different from the keystore password. The corresponding adapter command is -KP password (or -KEYPASSWORD password).

Key Type

Specifies the type of Keystore (PKCS#12, JKS, or JVM). The corresponding adapter command is -KST type (or -KEYSTORETYPE type).

Read Mode

Specifies whether to keep or delete the messages in ActiveMQ queue after a successful read operation. The corresponding adapter command is -RM keep|delete (or -READMODE keep|delete).

Note: The default is keep, so it is not necessary to specify -READMODE keep.

Create Queue

This is a boolean flag. It is used at the time of sending a message to the ActiveMQ. If this flag is set to true and the particular queue is not present, it will create the queue. If this flag is set to false and the queue is not present, user will get invalid queue name exception. If the value is not mentioned for this flag, then by default the value is false. The corresponding adapter command is -CQ (or -CREATEQUEUE).

Queue Name

Specifies the queue name to and from which messages are to be sent and received. This is mandatory parameter. Queue name property can be passed to adapter input or output cards using -Q (or -QUEUE) command.

Message Type

Specifies the type of message being sent to the ActiveMQ adapter. The currently supported message types are: Text, Blob, Byte. Examples of Blob file are a large image file, and a PDF file among others. An 'invalid message type' exception will occur, if a user tries to set a message type other than the supported ones. Though this is an optional parameter, it is recommended to set a message type at the time of creating an output card. Message type property can be passed to adapter output cards using -MT (or -MSGTYPE ) command.

Delay Time

Specifies the time duration after the lapse of which, the adapter will look out for the next message. A timeout of zero never expires, and the call blocks indefinitely. The timeout value is specified in milliseconds. This property is optional but recommended to set when receiving message from ActiveMQ (used in input card) with a minimum value (1) to avoid getting stuck in case no message is present in the queue. The Delay-time property can be passed to adapter input using -DT (or -DELAYTIME) command.

Logging

Specifies the level of logging to use for the log (trace) file produced by the adapter. The default is Off. The value Information means log informational, the value Errors Only means log error messages only, and the value Verbose means log debug and trace level messages along with the informational and error messages.

The corresponding adapter command is:

-T [E|V] [+] [file_path]

-T -> Log adapter informational messages.

-TE -> Log only adapter errors.

-TV -> Use verbose (debug) logging. The log file records all activity that occurs while the adapter is producing or consuming messages.

+ -> Appends the trace information to the existing log file. Omit this argument to create a new log file.

file_path -> The full path to the adapter trace log. If you omit this keyword, the adapter creates the m4activeMQ.trc log file in the map directory

Append Log

Specifies the flag that indicates the action to be taken when the specified log file already exists. When set to true, the log messages are appended to the file. When set to false: the file is truncated, and the messages are written to the empty file. The default value is true.

Log File Name

This is the name of the log file, where the log messages are written. If not specified, the default log file name m4activeMQ.trc is used, and the file is stored to the directory in which the executed compiled map resides.