org.opencms.mail.CmsVfsDataSource Maven / Gradle / Ivy

/*
 * This library is part of OpenCms -
 * the Open Source Content Management System
 *
 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * For further information about Alkacon Software, please see the
 * company website: http://www.alkacon.com
 *
 * For further information about OpenCms, please see the
 * project website: http://www.opencms.org
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

package org.opencms.mail;

import org.opencms.file.CmsFile;
import org.opencms.file.CmsObject;
import org.opencms.file.CmsResource;
import org.opencms.main.CmsException;
import org.opencms.main.OpenCms;

import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.InputStream;
import java.io.OutputStream;

import javax.activation.DataSource;

/**
 * DataSource wrapper for VFS resources, allows easy sending of VFS resources as email attachments.
 *
 * @since 6.2.0
 */
public class CmsVfsDataSource implements DataSource {

    /** The content type to use for the data source. */
    private String m_contentType;

    /** The file that accessed by this data source. */
    private CmsFile m_file;

    /**
     * Creates a new data source for the given VFS resource.

     *
     * @param cms the current users OpenCms context
     * @param resource the resource to use
     *
     * @throws CmsException in case of errors accessing the resource in the VFS
     */
    public CmsVfsDataSource(CmsObject cms, CmsResource resource)
    throws CmsException {

        m_file = cms.readFile(resource);
        // identify the mime-type for the data source
        m_contentType = OpenCms.getResourceManager().getMimeType(
            m_file.getName(),
            cms.getRequestContext().getEncoding());
    }

    /**
     * @see javax.activation.DataSource#getContentType()
     */
    public String getContentType() {

        return m_contentType;
    }

    /**
     * Returns an input stream baded on the file contents.

     *
     * @see javax.activation.DataSource#getInputStream()
     */
    public InputStream getInputStream() {

        return new ByteArrayInputStream(m_file.getContents());
    }

    /**
     * Returns the root path of the given resource.

     *
     * @see javax.activation.DataSource#getName()
     */
    public String getName() {

        return m_file.getRootPath();
    }

    /**
     * Don't use this method, VFS resources can't be written using this datasource class.

     *
     * This method will just return a new {@link ByteArrayOutputStream}.
     *
     * @see javax.activation.DataSource#getOutputStream()
     */
    public OutputStream getOutputStream() {

        // maybe throw an Exception here to avoid errors
        return new ByteArrayOutputStream();
    }
}