Package org.opencms.loader

Class CmsStoredContentDeliveryHelper

java.lang.Object

org.opencms.loader.CmsStoredContentDeliveryHelper

public class CmsStoredContentDeliveryHelper
extends Object

Helper for delivering externally stored VFS content directly to an HTTP response.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	CmsStoredContentDeliveryHelper.DeliveryResult	Delivery result.

Constructor Summary

Constructors

Constructor	Description
CmsStoredContentDeliveryHelper()	Creates a new delivery helper without explicit client cache max age.
CmsStoredContentDeliveryHelper(long clientCacheMaxAge)	Creates a new delivery helper.

Method Summary

Modifier and Type	Method	Description
boolean	canDeliver(CmsStoredContentInfo info, I_CmsStorageDelivery storage)	Returns if the given content can be delivered by this helper.
CmsStoredContentDeliveryHelper.DeliveryResult	deliver(CmsStoredContentInfo info, I_CmsStorageDelivery storage, jakarta.servlet.http.HttpServletRequest req, jakarta.servlet.http.HttpServletResponse res)	Delivers stored content to the servlet response.

Methods inherited from class java.lang.Object

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

Constructor Details

CmsStoredContentDeliveryHelper

public CmsStoredContentDeliveryHelper()

Creates a new delivery helper without explicit client cache max age.

CmsStoredContentDeliveryHelper

public CmsStoredContentDeliveryHelper(long clientCacheMaxAge)

Creates a new delivery helper.

Parameters:

clientCacheMaxAge - the maximum age for delivered contents in the clients cache

Method Details

canDeliver

public boolean canDeliver(CmsStoredContentInfo info,
 I_CmsStorageDelivery storage)

Returns if the given content can be delivered by this helper.

Parameters:

info - the stored content info

storage - the delivery storage

Returns:

if the content can be delivered

deliver

public CmsStoredContentDeliveryHelper.DeliveryResult deliver(CmsStoredContentInfo info,
 I_CmsStorageDelivery storage,
 jakarta.servlet.http.HttpServletRequest req,
 jakarta.servlet.http.HttpServletResponse res)
                                                      throws IOException,
CmsException

Delivers stored content to the servlet response.

Parameters:

info - the stored content info

storage - the delivery storage

req - the servlet request

res - the servlet response

Returns:

the delivery result

Throws:

IOException - in case writing to the response fails

CmsException - in case delivery fails