Package org.opencms.mail

Class CmsVfsDataSource

java.lang.Object

org.opencms.mail.CmsVfsDataSource

All Implemented Interfaces:

DataSource

public class CmsVfsDataSource
extends Object
implements DataSource

DataSource wrapper for VFS resources, allows easy sending of VFS resources as email attachments.

Since:

6.2.0

Constructor Summary

Constructors

Constructor	Description
CmsVfsDataSource(CmsObject cms, CmsResource resource)	Creates a new data source for the given VFS resource.

Method Summary

Modifier and Type	Method	Description
String	getContentType()
InputStream	getInputStream()	Returns an input stream baded on the file contents.
String	getName()	Returns the root path of the given resource.
OutputStream	getOutputStream()	Don't use this method, VFS resources can't be written using this datasource class.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

CmsVfsDataSource

public CmsVfsDataSource(CmsObject cms,
 CmsResource resource)
                 throws CmsException

Creates a new data source for the given VFS resource.

Parameters:

cms - the current users OpenCms context

resource - the resource to use

Throws:

CmsException - in case of errors accessing the resource in the VFS

Method Details

getContentType

public String getContentType()

Specified by:

getContentType in interface DataSource

See Also:

• DataSource.getContentType()

getInputStream

public InputStream getInputStream()

Returns an input stream baded on the file contents.

Specified by:

getInputStream in interface DataSource

See Also:

• DataSource.getInputStream()

getName

public String getName()

Returns the root path of the given resource.

Specified by:

getName in interface DataSource

See Also:

• DataSource.getName()

getOutputStream

public OutputStream getOutputStream()

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

This method will just return a new ByteArrayOutputStream.

Specified by:

getOutputStream in interface DataSource

See Also:

• DataSource.getOutputStream()