AdapterStatusRegister

FRAMES NO FRAMES

Overview

Package

Deprecated

Help

API Reference for EPL (ApamaDoc) 10.11.3.3

SUMMARY: IMPORT | CONSTANT | MEMBER | ACTION

DETAIL: IMPORT | CONSTANT | MEMBER | ACTION

com.apama.adapters
Event AdapterStatusRegister

Sent from a client monitor to the IAFStatusManager, to register interest in receiving status events from the specified codec and transport. The fields of this event uniquely identify a subscription.

Member summary
`string`	`adapterName` An identifier that will be used to refer to this transport and codec pair when registering, deregistering or monitoring adapter status.
`string`	`codec` The name of the adapter's codec as it is specified in the adapter configuration file.
`string`	`transport` The name of the adapter's transport as it is specified in the adapter configuration file.
`string`	`codecVersion` Codec version filter: in most cases, specify empty string ("") for this field.
`string`	`transportVersion` Transport version filter: in most cases, specify empty string ("") for this field.
`string`	`configVersion` Configuration version filter: in most cases, specify empty string ("") for this field.
`string`	`channel` The name of the channel the IAF adapter is receiving events from.

Member detail

adapterName

            string adapterName

An identifier that will be used to refer to this transport and codec pair when registering, deregistering or monitoring adapter status.

channel

            string channel

The name of the channel the IAF adapter is receiving events from.

codec

            string codec

The name of the adapter's codec as it is specified in the adapter configuration file.

codecVersion

            string codecVersion

Codec version filter: in most cases, specify empty string ("") for this field.

If set to a non-empty string, this field indicates the precise codec version that the client depends on, which will lead to a failed subscription attempt and an AdapterError event being sent to the client if the versions do not match exactly.

The reason that Apama now recommends this field should usually be empty is that most applications should implement a less simplistic policy for handling version mismatch by specifying an empty string for this value when subscribing, and then testing the version in an application-specific when the AdapterUp event is received, e.g. logging a WARN rather than failing entirely when there's a version mismatch, or checking the major.minor version only (to avoid failing when the fix version number is changed).

It is particularly important not to set the codecVersion filter for applications in a persistent Correlator, since a product or adapter upgrade that changes the fix version number is likely to prevent the application from working correctly (unless specific steps are taken to delete and reinject associated EPL as part of the upgrade).

configVersion

            string configVersion

Configuration version filter: in most cases, specify empty string ("") for this field.

If set to a non-empty string, this field indicates the precise configuration version that the client depends on, which will lead to a failed subscription attempt and an AdapterError event being sent to the client if the versions do not match exactly.

If the adapter specifies a CONFIG_VERSION in the status dictionary returned by getStatus(), the value of this field must either be the same or be an empty string (""); if the adapter transport does not specify a CONFIG_VERSION, this value must be an empty string.

The reason that Apama now recommends this field should usually be empty is that most applications should implement a less simplistic policy for handling version mismatch by specifying an empty string for this value when subscribing, and then testing the version in an application-specific when the AdapterUp event is received, e.g. logging a WARN rather than failing entirely when there's a version mismatch, or checking the major.minor version only (to avoid failing when the fix version number is changed).

It is particularly important not to set the configVersion filter for applications in a persistent Correlator, since a product or adapter upgrade that changes the fix version number is likely to prevent the application from working correctly (unless specific steps are taken to delete and reinject associated EPL as part of the upgrade).

transport

            string transport

The name of the adapter's transport as it is specified in the adapter configuration file.

transportVersion

            string transportVersion

Transport version filter: in most cases, specify empty string ("") for this field.

If set to a non-empty string, this field indicates the precise transport version that the client depends on, which will lead to a failed subscription attempt and an AdapterError event being sent to the client if the versions do not match exactly.

The reason that Apama now recommends this field should usually be empty is that most applications should implement a less simplistic policy for handling version mismatch by specifying an empty string for this value when subscribing, and then testing the version in an application-specific when the AdapterUp event is received, e.g. logging a WARN rather than failing entirely when there's a version mismatch, or checking the major.minor version only (to avoid failing when the fix version number is changed).

It is particularly important not to set the transportVersion filter for applications in a persistent Correlator, since a product or adapter upgrade that changes the fix version number is likely to prevent the application from working correctly (unless specific steps are taken to delete and reinject associated EPL as part of the upgrade).