Package ortus.boxlang.runtime.components.cache

Class Cache

java.lang.Object

ortus.boxlang.runtime.components.Component

ortus.boxlang.runtime.components.cache.Cache

@BoxComponent(description="Manage cached data with get, put, and delete operations",
              allowsBody=true)
public class Cache
extends Component

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Cache.CacheAction	Enumeration of all possible `type` attribute values.

Nested classes/interfaces inherited from class ortus.boxlang.runtime.components.Component

Component.BodyResult, Component.ComponentBody

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CACHE_PREFIX	The default cache prefix for all cache keys for templates
protected final CacheService	cacheService
static final String	DEFAULT_FILE_STORE	The default file store we leverage
protected final ICacheProvider	defaultCache
static final double	SECONDS_IN_DAY	Useful constant for calculating cache directives

Fields inherited from class ortus.boxlang.runtime.components.Component

componentService, declaredAttributes, DEFAULT_RETURN, functionService, ignoreEnableOutputOnly, interceptorService, name, runtime

Constructor Summary

Constructors

Constructor	Description
Cache()	Constructor

Method Summary

Modifier and Type	Method	Description
Component.BodyResult	_invoke(IBoxContext context, IStruct attributes, Component.ComponentBody body, IStruct executionState)	Component which provides caching functionality, including content, individual entries, and HTTP headers

Methods inherited from class ortus.boxlang.runtime.components.Component

announce, getDeclaredAttributes, getName, invoke, isIgnoreEnableOutputOnly, processBody, processBody, setIgnoreEnableOutputOnly, setName, validateAttributes

Methods inherited from class java.lang.Object

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

Field Details

CACHE_PREFIX

public static final String CACHE_PREFIX

The default cache prefix for all cache keys for templates

See Also:

• Constant Field Values

SECONDS_IN_DAY

public static final double SECONDS_IN_DAY

Useful constant for calculating cache directives

See Also:

• Constant Field Values

DEFAULT_FILE_STORE

public static final String DEFAULT_FILE_STORE

The default file store we leverage

See Also:

• Constant Field Values

cacheService

protected final CacheService cacheService

defaultCache

protected final ICacheProvider defaultCache

Constructor Details

Cache

public Cache()

Constructor

Method Details

_invoke

public Component.BodyResult _invoke(IBoxContext context,
 IStruct attributes,
 Component.ComponentBody body,
 IStruct executionState)

Component which provides caching functionality, including content, individual entries, and HTTP headers

Specified by:

_invoke in class Component

Parameters:

context - The context in which the Component is being invoked

attributes - The attributes to the Component

body - The body of the Component

executionState - The execution state of the Component

Returns:

The result of the invocation