com.apama.adapters
Event MonitoringConstants


Constants used in making subscriptions to the connection monitoring service and in interpreting its extra parameters.
Since:
CMF 1.1.0
Version:
10.11
See Also:
com.apama.adapters.IAFConnectionMonitor - The service that these constants are used with
com.apama.statusreport.Status - The stream type that these constants are used in conjunction with

Constant summary
 constant stringADAPTER_SUBSERVICE := "Adapter"

When a connection monitor instance is monitoring an adapter, it will publish status report data with this subService.
 constant stringCONNECTION_GENERATION_PARAM := "ConnectionGeneration"

The extra parameter name used to transmit the connection generation of an adapter connection via the status report event. This information will only be found in subscriptions to connection level status, not adapter level status.
 constant stringCONNECTION_SUBSERVICE := "Connection"

When a connection monitor instance is monitoring a connection from an adapter to an external system, it will publish status report data with this subService.
 constant stringLATENCY_PARAM := "Latency"

The extra parameter name used to transmit the IAF Framework's latency information via the status report event.
 constant stringSERVICE_NAME := "IAFStatus"

The service name used by the connection monitor in parameterising the service framework. Use e.g. to control logging.
 constant stringSERVICE_TYPE := "Status"

The service type used by the connection monitor in parameterising the service framework. Use e.g. to control logging.
 
Constant detail

ADAPTER_SUBSERVICE

            constant string ADAPTER_SUBSERVICE := "Adapter"
        
When a connection monitor instance is monitoring an adapter, it will publish status report data with this subService.
See Also:
com.apama.statusreport.SubscribeStatus#subServiceID - The subscription event that this constant should be used with
com.apama.adapters.MonitorAdapter - When the connection monitor is configured using the MonitorAdapter event, it will publish data on this subservice

CONNECTION_GENERATION_PARAM

            constant string CONNECTION_GENERATION_PARAM := "ConnectionGeneration"
        
The extra parameter name used to transmit the connection generation of an adapter connection via the status report event. This information will only be found in subscriptions to connection level status, not adapter level status.
See Also:
com.apama.statusreport.Status#extraParams - The event that this extra parameter will be placed in

CONNECTION_SUBSERVICE

            constant string CONNECTION_SUBSERVICE := "Connection"
        
When a connection monitor instance is monitoring a connection from an adapter to an external system, it will publish status report data with this subService.
See Also:
com.apama.statusreport.SubscribeStatus#subServiceID - The subscription event that this constant should be used with
MonitorConnection - When the connection monitor is configured using the MonitorConnection event, it will publish data on this subservice

LATENCY_PARAM

            constant string LATENCY_PARAM := "Latency"
        
The extra parameter name used to transmit the IAF Framework's latency information via the status report event.
See Also:
com.apama.statusreport.Status#extraParams - The event that this extra parameter will be placed in

SERVICE_NAME

            constant string SERVICE_NAME := "IAFStatus"
        
The service name used by the connection monitor in parameterising the service framework. Use e.g. to control logging.
See Also:
com.apama.service.framework.ServiceInterface#create - 

SERVICE_TYPE

            constant string SERVICE_TYPE := "Status"
        
The service type used by the connection monitor in parameterising the service framework. Use e.g. to control logging.
See Also:
com.apama.service.framework.ServiceInterface#create -