com.ibm.portal.resolver.data
Interface VaryDataSource

All Superinterfaces:

Addressable, DataSource, DataSourceFragment, Disposable, TimeStamped

All Known Implementing Classes:

AbstractDataSource, AbstractStaticDataSource, EarlyBindingDataSource

public interface VaryDataSource
extends DataSource

Interface that may optionally be implemented by a DataSource to fine tune what context information a data source depends on.

Since:

6.1.0.3

Note:

This interface is designed to be implemented by clients.

Field Summary

static java.lang.String[]	NO_VARY_HEADERS the data source does not depend on the request
static java.lang.String[]	VARY_HEADERS_UNKNOWN the vary headers are known

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.lang.String[]

getVaryHeaders() Returns a list of HTTP request headers that the content of the data source depends on.

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

getContentType, getCreated, getExpiration, getLastModified

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

getParameters, getURI

Methods inherited from interface com.ibm.portal.Disposable

dispose

Field Detail

NO_VARY_HEADERS

static final java.lang.String[] NO_VARY_HEADERS

the data source does not depend on the request

VARY_HEADERS_UNKNOWN

static final java.lang.String[] VARY_HEADERS_UNKNOWN

the vary headers are known

Method Detail

getVaryHeaders

java.lang.String[] getVaryHeaders()

Returns a list of HTTP request headers that the content of the data source depends on. An empty list indicates that the result is independent on the request headers. A null return value indicates that the data source does not know its vary headers and relies on the framework to assign any.

Returns:

the list of headers or null