org.mule.tooling.client.api.tryit

Interface TryItService

public interface TryItService

Service to do try it functionality over an application. The service will allow to enable try it feature over an application, retrieve the collected components notifications and disable the feature.

Applications should be deployed in order to be enabled for try it.

It is up to the clients of the service to disable the feature, if not the try it job on Mule Agent will dispose the resources and stop the feature 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 components notifications that were buffered by the Mule Agent until this moment for the given application.
void	disable(String applicationName) Disables the try it functionality for the given application.
void	enable(String applicationName) Enables the try it functionality for the given application.

Method Detail

enable

void enable(String applicationName)
     throws NoSuchApplicationException

Enables the try it functionality for the given application. Once enable it, the consume(String, int) method would retrieve the notifications 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 components notifications 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 try it functionality for the given application.

Parameters:

applicationName - the application name to be disabled