public interface Advisory
This interface class defines constants related to advisory messages, their field names and field values.
Customers do not implement this interface.
For more information, see the chapter "Advisory Messages" in the book TIBCO FTL Development.
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ENDPOINT_NAME
Name of the special endpoint that carries FTL advisory
messages; string.
|
static java.lang.String |
FIELD_ADVISORY
A field with this field name distinguishes advisory messages.
|
static java.lang.String |
FIELD_AGGREGATION_COUNT
Aggregation incidents (field name).
|
static java.lang.String |
FIELD_AGGREGATION_TIME
Aggregation time interval (field name).
|
static java.lang.String |
FIELD_ENDPOINTS
Endpoints (field name).
|
static java.lang.String |
FIELD_LOCK_NAME
Lock Name (field name).
|
static java.lang.String |
FIELD_MODULE
Module (field name).
|
static java.lang.String |
FIELD_NAME
Advisory name (field name).
|
static java.lang.String |
FIELD_QUEUE_NAME
Queue name (field name).
|
static java.lang.String |
FIELD_REASON
Advisory reason (field name).
|
static java.lang.String |
FIELD_SEVERITY
Advisory severity (field name).
|
static java.lang.String |
FIELD_SUBSCRIBER_NAME
Subscriber name (field name).
|
static java.lang.String |
FIELD_TIMESTAMP
Timestamp (field name).
|
static java.lang.String |
MODULE_BASE
The advisory message pertains to the FTL API base library
implementation code (field value).
|
static java.lang.String |
NAME_DATALOSS
The advisory message reports data loss (name).
|
static java.lang.String |
NAME_LOCK_LOST
The advisory message reports that a lock previously held by
this application was stolen by some other application.
|
static java.lang.String |
NAME_RESOURCE_AVAILABLE
The advisory message reports that a resource is available.
|
static java.lang.String |
NAME_RESOURCE_UNAVAILABLE
The advisory message reports that a resource is unavailable.
|
static java.lang.String |
NAME_RETRANSMISSION
The advisory message reports multicast retransmission.
|
static java.lang.String |
NAME_SUBSCRIBER_FORCE_CLOSE
The advisory message reports that a persistence store
forced a durable subscriber to close.
|
static java.lang.String |
REASON_DURABLE_SUBSCRIBER_COLLISION
The advisory reports that a persistence store forced a
subscriber to close; the reason is durable subscriber
collision.
|
static java.lang.String |
REASON_FAILOVER_LOSS
The advisory reports potential data loss;
the reason is failover to a backup forwarding component.
|
static java.lang.String |
REASON_INCOMPLETE_MESSAGE
The advisory reports data loss;
the reason is an incomplete message.
|
static java.lang.String |
REASON_LOCK_LOST_ON_DISCONNECT
The advisory reports lock lost notification;
the reason is a lock that was previously held by this
application was lost because of a disconnect from the
persistence store.
|
static java.lang.String |
REASON_LOCK_STOLEN
The advisory reports lock lost notification;
the reason is a lock that was previously held by this
application was stolen by some other application.
|
static java.lang.String |
REASON_PERSISTENCE_STORE_AVAILABLE
The advisory reports resource availability;
the reason is that a persistence store is available.
|
static java.lang.String |
REASON_PERSISTENCE_STORE_AVAILABLE_AFTER_CLUSTER_DATALOSS
The advisory reports resource availability;
the reason is that a persistence store is available
but the cluster lost some or all data.
|
static java.lang.String |
REASON_PERSISTENCE_STORE_UNAVAILABLE
The advisory reports resource unavailability;
the reason is that a persistence store is not available.
|
static java.lang.String |
REASON_QUEUE_LIMIT_EXCEEDED
The advisory message reports data loss; the reason is overflow of an event queue.
|
static java.lang.String |
REASON_RECONNECT_LOSS
The advisory reports potential data loss; the
reason is a temporary network disconnect between two
connection-oriented transports (that is, TCP or RDMA).
|
static java.lang.String |
REASON_RETRANSMISSION_REQUEST
The advisory reports that the subscribing endpoint
of a multicast transport in the application
requested retransmission from a publishing endpoint.
|
static java.lang.String |
REASON_RETRANSMISSION_REQUEST_SUPPRESSED
The advisory reports that the subscribing endpoint
of a multicast transport in the application
would have requested retransmission,
but request was suppressed.
|
static java.lang.String |
REASON_RETRANSMISSION_SENT
The advisory reports that the publishing endpoint
of a multicast transport in the application
has sent a retransmission as requested.
|
static java.lang.String |
REASON_SENDER_DISCARD
The advisory reports data loss; the reason is that a sending transport
has discarded data in accordance with its backlog settings.
|
static java.lang.String |
REASON_STORE_DISCARD_DATALOSS
The advisory reports data loss when
a subscriber to a last-value durable has missed
one or more messages from the persistence store.
|
static java.lang.String |
REASON_TPORT_DATALOSS
The advisory reports data loss; the reason is a transport problem.
|
static java.lang.String |
REASON_UPSTREAM_LOSS
The advisory reports potential data loss; the
reason is a data loss advisory detected upstream at a forwarding
component (such as a transport bridge).
|
static java.lang.String |
SEVERITY_DEBUG
The advisory message is for debugging (severity value).
|
static java.lang.String |
SEVERITY_INFO
The advisory message is informational (severity value).
|
static java.lang.String |
SEVERITY_WARN
The advisory message is a warning (severity value).
|
static final java.lang.String ENDPOINT_NAME
To receive FTL advisory messages, create a subscriber on the endpoint name _advisoryEndpoint.
The realm object scopes the advisories that a subscriber on this endpoint can receive. That is, a subscriber to this endpoint receives only those advisories produced by other objects in the same program and the same realm (as the advisory subscriber).
It is illegal to create a publisher on this endpoint name.
static final java.lang.String FIELD_ADVISORY
All advisory messages contain this field. Only advisory messages may contain this field.
Use this field only for matching purposes. Your program code must never set this field in any message. This field always has the integer value 1.
static final java.lang.String FIELD_SEVERITY
The string value of the severity field classifies each advisory according to the ability of FTL to fulfill its function as a message carrier.
SEVERITY_WARN
,
SEVERITY_INFO
,
SEVERITY_DEBUG
,
Constant Field Valuesstatic final java.lang.String SEVERITY_WARN
Warnings indicate that although FTL functionality is impaired, FTL still continues to operate. As a result of impaired messaging, your application might behave incorrectly.
This string value can appear in the severity field.
FIELD_SEVERITY
,
Constant Field Valuesstatic final java.lang.String SEVERITY_INFO
Informational advisories can report external state changes, or signal your program to change its operating state. Informational advisories do not indicate impaired FTL behavior.
This string value can appear in the severity field.
static final java.lang.String SEVERITY_DEBUG
Debug advisories can report internal state changes, or signal an administrator to investigate. Debug advisories do not indicate impaired behavior.
This string value can appear in the severity field.
FIELD_SEVERITY
,
NAME_RETRANSMISSION
,
Constant Field Valuesstatic final java.lang.String FIELD_MODULE
The string value of the module field denotes the part of FTL to which the advisory pertains.
static final java.lang.String MODULE_BASE
This string value can appear in the module field.
FIELD_MODULE
,
Constant Field Valuesstatic final java.lang.String FIELD_NAME
The string value of the name field denotes the main issue that the advisory reports.
static final java.lang.String NAME_DATALOSS
This string value can appear in the name field.
The reason field distinguishes among several reasons for data loss.
static final java.lang.String NAME_SUBSCRIBER_FORCE_CLOSE
This string value can appear in the name field.
The reason field indicates the reason that the store forced the durable subscriber to close.
static final java.lang.String NAME_RESOURCE_UNAVAILABLE
This string value can appear in the name field.
The reason field notes the unavailable resource.
static final java.lang.String NAME_RESOURCE_AVAILABLE
This string value can appear in the name field.
The reason field notes the available resource.
static final java.lang.String NAME_RETRANSMISSION
This string value can appear in the name field.
Retransmission is a normal occurrence for multicast transports. Retransmission advisories give applications access to data about network conditions.
The reason field distinguishes the type of retransmission advisory.
static final java.lang.String NAME_LOCK_LOST
This string value can appear in the name field.
static final java.lang.String FIELD_REASON
The string value of the reason field provides additional information about the reason for the advisory (adding detail to the name field).
REASON_QUEUE_LIMIT_EXCEEDED
,
REASON_TPORT_DATALOSS
,
REASON_SENDER_DISCARD
,
REASON_RECONNECT_LOSS
,
REASON_UPSTREAM_LOSS
,
REASON_STORE_DISCARD_DATALOSS
,
REASON_INCOMPLETE_MESSAGE
,
REASON_FAILOVER_LOSS
,
REASON_DURABLE_SUBSCRIBER_COLLISION
,
REASON_PERSISTENCE_STORE_UNAVAILABLE
,
REASON_PERSISTENCE_STORE_AVAILABLE
,
REASON_PERSISTENCE_STORE_AVAILABLE_AFTER_CLUSTER_DATALOSS
,
REASON_RETRANSMISSION_REQUEST
,
REASON_RETRANSMISSION_SENT
,
REASON_RETRANSMISSION_REQUEST_SUPPRESSED
,
Constant Field Valuesstatic final java.lang.String REASON_QUEUE_LIMIT_EXCEEDED
The queue has discarded some events, in accordance with its property values.
This string value can appear in the reason field.
Common Diagnoses
static final java.lang.String REASON_TPORT_DATALOSS
This string value can appear in the reason field.
static final java.lang.String REASON_SENDER_DISCARD
This string value can appear in the reason field.
static final java.lang.String REASON_RECONNECT_LOSS
This string value can appear in the reason field.
static final java.lang.String REASON_FAILOVER_LOSS
Only connection-oriented transports can detect this condition.
This string value can appear in the reason field.
static final java.lang.String REASON_UPSTREAM_LOSS
This string value can appear in the reason field.
static final java.lang.String REASON_INCOMPLETE_MESSAGE
The transport could not reassemble an inbound message because some data fragments did not arrive.
This string value can appear in the reason field.
static final java.lang.String REASON_DURABLE_SUBSCRIBER_COLLISION
Each durable can serve at most one durable subscriber object at a time. The store resolves collisions in favor of the newer durable subscriber, forcing the older subscriber to close.
This string value can appear in the reason field.
static final java.lang.String REASON_PERSISTENCE_STORE_UNAVAILABLE
This string value can appear in the reason field.
static final java.lang.String REASON_PERSISTENCE_STORE_AVAILABLE
This string value can appear in the reason field.
NAME_RESOURCE_AVAILABLE
,
FIELD_REASON
,
Constant Field Valuesstatic final java.lang.String REASON_PERSISTENCE_STORE_AVAILABLE_AFTER_CLUSTER_DATALOSS
This string value can appear in the reason field.
NAME_RESOURCE_AVAILABLE
,
FIELD_REASON
,
Constant Field Valuesstatic final java.lang.String REASON_RETRANSMISSION_REQUEST
This string value can appear in the reason field.
static final java.lang.String REASON_RETRANSMISSION_SENT
This string value can appear in the reason field.
static final java.lang.String REASON_RETRANSMISSION_REQUEST_SUPPRESSED
Suppression can occur when a multicast transport enables retransmission control, and a subscribing endpoint misses packets in excess of a specified threshold.
This string value can appear in the reason field.
static final java.lang.String REASON_STORE_DISCARD_DATALOSS
It can also report potential data loss because the subscriber disconnected from the store.
This string value can appear in the reason field.
static final java.lang.String REASON_LOCK_STOLEN
This string value can appear in the reason field.
static final java.lang.String REASON_LOCK_LOST_ON_DISCONNECT
This string value can appear in the reason field.
static final java.lang.String FIELD_TIMESTAMP
The TibDateTime
value of the
timestamp field indicates the time that
FTL generated the advisory.
Although DateTime values can represent time with nanosecond precision, the actual resolution of the timestamp is only as fine-grained as the host computer's operating system supports.
TibDateTime
,
Constant Field Valuesstatic final java.lang.String FIELD_AGGREGATION_COUNT
Some advisory messages report aggregate data, representing several incidents that occurred within a time interval. The long integer value of the aggregation_count field indicates the number of incidents.
In DATALOSS advisories with reason QUEUE_LIMIT_EXCEEDED, this value reports the number of events that the queue discarded.
FIELD_AGGREGATION_TIME
,
Constant Field Valuesstatic final java.lang.String FIELD_AGGREGATION_TIME
Some advisory messages report aggregate data, representing several incidents that occurred within a time interval. The double floating point value of the aggregation_time field indicates the length of the time interval (in seconds).
The time interval ends shortly before the timestamp on the advisory message.
FIELD_AGGREGATION_COUNT
,
Constant Field Valuesstatic final java.lang.String FIELD_QUEUE_NAME
This field appears in DATALOSS advisories with reason QUEUE_LIMIT_EXCEEDED.
The string value of the queue_name field identifies the queue that discarded excess events.
If the queue's name property is not set, then the advisory message omits this field.
static final java.lang.String FIELD_ENDPOINTS
This field can appear in DATALOSS, SUBSCRIBER_FORCE_CLOSE, and RETRAMSMISSION advisories.
Although data loss occurs primarily in a transport, its symptoms could affect all endpoints that use the transport -- and by extension, any subscriber on those endpoints. Furthermore, transport names are meaningful to administrators, but usually not available to programmers. This advisory field reports the set of all endpoints through which the program could access the problematic transport (according to the configuration in the local realm object).
This field does not appear in DATALOSS advisories with reason QUEUE_LIMIT_EXCEEDED.
static final java.lang.String FIELD_SUBSCRIBER_NAME
This field can appear in SUBSCRIBER_FORCE_CLOSE advisories.
The string value of the subscriber_name field identifies the closed durable subscriber.
static final java.lang.String FIELD_LOCK_NAME
This field can appear in LOCK_LOST advisories.
The string value of the lock_name field identifies the name of the lock that was stolen by some other application.NAME_LOCK_LOST
,
Constant Field Values