1. Project Clover database Tue Dec 20 2016 21:24:09 CET
  2. Package org.xwiki.observation.remote.converter

File EventConverterManager.java

 

Code metrics

0
0
0
1
62
13
0
-
-
0
-

Classes

Class Line # Actions
EventConverterManager 35 0 - 0 0
-1.0 -
 

Contributing tests

No tests hitting this source file were found.

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.converter;
21   
22    import java.util.List;
23   
24    import org.xwiki.component.annotation.Role;
25    import org.xwiki.observation.remote.LocalEventData;
26    import org.xwiki.observation.remote.RemoteEventData;
27   
28    /**
29    * Provide events converters.
30    *
31    * @version $Id: 5da25f277c6e62ef86fb6eca48f902d1fc114886 $
32    * @since 2.0M3
33    */
34    @Role
 
35    public interface EventConverterManager
36    {
37    /**
38    * @return the local to remote events converters
39    */
40    List<LocalEventConverter> getLocalEventConverters();
41   
42    /**
43    * @return the remote to local events converters
44    */
45    List<RemoteEventConverter> getRemoteEventConverters();
46   
47    /**
48    * Convert a local event to a remote event.
49    *
50    * @param localEvent the local event
51    * @return the remote event, if null the event should not be sent to the network.
52    */
53    RemoteEventData createRemoteEventData(LocalEventData localEvent);
54   
55    /**
56    * Convert a remote event to a local event.
57    *
58    * @param remoteEvent the remote event
59    * @return the local event, if null the event should not send to {@link org.xwiki.observation.ObservationManager}.
60    */
61    LocalEventData createLocalEventData(RemoteEventData remoteEvent);
62    }