View Javadoc
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.business.workgroup;
35  
36  import fr.paris.lutece.portal.service.util.AppLogService;
37  import fr.paris.lutece.portal.service.util.AppPropertiesService;
38  import fr.paris.lutece.util.url.UrlItem;
39  
40  import java.io.UnsupportedEncodingException;
41  
42  import java.net.URLEncoder;
43  
44  import javax.servlet.http.HttpServletRequest;
45  
46  /**
47   * This class describes a workgroup used by the administration
48   */
49  public class AdminWorkgroupFilter
50  {
51      // Constants
52      private static final String CONSTANT_EQUAL = "=";
53      private static final String CONSTANT_ESPERLUETTE = "&";
54  
55      // Parameters
56      private static final String PARAMETER_SEARCH_IS_SEARCH = "search_is_search";
57      private static final String PARAMETER_SEARCH_KEY = "search_key";
58      private static final String PARAMETER_SEARCH_DESCRIPTION = "search_description";
59  
60      // Properties
61      private static final String PROPERTY_ENCODING_URL = "lutece.encoding.url";
62      private String _strKey;
63      private String _strDescription;
64  
65      /**
66       * Constructor
67       */
68      public AdminWorkgroupFilter( )
69      {
70          // Ctor
71      }
72  
73      /**
74       * Initialize each component of the object
75       */
76      public void init( )
77      {
78          _strKey = "";
79          _strDescription = "";
80      }
81  
82      /**
83       * Gets the workgroup key
84       * 
85       * @return Returns the Key.
86       */
87      public String getKey( )
88      {
89          return _strKey;
90      }
91  
92      /**
93       * Sets the workgroup key
94       *
95       * @param strKey
96       *            The Key
97       */
98      public void setKey( String strKey )
99      {
100         _strKey = strKey;
101     }
102 
103     /**
104      * Returns the workgroup's description
105      * 
106      * @return Returns the Description.
107      */
108     public String getDescription( )
109     {
110         return _strDescription;
111     }
112 
113     /**
114      * Sets the workgroup's description
115      *
116      * @param strDescription
117      *            The workgroup's description
118      */
119     public void setDescription( String strDescription )
120     {
121         _strDescription = strDescription;
122     }
123 
124     /**
125      * Gets the workgroup key
126      *
127      * @return The workgroup key
128      */
129     public String getWorkgroup( )
130     {
131         return getKey( );
132     }
133 
134     /**
135      * Set the value of the AdminWorkgroupFilter
136      * 
137      * @param request
138      *            HttpServletRequest
139      * @return true if there is a search
140      */
141     public boolean setAdminWorkgroupFilter( HttpServletRequest request )
142     {
143         boolean bIsSearch = false;
144         String strIsSearch = request.getParameter( PARAMETER_SEARCH_IS_SEARCH );
145 
146         if ( strIsSearch != null )
147         {
148             bIsSearch = true;
149             _strKey = request.getParameter( PARAMETER_SEARCH_KEY );
150             _strDescription = request.getParameter( PARAMETER_SEARCH_DESCRIPTION );
151         }
152         else
153         {
154             init( );
155         }
156 
157         return bIsSearch;
158     }
159 
160     /**
161      * Build url attributes
162      * 
163      * @param url
164      *            The url item
165      */
166     public void setUrlAttributes( UrlItem url )
167     {
168         url.addParameter( PARAMETER_SEARCH_IS_SEARCH, Boolean.TRUE.toString( ) );
169 
170         try
171         {
172             url.addParameter( PARAMETER_SEARCH_KEY, URLEncoder.encode( _strKey, AppPropertiesService.getProperty( PROPERTY_ENCODING_URL ) ) );
173             url.addParameter( PARAMETER_SEARCH_DESCRIPTION, URLEncoder.encode( _strDescription, AppPropertiesService.getProperty( PROPERTY_ENCODING_URL ) ) );
174         }
175         catch( UnsupportedEncodingException e )
176         {
177             AppLogService.error( e.getMessage( ), e );
178         }
179     }
180 
181     /**
182      * Build url attributes
183      * 
184      * @return the url attributes
185      */
186     public String getUrlAttributes( )
187     {
188         StringBuilder sbUrlAttributes = new StringBuilder( );
189         sbUrlAttributes.append( PARAMETER_SEARCH_IS_SEARCH + CONSTANT_EQUAL + Boolean.TRUE );
190 
191         try
192         {
193             sbUrlAttributes.append( CONSTANT_ESPERLUETTE + PARAMETER_SEARCH_KEY + CONSTANT_EQUAL
194                     + URLEncoder.encode( _strKey, AppPropertiesService.getProperty( PROPERTY_ENCODING_URL ) ) );
195             sbUrlAttributes.append( CONSTANT_ESPERLUETTE + PARAMETER_SEARCH_DESCRIPTION + CONSTANT_EQUAL
196                     + URLEncoder.encode( _strDescription, AppPropertiesService.getProperty( PROPERTY_ENCODING_URL ) ) );
197         }
198         catch( UnsupportedEncodingException e )
199         {
200             AppLogService.error( e.getMessage( ), e );
201         }
202 
203         return sbUrlAttributes.toString( );
204     }
205 }