com.opencms.template
Class CmsCacheDirectives

java.lang.Object
  |
  +--com.opencms.template.A_CmsCacheDirectives
        |
        +--com.opencms.template.CmsCacheDirectives

All Implemented Interfaces:

I_CmsLogChannels

public class CmsCacheDirectives

extends A_CmsCacheDirectives

implements I_CmsLogChannels

Collection of all information about cacheability and used keys.

Version:

$Revision: 1.18 $ $Date: 2002/12/06 23:16:51 $

Author:

Alexander Lucas, Hanjo Riege

Field Summary

Fields inherited from class com.opencms.template.A_CmsCacheDirectives

C_CACHE_EXPORT, C_CACHE_INTERNAL, C_CACHE_PROXY_PRIVATE, C_CACHE_PROXY_PUBLIC, C_CACHE_STREAM, m_cd, m_timecheck, m_timeout, m_userSetExport, m_userSetProxyPrivate, m_userSetProxyPublic

Fields inherited from interface com.opencms.boot.I_CmsLogChannels

C_FLEX_CACHE, C_FLEX_LOADER, C_LOGGING, C_MODULE_CRITICAL, C_MODULE_DEBUG, C_MODULE_INFO, C_OPENCMS_CACHE, C_OPENCMS_CRITICAL, C_OPENCMS_CRONSCHEDULER, C_OPENCMS_DEBUG, C_OPENCMS_ELEMENTCACHE, C_OPENCMS_INFO, C_OPENCMS_INIT, C_OPENCMS_POOL, C_OPENCMS_STATICEXPORT, C_OPENCMS_STREAMING, C_PREPROCESSOR_IS_LOGGING

Constructor Summary

CmsCacheDirectives(boolean b)
Constructor for initializing all caching properties with the same boolean value.

CmsCacheDirectives(boolean internal, boolean stream)
Constructor

CmsCacheDirectives(boolean internal, boolean proxyPriv, boolean proxyPub, boolean export, boolean stream)
Constructor for initializing all caching properties given boolean values.

Method Summary

void	setExport(boolean export) enables or disables the export for this element.
void	setProxyPrivateCacheable(boolean proxPrivate) enables or disables the proxy private cache for this element.
void	setProxyPublicCacheable(boolean proxPublic) enables or disables the proxy public cache for this element.
void	setTimeout(CmsTimeout timeout) set the timeout object(used if the element should be reloaded every x minutes.

Methods inherited from class com.opencms.template.A_CmsCacheDirectives

getCacheKey, getTimeout, isExportable, isInternalCacheable, isParameterPartOfKey, isProxyPrivateCacheable, isProxyPublicCacheable, isStreamable, isTimeCritical, isUserPartOfKey, merge, noAutoRenewAfterPublish, renewAfterEveryPublish, setCacheGroups, setCacheGroups, setCacheParameters, setCacheUri, setCacheUser, setExternalCaching, setNoCacheParameters, shouldRenew, userSetExport, userSetProxyPrivate, userSetProxyPublic

Methods inherited from class java.lang.Object

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

Constructor Detail

CmsCacheDirectives

public CmsCacheDirectives(boolean b)

Constructor for initializing all caching properties with the same boolean value.

Parameters:

b - Boolean value that should be set for all caching properties

CmsCacheDirectives

public CmsCacheDirectives(boolean internal,
                          boolean proxyPriv,
                          boolean proxyPub,
                          boolean export,
                          boolean stream)

Constructor for initializing all caching properties given boolean values.

Parameters:

internal - Initial value for "internal cacheable" property.

proxyPriv - Initial value for "proxy private cacheable" property.

proxyPub - Initial value for "internal cacheable" property.

export - Initial value for "exportable" property.

stream - Initial value for "streamable" property.

CmsCacheDirectives

public CmsCacheDirectives(boolean internal,
                          boolean stream)

Constructor

Parameters:

internal - Initial value for "internal cacheable" property.

stream - Initial value for "streamable" property.

Method Detail

setProxyPublicCacheable

public void setProxyPublicCacheable(boolean proxPublic)

enables or disables the proxy public cache for this element.

setProxyPrivateCacheable

public void setProxyPrivateCacheable(boolean proxPrivate)

enables or disables the proxy private cache for this element.

setExport

public void setExport(boolean export)

enables or disables the export for this element.

Parameters:

export - true if the flag should be set in the response header.

setTimeout

public void setTimeout(CmsTimeout timeout)

set the timeout object(used if the element should be reloaded every x minutes. if the timeout object says so the proxyCache is disabled.

Specified by:

setTimeout in class A_CmsCacheDirectives

Parameters:

timeout - a CmsTimeout object.