ImageResourceManager.java

/*
 * Copyright (c) 2002-2022, City of Paris
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *  1. Redistributions of source code must retain the above copyright notice
 *     and the following disclaimer.
 *
 *  2. Redistributions in binary form must reproduce the above copyright notice
 *     and the following disclaimer in the documentation and/or other materials
 *     provided with the distribution.
 *
 *  3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
 *     contributors may be used to endorse or promote products derived from
 *     this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 * License 1.0
 */
package fr.paris.lutece.portal.service.image;

import fr.paris.lutece.portal.service.util.AppLogService;
import fr.paris.lutece.util.url.UrlItem;

import java.util.HashMap;
import java.util.Map;

import org.apache.commons.fileupload.FileItem;

/**
 * ImageResourceManager
 */
public final class ImageResourceManager
{
    /** resource type registry */
    private static Map<String, ImageResourceProvider> _mapResourceTypes = new HashMap<>( );
    public static final String IMAGE_SERVLET_BASE_URL = "image";

    /** Private constructor */
    private ImageResourceManager( )
    {
    }

    /**
     * Registers a new resource type
     *
     * @param resourceProvider
     *            the resource type to register
     */
    public static void registerProvider( ImageResourceProvider resourceProvider )
    {
        _mapResourceTypes.put( resourceProvider.getResourceTypeId( ), resourceProvider );
        AppLogService.info( "New ImageResourceType registered : {}", resourceProvider.getClass( ).getName( ) );
    }

    /**
     * Gets an image resource
     * 
     * @param strResourceTypeId
     *            The resource's type ID
     * @param nResourceId
     *            The resource ID
     * @return ImageResource
     */
    public static ImageResource getImageResource( String strResourceTypeId, int nResourceId )
    {
        ImageResourceProvider resourceProvider = _mapResourceTypes.get( strResourceTypeId );

        if ( resourceProvider != null )
        {
            return resourceProvider.getImageResource( nResourceId );
        }

        return null;
    }
    
    /**
     * Add Image Resource
     * @param strResourceTypeId
     * @param fileItem
     * @return Image Resource Key
     */
    public static String addImageResource( String strResourceTypeId, FileItem fileItem )
    {
        ImageResourceProvider resourceProvider = _mapResourceTypes.get( strResourceTypeId );

        if ( resourceProvider != null )
        {
            return resourceProvider.addImageResource( fileItem);
        }

        return null;
    }
    
    /**
     * Get Image URL
     * @param strResourceTypeId
     * @param nResourceId
     * @return the URL
     */
    public static String getImageUrl( String strResourceTypeId, int nResourceId )
    {
        UrlItem item = new UrlItem( IMAGE_SERVLET_BASE_URL );
        item.addParameter( ImageServlet.PARAMETER_ID, nResourceId );
        item.addParameter( ImageServlet.PARAMETER_RESOURCE_TYPE, strResourceTypeId );
        return item.getUrl( );
        
    }
}