Class | Line # | Actions | |||||
---|---|---|---|---|---|---|---|
InstanceInputEventGenerator | 36 | 0 | - | 0 | 0 |
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.filter.instance.input; | |
21 | ||
22 | import java.util.Collection; | |
23 | import java.util.Map; | |
24 | ||
25 | import org.xwiki.component.annotation.Role; | |
26 | import org.xwiki.filter.FilterEventParameters; | |
27 | import org.xwiki.filter.FilterException; | |
28 | import org.xwiki.filter.descriptor.FilterStreamDescriptor; | |
29 | import org.xwiki.filter.instance.internal.InstanceFilter; | |
30 | ||
31 | /** | |
32 | * @version $Id: 641893bbc1e6fc50f8ade76069da35d0cde51506 $ | |
33 | * @since 6.2M1 | |
34 | */ | |
35 | @Role | |
36 | public interface InstanceInputEventGenerator extends InstanceFilter | |
37 | { | |
38 | /** | |
39 | * Set custom parameter related to the farm. | |
40 | * | |
41 | * @param parameters the parameters to set | |
42 | * @throws FilterException when failing to set parameters | |
43 | * @since 6.2M1 | |
44 | */ | |
45 | void setWikiFarmParameters(FilterEventParameters parameters) throws FilterException; | |
46 | ||
47 | /** | |
48 | * Set custom parameter related to the wiki. | |
49 | * | |
50 | * @param name the name of wiki | |
51 | * @param parameters the parameters to set | |
52 | * @throws FilterException when failing to set parameters | |
53 | * @since 6.2M1 | |
54 | */ | |
55 | void setWikiParameters(String name, FilterEventParameters parameters) throws FilterException; | |
56 | ||
57 | /** | |
58 | * Set custom parameter related to the space. | |
59 | * | |
60 | * @param name the name of space | |
61 | * @param parameters the parameters to set | |
62 | * @throws FilterException when failing to set parameters | |
63 | * @since 6.2M1 | |
64 | */ | |
65 | void setWikiSpaceParameters(String name, FilterEventParameters parameters) throws FilterException; | |
66 | ||
67 | /** | |
68 | * Set custom parameter related to the document. | |
69 | * | |
70 | * @param name the name of document | |
71 | * @param parameters the parameters to set | |
72 | * @throws FilterException when failing to set parameters | |
73 | * @since 6.2M1 | |
74 | */ | |
75 | void setWikiDocumentParameters(String name, FilterEventParameters parameters) throws FilterException; | |
76 | ||
77 | /** | |
78 | * @param filter the filter to send events to | |
79 | */ | |
80 | void setFilter(Object filter); | |
81 | ||
82 | /** | |
83 | * @param properties the event generator properties | |
84 | */ | |
85 | void setProperties(Map<String, Object> properties); | |
86 | ||
87 | /** | |
88 | * @return The FilterStreamDescriptor describes a FilterStream and has the list of bean class parameters or | |
89 | * properties. | |
90 | */ | |
91 | FilterStreamDescriptor getDescriptor(); | |
92 | ||
93 | /** | |
94 | * @return the filters supported by this stream factory | |
95 | * @throws FilterException when failing to get filters interfaces | |
96 | */ | |
97 | Collection<Class< ? >> getFilterInterfaces() throws FilterException; | |
98 | } |