com.openexchange.mail.json.actions

Class GetAttachmentAction

java.lang.Object

com.openexchange.mail.json.actions.AbstractMailAction

com.openexchange.mail.json.actions.GetAttachmentAction

All Implemented Interfaces:

com.openexchange.ajax.requesthandler.AJAXActionService, com.openexchange.ajax.requesthandler.ETagAwareAJAXActionService, MailActionConstants

public final class GetAttachmentAction
extends AbstractMailAction
implements com.openexchange.ajax.requesthandler.ETagAwareAJAXActionService

GetAttachmentAction

Author:

Thorben Betten

Field Summary

Fields inherited from class com.openexchange.mail.json.actions.AbstractMailAction

COLUMNS_ALL_ALIAS, COLUMNS_LIST_ALIAS

Fields inherited from interface com.openexchange.mail.json.MailActionConstants

ALL_LOG_PROPERTIES, PROPERTY_CLOSEABLES, PROPERTY_MAIL_IFACE

Constructor Summary

Constructors

Constructor and Description
GetAttachmentAction(com.openexchange.server.ServiceLookup services) Initializes a new GetAttachmentAction.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	checkETag(java.lang.String clientETag, com.openexchange.ajax.requesthandler.AJAXRequestData request, com.openexchange.tools.session.ServerSession session) Checks for equality of passed client ETag compared to currently valid ETag for requested resource.
void	setETag(java.lang.String eTag, long expires, com.openexchange.ajax.requesthandler.AJAXRequestResult result) Sets specified ETag header with given optional expires value to specified request result.

Methods inherited from class com.openexchange.mail.json.actions.AbstractMailAction

detectDisplayMode, perform, triggerContactCollector

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.openexchange.ajax.requesthandler.AJAXActionService

perform

Constructor Detail

GetAttachmentAction

public GetAttachmentAction(com.openexchange.server.ServiceLookup services)

Initializes a new GetAttachmentAction.

Parameters:

services -

Method Detail

checkETag

public boolean checkETag(java.lang.String clientETag,
                com.openexchange.ajax.requesthandler.AJAXRequestData request,
                com.openexchange.tools.session.ServerSession session)
                  throws com.openexchange.exception.OXException

Description copied from interface: com.openexchange.ajax.requesthandler.ETagAwareAJAXActionService

Checks for equality of passed client ETag compared to currently valid ETag for requested resource.

A new expiry may be specified by setting "X-ETag-Expiry" header in passed AJAXRequestData instance.

Specified by:

checkETag in interface com.openexchange.ajax.requesthandler.ETagAwareAJAXActionService

Parameters:

clientETag - The client's ETag

request - The request data

session - The session

Returns:

true if ETags are equal; otherwise false

Throws:

com.openexchange.exception.OXException - If checking ETag fails

setETag

public void setETag(java.lang.String eTag,
           long expires,
           com.openexchange.ajax.requesthandler.AJAXRequestResult result)
             throws com.openexchange.exception.OXException

Description copied from interface: com.openexchange.ajax.requesthandler.ETagAwareAJAXActionService

Sets specified ETag header with given optional expires value to specified request result.

Specified by:

setETag in interface com.openexchange.ajax.requesthandler.ETagAwareAJAXActionService

Parameters:

eTag - The ETag header value

expires - The optional expires; set to -1 for no expiry

result - The request result

Throws:

com.openexchange.exception.OXException - If setting ETag fails