org.hawkular.alerts.actions.api

Interface ActionPluginSender

public interface ActionPluginSender

A sender interface that allows to a plugin to send operations message to the alerts engine.

Author:

Jay Shaughnessy, Lucas Ponce

Method Summary

Modifier and Type	Method and Description
ActionResponseMessage	createMessage(ActionResponseMessage.Operation operation) Factory to create new ActionResponseMessage messages.
void	send(ActionResponseMessage msg) Send a message to the engine.

Method Detail

createMessage

ActionResponseMessage createMessage(ActionResponseMessage.Operation operation)

Factory to create new ActionResponseMessage messages. There could be different implementation of messages depending on the context (bus, standalone) so new instances of ActionResponseMessage should be created through this factory method.

Parameters:

operation - the type of operation

Returns:

a new ActionResponseMessage

send

void send(ActionResponseMessage msg)
   throws Exception

Send a message to the engine. Plugin should not have access to the implementation used.

Parameters:

msg - the response message to be sent

Throws:

Exception - any problem