1 /*
2 * Copyright (c) 2002-2014, 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.myportal.service;
35
36 import java.util.List;
37
38 import fr.paris.lutece.plugins.myportal.business.icon.Icon;
39 import fr.paris.lutece.plugins.myportal.business.icon.IconHome;
40 import fr.paris.lutece.portal.service.image.ImageResource;
41 import fr.paris.lutece.portal.service.image.ImageResourceManager;
42 import fr.paris.lutece.portal.service.image.ImageResourceProvider;
43 import fr.paris.lutece.portal.service.plugin.Plugin;
44 import fr.paris.lutece.portal.service.plugin.PluginService;
45 import fr.paris.lutece.portal.web.constants.Parameters;
46 import fr.paris.lutece.util.url.UrlItem;
47
48 /**
49 * Service for Url entry types. Provide ImageResource managemenent
50 *
51 */
52 public class IconService implements ImageResourceProvider
53 {
54 private static IconServicel/service/IconService.html#IconService">IconService _singleton = new IconService( );
55 private static final String IMAGE_RESOURCE_TYPE_ID = "myportal_icon_img";
56
57 /**
58 * Creates a new instance of IconService
59 */
60 IconService( )
61 {
62 }
63
64 /**
65 * Initializes the service
66 */
67 public void register( )
68 {
69 ImageResourceManager.registerProvider( this );
70 }
71
72 /**
73 * Get the unique instance of the service
74 *
75 * @return The unique instance
76 */
77 public static IconService getInstance( )
78 {
79 return _singleton;
80 }
81
82 /**
83 * Return the Resource id
84 *
85 * @param nIdResource
86 * The resource identifier
87 * @return The Resource Image
88 */
89 public ImageResource getImageResource( int nIdResource )
90 {
91 Plugin plugin = PluginService.getPlugin( MyPortalPlugin.PLUGIN_NAME );
92 Icon icon = IconHome.findByPrimaryKey( nIdResource, plugin );
93
94 if ( icon != null )
95 {
96 ImageResource imageResource = new ImageResource( );
97 imageResource.setImage( icon.getValue( ) );
98 imageResource.setMimeType( icon.getMimeType( ) );
99
100 return imageResource;
101 }
102
103 return null;
104 }
105
106 /**
107 * Return the Resource Type id
108 *
109 * @return The Resource Type Id
110 */
111 public String getResourceTypeId( )
112 {
113 return IMAGE_RESOURCE_TYPE_ID;
114 }
115
116 /**
117 * Management of the image associated to the {@link EntryUrl}
118 *
119 * @param nEntryUrl
120 * The {@link EntryUrl} identifier
121 * @return The url of the resource
122 */
123 public static String getResourceImageEntryUrl( int nEntryUrl )
124 {
125 String strResourceType = IconService.getInstance( ).getResourceTypeId( );
126 UrlItem url = new UrlItem( Parameters.IMAGE_SERVLET );
127 url.addParameter( Parameters.RESOURCE_TYPE, strResourceType );
128 url.addParameter( Parameters.RESOURCE_ID, Integer.toString( nEntryUrl ) );
129
130 return url.getUrlWithEntity( );
131 }
132
133 /**
134 * @return the icon list to display in FO
135 *
136 */
137 public List<Icon> getIconFO( )
138 {
139
140 return IconHome.getListIconsFO( true );
141
142 }
143 }