com.openexchange.mail.conversion

Class InlineImageDataSource

java.lang.Object

com.openexchange.mail.conversion.InlineImageDataSource

All Implemented Interfaces:

com.openexchange.conversion.DataSource, com.openexchange.image.ImageDataSource

public final class InlineImageDataSource
extends java.lang.Object
implements com.openexchange.image.ImageDataSource

InlineImageDataSource - A DataSource for image parts inside a mail.

Author:

Thorben Betten

Field Summary

Fields inherited from interface com.openexchange.image.ImageDataSource

ALIAS_APPENDIX, DAY_IN_MILLIS, HOUR_IN_MILLIS, MINUTE_IN_MILLIS, SECOND_IN_MILLIS, WEEK_IN_MILLIS, YEAR_IN_MILLIS

Method Summary

Methods

Modifier and Type	Method and Description
com.openexchange.conversion.DataArguments	generateDataArgumentsFrom(com.openexchange.image.ImageLocation imageLocation) Generates appropriate data arguments for specified image location.
java.lang.String	generateUrl(com.openexchange.image.ImageLocation imageLocation, com.openexchange.session.Session session) Generates the URL linking to image data
java.lang.String	getAlias() Gets the alias (starting with '/' character).
<D> com.openexchange.conversion.Data<D>	getData(java.lang.Class<? extends D> type, com.openexchange.conversion.DataArguments dataArguments, com.openexchange.session.Session session)
java.lang.String	getETag(com.openexchange.image.ImageLocation imageLocation, com.openexchange.session.Session session) Gets the ETag for this image data source.
long	getExpires() Gets the expires (time-to-live)
static InlineImageDataSource	getInstance() Gets the instance
java.lang.String	getRegistrationName() Gets this data source's registration name.
java.lang.String[]	getRequiredArguments() Common required arguments for uniquely determining a mail part: com.openexchange.mail.conversion.fullname com.openexchange.mail.conversion.mailid com.openexchange.mail.conversion.cid
java.lang.Class<?>[]	getTypes()
com.openexchange.image.ImageLocation	parseRequest(com.openexchange.ajax.requesthandler.AJAXRequestData requestData) Parses specified AJAXRequestData to its image location.
com.openexchange.image.ImageLocation	parseUrl(java.lang.String url) Parses specified URL to its image location.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static InlineImageDataSource getInstance()

Gets the instance

Returns:

The instance

generateUrl

public java.lang.String generateUrl(com.openexchange.image.ImageLocation imageLocation,
                           com.openexchange.session.Session session)

Description copied from interface: com.openexchange.image.ImageDataSource

Generates the URL linking to image data

Specified by:

generateUrl in interface com.openexchange.image.ImageDataSource

Returns:

The image URL

generateDataArgumentsFrom

public com.openexchange.conversion.DataArguments generateDataArgumentsFrom(com.openexchange.image.ImageLocation imageLocation)

Description copied from interface: com.openexchange.image.ImageDataSource

Generates appropriate data arguments for specified image location.

Specified by:

generateDataArgumentsFrom in interface com.openexchange.image.ImageDataSource

Parameters:

imageLocation - The image location

Returns:

The appropriate data arguments

parseUrl

public com.openexchange.image.ImageLocation parseUrl(java.lang.String url)

Description copied from interface: com.openexchange.image.ImageDataSource

Parses specified URL to its image location.

Specified by:

parseUrl in interface com.openexchange.image.ImageDataSource

Parameters:

url - The URL to parse

Returns:

The resulting image location

parseRequest

public com.openexchange.image.ImageLocation parseRequest(com.openexchange.ajax.requesthandler.AJAXRequestData requestData)

Description copied from interface: com.openexchange.image.ImageDataSource

Parses specified AJAXRequestData to its image location.

Specified by:

parseRequest in interface com.openexchange.image.ImageDataSource

Parameters:

requestData - The AJAXRequestData to parse

Returns:

The resulting image location

getExpires

public long getExpires()

Description copied from interface: com.openexchange.image.ImageDataSource

Gets the expires (time-to-live)

Specified by:

getExpires in interface com.openexchange.image.ImageDataSource

Returns:

The expires or -1 for no expiry

getETag

public java.lang.String getETag(com.openexchange.image.ImageLocation imageLocation,
                       com.openexchange.session.Session session)

Description copied from interface: com.openexchange.image.ImageDataSource

Gets the ETag for this image data source.

Specified by:

getETag in interface com.openexchange.image.ImageDataSource

Parameters:

imageLocation - The image location

session - The session

Returns:

The ETag

getRequiredArguments

public java.lang.String[] getRequiredArguments()

Common required arguments for uniquely determining a mail part:

• com.openexchange.mail.conversion.fullname
• com.openexchange.mail.conversion.mailid
• com.openexchange.mail.conversion.cid

Specified by:

getRequiredArguments in interface com.openexchange.conversion.DataSource

getTypes

public java.lang.Class<?>[] getTypes()

Specified by:

getTypes in interface com.openexchange.conversion.DataSource

getData

public <D> com.openexchange.conversion.Data<D> getData(java.lang.Class<? extends D> type,
                                              com.openexchange.conversion.DataArguments dataArguments,
                                              com.openexchange.session.Session session)
                                            throws com.openexchange.exception.OXException

Specified by:

getData in interface com.openexchange.conversion.DataSource

Throws:

com.openexchange.exception.OXException

getRegistrationName

public java.lang.String getRegistrationName()

Description copied from interface: com.openexchange.image.ImageDataSource

Gets this data source's registration name.

Specified by:

getRegistrationName in interface com.openexchange.image.ImageDataSource

Returns:

The registration name

getAlias

public java.lang.String getAlias()

Description copied from interface: com.openexchange.image.ImageDataSource

Gets the alias (starting with '/' character).

Specified by:

getAlias in interface com.openexchange.image.ImageDataSource

Returns:

The alias