Apache Sandesha2 reports can be used to get information from a running Sandesha2 system. Most of the times these reports will be requested through your client code. There are two kinds of Sandesha2 reports you can request for. First kind of reports are named SandeshaReport's. A SandeshaReport gives information on the RM status of the whole system. You can request for a SandeshaReport using following function of the Sandesha2 API.

SandeshaReport getSandeshaReport(ConfigurationContext ctx);

The information currently given from the SandeshaReport are following:

• A list of sequence IDs of all the incoming sequences.
• A list of sequence IDs of all outgoing sequences.
• The status of each sequence.
• Number of completed messages of each sequence.

The second kind of reports are the SequenceReports. Unlike SandeshaReports, SequenceReport only gives information about a single sequence. But this information will be much broader. You can request for a SequenceReport using following functions of the Sandesha2 API.

SequenceReport getOutgoingSequenceReport(ServiceClient serviceClient);
SequenceReport getOutgoingSequenceReport(String to, String sequenceKey,
ConfigurationContext configurationContext);
SequenceReport getOutgoingSequenceReport(String internalSequenceID, 
ConfigurationContext configurationContext);
ArrayList getIncomingSequenceReports(ConfigurationContext configCtx);
SequenceReport getIncomingSequenceReport(String sequenceID, 
ConfigurationContext configCtx);

As you can see, there functions can be divided into two groups. The first three functions will give information about out going sequence which are the sequences where the current endpoint works as a RM source. The last two functions allows you to obtain reports on incoming sequences on which the current endpoint works as a RM destination. A sequence report gives following information about a sequence.

• The status of the sequence.
• The direction of the sequence.
• The sequence ID.
• The completed messages of the sequence.
• Whether the sequence is secured.

Applies To:

Apache Sandesha2/Java post 1.0 versions