View Javadoc
1   /*
2    * Copyright (c) 2002-2020, 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.plugins.directories.web;
35  
36  import fr.paris.lutece.plugins.directories.util.DirectoriesConstants;
37  import fr.paris.lutece.portal.service.util.AppPathService;
38  import fr.paris.lutece.portal.service.util.AppPropertiesService;
39  import fr.paris.lutece.portal.util.mvc.admin.MVCAdminJspBean;
40  import fr.paris.lutece.portal.web.util.LocalizedPaginator;
41  import fr.paris.lutece.util.html.Paginator;
42  import fr.paris.lutece.util.url.UrlItem;
43  
44  import java.util.List;
45  import java.util.Map;
46  import javax.servlet.http.HttpServletRequest;
47  
48  /**
49   * DirectoriesManager JSP Bean abstract class for JSP Bean
50   */
51  public abstract class AbstractDirectoriesManagerJspBean extends MVCAdminJspBean
52  {
53      private static final long serialVersionUID = 1609588697176220802L;
54      // Rights
55      public static final String RIGHT_DIRECTORIESMANAGER = "DIRECTORIES_MANAGEMENT";
56  
57      // Properties
58      private static final String PROPERTY_DEFAULT_LIST_ITEM_PER_PAGE = "directories.listItems.itemsPerPage";
59  
60      // Parameters
61      private static final String PARAMETER_PAGE_INDEX = "page_index";
62  
63      // Markers
64      private static final String MARK_PAGINATOR = "paginator";
65      private static final String MARK_NB_ITEMS_PER_PAGE = "nb_items_per_page";
66  
67      // Variables
68      private int _nDefaultItemsPerPage;
69      private String _strCurrentPageIndex;
70      private int _nItemsPerPage;
71  
72      /**
73       * Return a model that contains the list and paginator infos
74       * 
75       * @param request
76       *            The HTTP request
77       * @param strBookmark
78       *            The bookmark
79       * @param list
80       *            The list of item
81       * @param strManageJsp
82       *            The JSP
83       * @return The model
84       */
85      protected <T> Map<String, Object> getPaginatedListModel( HttpServletRequest request, String strBookmark, List<T> list, String strManageJsp )
86      {
87          _strCurrentPageIndex = Paginator.getPageIndex( request, Paginator.PARAMETER_PAGE_INDEX, _strCurrentPageIndex );
88          _nDefaultItemsPerPage = AppPropertiesService.getPropertyInt( PROPERTY_DEFAULT_LIST_ITEM_PER_PAGE, 50 );
89          _nItemsPerPage = Paginator.getItemsPerPage( request, Paginator.PARAMETER_ITEMS_PER_PAGE, _nItemsPerPage, _nDefaultItemsPerPage );
90  
91          UrlItem url = new UrlItem( strManageJsp );
92          String strUrl = url.getUrl( );
93  
94          // PAGINATOR
95          LocalizedPaginator<T> paginator = new LocalizedPaginator<>( list, _nItemsPerPage, strUrl, PARAMETER_PAGE_INDEX, _strCurrentPageIndex, getLocale( ) );
96  
97          Map<String, Object> model = getModel( );
98  
99          model.put( MARK_NB_ITEMS_PER_PAGE, String.valueOf( _nItemsPerPage ) );
100         model.put( MARK_PAGINATOR, paginator );
101         model.put( strBookmark, paginator.getPageItems( ) );
102 
103         return model;
104     }
105 
106     /**
107      * Return the URL of the JSP manage Directory Entries
108      * 
109      * @param request
110      *            The HTTP request
111      * @return The URL of the JSP manage Directory Entries
112      */
113     protected String getJspManageDirectoryEntries( HttpServletRequest request )
114     {
115         return AppPathService.getBaseUrl( request ) + DirectoriesConstants.JSP_MANAGE_DIRECTORY_ENTRIES;
116     }
117 
118     /**
119      * Redirect to the URL of view manage Directory Entries
120      * 
121      * @param request
122      *            The HTTP request
123      * @return The URL of the JSP manage Directory Entries
124      */
125     protected String redirectToViewManageDirectoryEntries( HttpServletRequest request )
126     {
127         return redirect( request, getJspManageDirectoryEntries( request ) );
128     }
129 
130 }