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