View Javadoc
1   /*
2    * Copyright (c) 2002-2017, Mairie de 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.announce.modules.mydashboard.service;
35  
36  import fr.paris.lutece.plugins.announce.web.AnnounceApp;
37  import fr.paris.lutece.plugins.mydashboard.service.MyDashboardComponent;
38  import fr.paris.lutece.portal.service.i18n.I18nService;
39  import fr.paris.lutece.portal.service.message.SiteMessageException;
40  import fr.paris.lutece.portal.service.util.AppLogService;
41  
42  import org.apache.commons.lang.StringUtils;
43  
44  import java.util.Locale;
45  
46  import javax.servlet.http.HttpServletRequest;
47  
48  
49  /**
50   * MyDashboard component to display the list of announces of a user
51   */
52  public class MyAnnoucesMyDashboardComponent extends MyDashboardComponent
53  {
54      private static final String MYDASHBOARD_COMPONENT_ID = "announce-mydashboard.myAnnouncesDashboardComponent";
55  
56      private static final String MESSAGE_MY_ANNOUNCES_MYDASHBOARD_COMPONENT_DESCRIPTION = "module.announce.mydashboard.myAnnouncesDashboardComponent.description";
57  
58      /**
59       * {@inheritDoc}
60       */
61      @Override
62      public String getDashboardData( HttpServletRequest request )
63      {
64          try
65          {
66              return AnnounceApp.getManageUserAnnounces( request );
67          }
68          catch ( SiteMessageException e )
69          {
70              // We catch site messages since they tell the user to log in if he has not logged in
71              AppLogService.error( e.getMessage( ), e );
72          }
73          return StringUtils.EMPTY;
74      }
75  
76      /**
77       * {@inheritDoc}
78       */
79      @Override
80      public String getComponentId( )
81      {
82          return MYDASHBOARD_COMPONENT_ID;
83      }
84  
85      /**
86       * {@inheritDoc}
87       */
88      @Override
89      public String getComponentDescription( Locale locale )
90      {
91          return I18nService.getLocalizedString( MESSAGE_MY_ANNOUNCES_MYDASHBOARD_COMPONENT_DESCRIPTION, locale );
92      }
93  
94  }