org.mule.tooling.client.api.message.history

Interface MessageHistoryService

public interface MessageHistoryService

Service to collect message history over an application. The service will allow to enable the collection of transactions over an application, retrieve the data and disable the collection of data.

Applications should be deployed by Mule Agent in order to be enabled for message history.

It is up to the clients of the service to disable the message history, if not the message history job on Mule Agent will dispose the resources and stop the collection on Mule Agent side if no messages are consumes after a certain threshold (configured on Mule Agent side).

The service works as a client for the Mule Agent that buffers the components notifications and each invocation to consume(String, int) will update a heartbeat in Mule Agent.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
MessageHistory	consume(String applicationName, int chunkSize) Consumes the transactions that were buffered by the Mule Agent until this moment for the given application.
void	disable(String applicationName) Disables the message history functionality for the given application.
void	enable(String applicationName) Enables the message history functionality for the given application.

Method Detail

enable

void enable(String applicationName)
     throws NoSuchApplicationException

Enables the message history functionality for the given application. Once enable it, the consume(String, int) method would retrieve the transactions collected.

Parameters:

applicationName - a name to be used when deploying the application for collecting notifications

Throws:

NoSuchApplicationException - if the application to be enable for try it is not already deployed.

consume

MessageHistory consume(String applicationName,
                       int chunkSize)

Consumes the transactions that were buffered by the Mule Agent until this moment for the given application.

Parameters:

applicationName - the application name to get its notifications

chunkSize - the maximum amount of notifications to be returned

Returns:

List of notifications

disable

void disable(String applicationName)

Disables the message history functionality for the given application.

Parameters:

applicationName - the application name to be disabled