GenAttFileItem.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.plugins.genericattributes.business;

import fr.paris.lutece.util.filesystem.FileSystemUtil;

import org.apache.commons.fileupload.FileItem;
import org.apache.commons.fileupload.FileItemHeaders;

import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.io.UnsupportedEncodingException;

/**
 * GenAttFileItem : builds a new fileItem
 */
public class GenAttFileItem implements FileItem
{
    private static final long serialVersionUID = -8540841906551362771L;
    private byte [ ] _bValue;
    private String _strFileName;
    private String _strFieldName;
    private String _strOrigin;
    private int _nIdResponse;
    private FileItemHeaders _fileItemHeaders;

    /**
     * Creates a new file item
     * 
     * @param bValue
     *            the byte value
     * @param strFileName
     *            the file name
     */
    public GenAttFileItem( byte [ ] bValue, String strFileName )
    {
        _bValue = bValue;
        _strFileName = strFileName;
    }

    /**
     * Creates a new file item
     * 
     * @param bValue
     *            the byte value
     * @param strFileName
     *            the file name
     * @param nIdResponse
     *            The id of the response associated with this file item if any
     */
    public GenAttFileItem( byte [ ] bValue, String strFileName, int nIdResponse, String strOrigin )
    {
        _bValue = bValue;
        _strFileName = strFileName;
        _nIdResponse = nIdResponse;
        _strOrigin = strOrigin;
    }

    /**
     * Creates a new file item
     * 
     * @param bValue
     *            the byte value
     * @param strFileName
     *            the file name
     * @param strFieldName
     *            The name of the HTML field associated with this file, if any
     * @param nIdResponse
     *            The id of the response associated with this file item if any
     */
    public GenAttFileItem( byte [ ] bValue, String strFileName, String strFieldName, int nIdResponse, String strOrigin )
    {
        _bValue = bValue;
        _strFileName = strFileName;
        _strFieldName = strFieldName;
        _nIdResponse = nIdResponse;
        _strOrigin = strOrigin;

    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void delete( )
    {
        _bValue = null;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public byte [ ] get( )
    {
        return _bValue;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public String getContentType( )
    {
        return FileSystemUtil.getMIMEType( _strFileName );
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public String getFieldName( )
    {
        return _strFieldName;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public InputStream getInputStream( ) throws IOException
    {
        return new ByteArrayInputStream( _bValue );
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public String getName( )
    {
        return _strFileName;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public OutputStream getOutputStream( ) throws IOException
    {
        return null;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public long getSize( )
    {
        return _bValue.length;
    }

    /**
     * {@inheritDoc}
     */
    public String getOrigin( )
    {
        return _strOrigin;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public String getString( )
    {
        return new String( _bValue );
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public String getString( String encoding ) throws UnsupportedEncodingException
    {
        return new String( _bValue, encoding );
    }

    /**
     * Get the id of the associated response, if any
     * 
     * @return The id of the associated response, if any
     */
    public int getIdResponse( )
    {
        return _nIdResponse;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public boolean isFormField( )
    {
        return false;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public boolean isInMemory( )
    {
        return true;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void setFieldName( String strName )
    {
        _strFieldName = strName;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void setFormField( boolean bState )
    {
        // nothing
    }

    /**
     * Set the id of the associated response, if any
     * 
     * @param nIdResponse
     *            The id of the associated response, if any
     */
    public void setIdResponse( int nIdResponse )
    {
        _nIdResponse = nIdResponse;
    }

    public void setOrigin( String strOrigin )
    {
        _strOrigin = strOrigin;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void write( java.io.File file ) throws Exception
    {
        // nothing
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public FileItemHeaders getHeaders( )
    {
        return _fileItemHeaders;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void setHeaders( FileItemHeaders headers )
    {
        _fileItemHeaders = headers;
    }
}