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.service.image;
35  
36  import fr.paris.lutece.portal.service.util.AppLogService;
37  import fr.paris.lutece.util.url.UrlItem;
38  
39  import java.util.HashMap;
40  import java.util.Map;
41  
42  import org.apache.commons.fileupload.FileItem;
43  
44  /**
45   * ImageResourceManager
46   */
47  public final class ImageResourceManager
48  {
49      /** resource type registry */
50      private static Map<String, ImageResourceProvider> _mapResourceTypes = new HashMap<>( );
51      public static final String IMAGE_SERVLET_BASE_URL = "image";
52  
53      /** Private constructor */
54      private ImageResourceManager( )
55      {
56      }
57  
58      /**
59       * Registers a new resource type
60       *
61       * @param resourceProvider
62       *            the resource type to register
63       */
64      public static void registerProvider( ImageResourceProvider resourceProvider )
65      {
66          _mapResourceTypes.put( resourceProvider.getResourceTypeId( ), resourceProvider );
67          AppLogService.info( "New ImageResourceType registered : {}", resourceProvider.getClass( ).getName( ) );
68      }
69  
70      /**
71       * Gets an image resource
72       * 
73       * @param strResourceTypeId
74       *            The resource's type ID
75       * @param nResourceId
76       *            The resource ID
77       * @return ImageResource
78       */
79      public static ImageResource getImageResource( String strResourceTypeId, int nResourceId )
80      {
81          ImageResourceProvider resourceProvider = _mapResourceTypes.get( strResourceTypeId );
82  
83          if ( resourceProvider != null )
84          {
85              return resourceProvider.getImageResource( nResourceId );
86          }
87  
88          return null;
89      }
90      
91      /**
92       * Add Image Resource
93       * @param strResourceTypeId
94       * @param fileItem
95       * @return Image Resource Key
96       */
97      public static String addImageResource( String strResourceTypeId, FileItem fileItem )
98      {
99      	ImageResourceProvider resourceProvider = _mapResourceTypes.get( strResourceTypeId );
100 
101         if ( resourceProvider != null )
102         {
103             return resourceProvider.addImageResource( fileItem);
104         }
105 
106         return null;
107     }
108     
109     /**
110      * Get Image URL
111      * @param strResourceTypeId
112      * @param nResourceId
113      * @return the URL
114      */
115     public static String getImageUrl( String strResourceTypeId, int nResourceId )
116     {
117     	UrlItem item = new UrlItem( IMAGE_SERVLET_BASE_URL );
118     	item.addParameter( ImageServlet.PARAMETER_ID, nResourceId );
119     	item.addParameter( ImageServlet.PARAMETER_RESOURCE_TYPE, strResourceTypeId );
120     	return item.getUrl( );
121     	
122     }
123 }