Broker 10.15 | webMethods Broker Documentation | webMethods Broker Client Java API Programmer's Guide | Creating and Initializing Events | Envelope Fields | Read-only Envelope Fields
 
Read-only Envelope Fields
 
The connectionIntegrity Envelope Field
The pubNetAddr Envelope Field
The route Envelope Field
The table below shows the envelope fields used by the Broker which your application can retrieve, but not alter.
Note:
Attempting to retrieve an envelope field that has not been set will cause a BrokerFieldNotFoundException to be thrown.
Envelope Field
Event Editor Type
Description
age
int
The cumulative time, in seconds, that the event spends on all Brokers.
The Broker starts tracking the age of an event when it receives the event from the publishing client.
The Broker stops tracking the age of an event when the subscribing client removes the event from the client queue.
If the event is routed to successive Brokers, age also includes the length of time the event spends on the other Brokers.
connectionIntegrity
unicode_string
Indicates whether or not the received event passed over an insecure link.
destId
unicode_string
Client ID of the event's recipient. This is used only with delivered events, described on Delivering Events.
enqueueTime
date
The date and time that the Broker enqueued the event for the recipient.
logBroker
unicode_string
The name of the Broker that has this event in its log.
logHost
unicode_string
The host name and port number of the Broker that has this event in its log.
pubDistinguishedName
unicode_string
The distinguished name of the Broker client that published the event using an SSL connection.
pubId
unicode_string
Client ID of the event's publisher. If the publishing client is connect to a different Broker than the recipient, the ID will be fully qualified (prefixed with the name of the publisher's Broker).
pubNetAddr
sequence of bytes
A sequence of bytes in string format that contains the IP address and port number of the event's publisher. See The pubNetAddr Envelope Field for more information on this field.
pubSeqn
long
A 64-bit value representing the event's publish sequence number. The use of publish sequence numbers is described in Using Sequence Numbers.
pubLabel
short[]
Set by the Broker for an event publish by a client which has an access label.
recvTime
date
The date and time the event was received by the Broker.
route
sequence of structs
See The route Envelope Field for more information on this field.
uuid
unicode_string
Universally unique identifier assigned to the event. Used to detect duplicate events.
Your application can use the BrokerEvent.get<type>Field methods to obtain the values of an event that it has received. Be sure to use the appropriate method for the envelope field's type.
Note:
When referring to envelope fields, you must add _env. to each of the field names shown in the table above.
The example below shows how your Broker client can retrieve the pubSeqn value of a received event by using the BrokerEvent.getLongField method and specifying the _env.pubSeqn field name.
. . .
BrokerEvent e;
long seqNumber;
. . .
try {
seqNumber = e.getLongField("_env.pubSeqn");
} catch (BrokerException ex) {
System.out.println("Error on getting envelope field\n"+ex);
return;
}
. . .