org.xwiki.observation.remote

Interface RemoteObservationManager

@Role
public interface RemoteObservationManager

Provide apis to manage the event network interface.

Since:

2.0M3

Version:

$Id: f7b20d08f44a4487bcf4a877b1746a96f6e36d7c $

Method Summary

Modifier and Type	Method and Description
void	notify(LocalEventData event) Send a event in the different network channels.
void	notify(RemoteEventData event) Inject a remote event in the local ObservationManager.
void	startChannel(String channelId) Start a channel.
void	stopChannel(String channelId) Stop a running channel.

Method Detail

notify

void notify(LocalEventData event)

Send a event in the different network channels.

This method is not supposed to be used directly for a new event unless the user specifically want to bypass or emulate ObservationManager.

Parameters:

event - the event

notify

void notify(RemoteEventData event)

Inject a remote event in the local ObservationManager.

This method is not supposed to be used directly for a new event unless the user specifically want to bypass or emulate network.

Parameters:

event - the event

stopChannel

void stopChannel(String channelId)
          throws RemoteEventException

Stop a running channel.

Parameters:

channelId - the identifier of the channel to stop

Throws:

RemoteEventException - error when trying to stop a running channel

startChannel

void startChannel(String channelId)
           throws RemoteEventException

Start a channel.

Parameters:

channelId - the identifier of the channel to start

Throws:

RemoteEventException - error when trying to start a channel