com.ibm.portal.resolver.data
Interface CacheControlDataSource

All Superinterfaces:

Addressable, DataSource, DataSourceFragment, Disposable, TimeStamped

All Known Implementing Classes:

AbstractDataSource, AbstractStaticDataSource, EarlyBindingDataSource

public interface CacheControlDataSource
extends DataSource

Interface that may optionally be implemented by a DataSource to fine tune how the content of the data source is cacheable.

Since:

6.1.0.3

Note:

This interface is designed to be implemented by clients.

Nested Class Summary

static class	CacheControlDataSource.CACHE_POLICY Controls how the content is cached
static class	CacheControlDataSource.CACHE_SCOPE Possible scope for the cache result

Field Summary

static java.util.Map<java.lang.String,java.lang.String>

CACHE_CONTROL_EXTENSIONS_UNDEFINED Identifies undefined cache control extensions

Fields inherited from interface com.ibm.portal.resolver.data.DataSource

CONTENT_TYPE_UNKNOWN, CREATION_UNKNOWN, EXPIRATION_UNKNOWN, LAST_MODIFICATION_UNKNOWN, MAX_AGE_INFINITE, MAX_AGE_NONE, ROOT_DATE

Fields inherited from interface com.ibm.portal.resolver.data.Addressable

EMPTY_PARAMETERS

Method Summary

java.util.Map<java.lang.String,java.lang.String>	getCacheControlExtensions() Returns a map of cache control extensions that get added to the cache control header, as defined in RFC 2616
CacheControlDataSource.CACHE_POLICY	getCachePolicy() Returns the caching policy for the data
CacheControlDataSource.CACHE_SCOPE	getCacheScope() Returns the cache scope for the data
java.util.Date	getExpiration() Absolute timestamp that indicates the time when the data represented by the source will expire.

Methods inherited from interface com.ibm.portal.resolver.data.DataSource

getContentType, getCreated, getLastModified

Methods inherited from interface com.ibm.portal.resolver.data.Addressable

getParameters, getURI

Methods inherited from interface com.ibm.portal.Disposable

dispose

Field Detail

CACHE_CONTROL_EXTENSIONS_UNDEFINED

static final java.util.Map<java.lang.String,java.lang.String> CACHE_CONTROL_EXTENSIONS_UNDEFINED

Identifies undefined cache control extensions

Since:

7.0

Method Detail

getCacheControlExtensions

java.util.Map<java.lang.String,java.lang.String> getCacheControlExtensions()

Returns a map of cache control extensions that get added to the cache control header, as defined in RFC 2616

Returns:

the extensions or null

getCachePolicy

CacheControlDataSource.CACHE_POLICY getCachePolicy()

Returns the caching policy for the data

Returns:

cache policy or null

getCacheScope

CacheControlDataSource.CACHE_SCOPE getCacheScope()

Returns the cache scope for the data

Returns:

cache scope or null

getExpiration

java.util.Date getExpiration()

Absolute timestamp that indicates the time when the data represented by the source will expire.

Specified by:

getExpiration in interface DataSource

Specified by:

getExpiration in interface DataSourceFragment

Returns:

the date the data expires or null if the value is unknown