1 /*
2 * Copyright (c) 2002-2022, City of Paris
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * 1. Redistributions of source code must retain the above copyright notice
10 * and the following disclaimer.
11 *
12 * 2. Redistributions in binary form must reproduce the above copyright notice
13 * and the following disclaimer in the documentation and/or other materials
14 * provided with the distribution.
15 *
16 * 3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
17 * contributors may be used to endorse or promote products derived from
18 * this software without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
24 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 * POSSIBILITY OF SUCH DAMAGE.
31 *
32 * License 1.0
33 */
34 package fr.paris.lutece.portal.service.filter;
35
36 import java.util.HashMap;
37 import java.util.Map;
38
39 /**
40 * Filter Entry used to load filter from the plugin XML file
41 */
42 public class FilterEntry
43 {
44 public static final int ORDER_NOT_DEFINED = -1;
45 private String _strName;
46 private String _strFilterClass;
47 private String _strMapping;
48 private Map<String, String> _mapInitParameters = new HashMap<>( );
49 private int _nOrder = ORDER_NOT_DEFINED;
50
51 /**
52 * Returns the Name
53 *
54 * @return The Name
55 */
56 public String getName( )
57 {
58 return _strName;
59 }
60
61 /**
62 * Sets the Name
63 *
64 * @param strName
65 * The Name
66 */
67 public void setName( String strName )
68 {
69 _strName = strName;
70 }
71
72 /**
73 * Returns the filter
74 *
75 * @return The filter
76 */
77 public String getFilterClass( )
78 {
79 return _strFilterClass;
80 }
81
82 /**
83 * Sets the filter
84 *
85 * @param strFilterClass
86 * The filter
87 */
88 public void setFilterClass( String strFilterClass )
89 {
90 _strFilterClass = strFilterClass;
91 }
92
93 /**
94 * Returns the Mapping
95 *
96 * @return The Mapping
97 */
98 public String getMappingUrlPattern( )
99 {
100 return _strMapping;
101 }
102
103 /**
104 * Sets the Mapping
105 *
106 * @param strMapping
107 * The Mapping
108 */
109 public void setMappingUrlPattern( String strMapping )
110 {
111 _strMapping = strMapping;
112 }
113
114 /**
115 * Add an init parameter
116 *
117 * @param strName
118 * The parameter name
119 * @param strValue
120 * The parameter value
121 */
122 public void addParameter( String strName, String strValue )
123 {
124 _mapInitParameters.put( strName, strValue );
125 }
126
127 /**
128 * Returns init parameters
129 *
130 * @return Init parameters in a map object
131 */
132 public Map<String, String> getInitParameters( )
133 {
134 return _mapInitParameters;
135 }
136
137 /**
138 *
139 * Returns the order. {@link #getOrder()} == {@value #ORDER_NOT_DEFINED} means there is no priority set for the filter
140 *
141 * @return the order
142 */
143 public int getOrder( )
144 {
145 return _nOrder;
146 }
147
148 /**
149 * nOrder == == {@value #ORDER_NOT_DEFINED} means there is no priority set for the filter
150 *
151 * @param nOrder
152 * the order
153 */
154 public void setOrder( int nOrder )
155 {
156 _nOrder = nOrder;
157 }
158 }