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.plugins.workflow.service.taskinfo;
35  
36  import fr.paris.lutece.plugins.workflowcore.service.task.ITask;
37  import fr.paris.lutece.plugins.workflowcore.service.task.ITaskService;
38  import fr.paris.lutece.plugins.workflowcore.service.task.TaskService;
39  import fr.paris.lutece.portal.service.i18n.I18nService;
40  import fr.paris.lutece.portal.service.spring.SpringContextService;
41  
42  import org.apache.commons.lang3.StringUtils;
43  
44  import java.util.List;
45  import java.util.Locale;
46  
47  import javax.servlet.http.HttpServletRequest;
48  
49  /**
50   *
51   * TaskInfoManager
52   *
53   */
54  public final class TaskInfoManager
55  {
56      /**
57       * Private constructor
58       */
59      private TaskInfoManager( )
60      {
61      }
62  
63      /**
64       * Get the list of provider
65       * 
66       * @return the list of providers
67       */
68      public static List<ITaskInfoProvider> getProvidersList( )
69      {
70          return SpringContextService.getBeansOfType( ITaskInfoProvider.class );
71      }
72  
73      /**
74       * Get the provider from a given provider key
75       * 
76       * @param strProviderKey
77       *            the provider key
78       * @return the provider
79       */
80      public static ITaskInfoProvider getProvider( String strProviderKey )
81      {
82          if ( StringUtils.isNotBlank( strProviderKey ) )
83          {
84              for ( ITaskInfoProvider provider : getProvidersList( ) )
85              {
86                  if ( ( provider != null ) && ( provider.getTaskType( ) != null ) && strProviderKey.equals( provider.getTaskType( ).getKey( ) ) )
87                  {
88                      return provider;
89                  }
90              }
91          }
92  
93          return null;
94      }
95  
96      /**
97       * Get the task resource info. This method will first get the appropriate provider from the given id task.
98       * 
99       * @param nIdHistory
100      *            the id history
101      * @param nIdTask
102      *            the id task
103      * @param request
104      *            the HTTP request
105      * @return the task resource info
106      */
107     public static String getTaskResourceInfo( int nIdHistory, int nIdTask, HttpServletRequest request )
108     {
109         String strInfo = StringUtils.EMPTY;
110         Locale locale = getLocale( request );
111         ITaskService taskService = SpringContextService.getBean( TaskService.BEAN_SERVICE );
112         ITask task = taskService.findByPrimaryKey( nIdTask, locale );
113 
114         if ( task != null )
115         {
116             ITaskInfoProvider provider = getProvider( task.getTaskType( ).getKey( ) );
117 
118             if ( provider != null )
119             {
120                 strInfo = provider.getTaskResourceInfo( nIdHistory, nIdTask, request );
121             }
122         }
123 
124         return strInfo;
125     }
126 
127     /**
128      * Get the locale
129      * 
130      * @param request
131      *            the HTTP request
132      * @return the locale
133      */
134     private static Locale getLocale( HttpServletRequest request )
135     {
136         Locale locale = null;
137 
138         if ( request != null )
139         {
140             locale = request.getLocale( );
141         }
142         else
143         {
144             locale = I18nService.getDefaultLocale( );
145         }
146 
147         return locale;
148     }
149 }