Classes

Class	Line #	Total Statements	% Filtered	Complexity	Uncovered Elements	TOTAL Coverage	Actions
RemoteObservationManager	31	0	-	0	0	-1.0 -	Show methods

Class RemoteObservationManager

Class RemoteObservationManager	Line # 31	Total Statements 0	% Filtered -	Complexity 0	Uncovered Elements 0	TOTAL Coverage -1.0 -

 

Contributing tests

Source view

1		/*
2		* See the NOTICE file distributed with this work for additional
3		* information regarding copyright ownership.
4		*
5		* This is free software; you can redistribute it and/or modify it
6		* under the terms of the GNU Lesser General Public License as
7		* published by the Free Software Foundation; either version 2.1 of
8		* the License, or (at your option) any later version.
9		*
10		* This software is distributed in the hope that it will be useful,
11		* but WITHOUT ANY WARRANTY; without even the implied warranty of
12		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13		* Lesser General Public License for more details.
14		*
15		* You should have received a copy of the GNU Lesser General Public
16		* License along with this software; if not, write to the Free
17		* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
18		* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
19		*/
20		package org.xwiki.observation.remote;
21
22		import org.xwiki.component.annotation.Role;
23
24		/**
25		* Provide apis to manage the event network interface.
26		*
27		* @version $Id: f7b20d08f44a4487bcf4a877b1746a96f6e36d7c $
28		* @since 2.0M3
29		*/
30		@Role
		- Uncovered Elements: 0 (0) Complexity: 0 Complexity Density: -
31		public interface RemoteObservationManager
32		{
33		/**
34		* Send a event in the different network channels.
35		* <p>
36		* This method is not supposed to be used directly for a new event unless the user specifically want to bypass or
37		* emulate {@link org.xwiki.observation.ObservationManager}.
38		*
39		* @param event the event
40		*/
41		void notify(LocalEventData event);
42
43		/**
44		* Inject a remote event in the local {@link org.xwiki.observation.ObservationManager}.
45		* <p>
46		* This method is not supposed to be used directly for a new event unless the user specifically want to bypass or
47		* emulate network.
48		*
49		* @param event the event
50		*/
51		void notify(RemoteEventData event);
52
53		/**
54		* Stop a running channel.
55		*
56		* @param channelId the identifier of the channel to stop
57		* @throws RemoteEventException error when trying to stop a running channel
58		*/
59		void stopChannel(String channelId) throws RemoteEventException;
60
61		/**
62		* Start a channel.
63		*
64		* @param channelId the identifier of the channel to start
65		* @throws RemoteEventException error when trying to start a channel
66		*/
67		void startChannel(String channelId) throws RemoteEventException;
68		}