AutoIncludeAdminDashboardComponent.java

  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.web.template;

  35. import fr.paris.lutece.portal.business.template.AutoInclude;
  36. import fr.paris.lutece.portal.business.user.AdminUser;
  37. import fr.paris.lutece.portal.service.dashboard.admin.AdminDashboardComponent;
  38. import fr.paris.lutece.portal.service.template.AppTemplateService;
  39. import fr.paris.lutece.portal.service.template.CommonsService;
  40. import fr.paris.lutece.portal.service.template.FreeMarkerTemplateService;
  41. import fr.paris.lutece.util.html.HtmlTemplate;
  42. import java.util.HashMap;
  43. import java.util.List;
  44. import java.util.Map;
  45. import javax.servlet.http.HttpServletRequest;

  46. /**
  47.  * AutoIncludeAdminDashboardComponent
  48.  */
  49. public class AutoIncludeAdminDashboardComponent extends AdminDashboardComponent
  50. {
  51.     // Templates
  52.     private static final String TEMPLATE_MANAGE_AUTOINCLUDES = "/admin/dashboard/admin/autoincludes_dashboard.html";
  53.     // Markers
  54.     private static final String MARK_AUTOINCLUDE_LIST = "autoinclude_list";
  55.     private static final String MARK_COMMONS_LIST = "commons_list";
  56.     private static final String MARK_CURRENT_COMMONS = "current_commons";

  57.     /**
  58.      * {@inheritDoc}
  59.      */
  60.     @Override
  61.     public String getDashboardData( AdminUser user, HttpServletRequest request )
  62.     {
  63.         Map<String, Object> model = new HashMap<>( );
  64.         List<AutoInclude> listAutoIncludes = FreeMarkerTemplateService.getInstance( ).getAutoIncludesList( );
  65.         model.put( MARK_AUTOINCLUDE_LIST, listAutoIncludes );
  66.         model.put( MARK_COMMONS_LIST, CommonsService.getCommonsIncludeList( ) );
  67.         model.put( MARK_CURRENT_COMMONS, CommonsService.getCurrentCommonsKey( ) );

  68.         HtmlTemplate template = AppTemplateService.getTemplate( TEMPLATE_MANAGE_AUTOINCLUDES, user.getLocale( ), model );
  69.         return template.getHtml( );
  70.     }

  71. }