com.ibm.portal.resolver.helper
Class AbstractStaticDataSource

java.lang.Object
  extended by com.ibm.portal.resolver.helper.DefaultDataSource
      extended by com.ibm.portal.resolver.helper.EarlyBindingDataSource
          extended by com.ibm.portal.resolver.helper.AbstractStaticDataSource
All Implemented Interfaces:
Disposable, Addressable, CacheControlDataSource, DataSource, DataSourceFragment, ProjectContextDataSource, UserContextDataSource, VaryDataSource, VirtualPortalContextDataSource, TimeStamped

public class AbstractStaticDataSource
extends EarlyBindingDataSource

Base class for a DataSource that does not depend on any other request information than URI and parameter map.

Since:
8.0
Note:
This interface is designed to be implemented by clients.

Nested Class Summary
 
Nested classes/interfaces inherited from interface com.ibm.portal.resolver.data.CacheControlDataSource
CacheControlDataSource.CACHE_POLICY, CacheControlDataSource.CACHE_SCOPE
 
Field Summary
static java.util.Map<java.lang.String,java.lang.String[]> STATIC_DATA_SOURCE_PARAMETERS
          Parameters that identify a data source that depends on no request headers and that is cacheable indefinitely.
 
Fields inherited from interface com.ibm.portal.resolver.data.UserContextDataSource
USER_CONTEXT_UNKNOWN
 
Fields inherited from interface com.ibm.portal.resolver.data.CacheControlDataSource
CACHE_CONTROL_EXTENSIONS_UNDEFINED
 
Fields inherited from interface com.ibm.portal.resolver.data.VaryDataSource
NO_VARY_HEADERS, VARY_HEADERS_UNKNOWN
 
Fields inherited from interface com.ibm.portal.resolver.data.ProjectContextDataSource
PROJECT_CONTEXT_UNKNOWN
 
Fields inherited from interface com.ibm.portal.resolver.data.VirtualPortalContextDataSource
VIRTUAL_PORTAL_CONTEXT_UNKNOWN
 
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
 
Constructor Summary
protected AbstractStaticDataSource()
          Default constructor that initializes the data source to "public cacheable"
 
Method Summary
 void clear()
          Reset the object
static java.util.Map<java.lang.String,java.lang.String[]> createStaticParameters()
          Fill the parameter map to match the parameters of a static data source
 void dispose()
          Indicate that the object will no longer be accessed
static java.util.Map<java.lang.String,java.lang.String[]> setStaticParameters(java.util.Map<java.lang.String,java.lang.String[]> parameters)
          Fill the parameter map to match the parameters of a static data source
 
Methods inherited from class com.ibm.portal.resolver.helper.EarlyBindingDataSource
getCacheControlExtensions, getCachePolicy, getCacheScope, getParameters, getVaryHeaders, isPrivate, isProjectDependent, isVirtualPortalDependent, setCacheControlExtensions, setCachePolicy, setCacheScope, setCreated, setExpires, setLastMod, setLastModified, setParameters, setPrivate, setProjectDependent, setUri, setURI, setVaryHeaders, setVirtualPortalDependent
 
Methods inherited from class com.ibm.portal.resolver.helper.DefaultDataSource
createParameters, getCachePolicy, getCachePolicy, getCachePolicy, getCachePolicy, getCachePolicy, getCacheScope, getCacheScope, getCacheScope, getCacheScope, getCacheScope, getContentType, getContentType, getContentType, getContentType, getContentType, getCreated, getExpiration, getExpiration, getExpiration, getExpiration, getExpiration, getExpiration, getExpiration, getExpiration, getExpiration, getExpiration, getExpiration, getExpiration, getExpiration, getLastModified, getParameter, getParameter, getParameter, getParameter, getParameter, getParameter, getParameters, getParameters, getProjectContext, getProjectContext, getProjectContext, getProjectContext, getURI, getUserContext, getUserContext, getUserContext, getUserContext, getVaryHeaders, getVaryHeaders, getVaryHeaders, getVirtualPortalContext, getVirtualPortalContext, getVirtualPortalContext, getVirtualPortalContext, setAddressable, setCachePolicy, setCachePolicy, setCachePolicy, setCachePolicy, setCacheScope, setCacheScope, setCacheScope, setCacheScope, setContentType, setContentType, setContentType, setDataSource, setExpiration, setExpiration, setExpiration, setExpiration, setExpiration, setExpiration, setExpiration, setExpiration, setProjectContext, setProjectContext, setProjectContext, setProjectContext, setProjectContext, setProjectContext, setUserContext, setUserContext, setUserContext, setUserContext, setUserContext, setUserContext, setVaryHeaders, setVaryHeaders, setVaryHeaders, setVaryHeaders, setVirtualPortalContext, setVirtualPortalContext, setVirtualPortalContext, setVirtualPortalContext, setVirtualPortalContext, setVirtualPortalContext, valueOf, valueOf, valueOf, valueOf
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.ibm.portal.resolver.data.CacheControlDataSource
getExpiration
 
Methods inherited from interface com.ibm.portal.resolver.data.DataSource
getContentType, getCreated, getLastModified
 
Methods inherited from interface com.ibm.portal.resolver.data.Addressable
getURI
 

Field Detail

STATIC_DATA_SOURCE_PARAMETERS

public static final java.util.Map<java.lang.String,java.lang.String[]> STATIC_DATA_SOURCE_PARAMETERS
Parameters that identify a data source that depends on no request headers and that is cacheable indefinitely.

Constructor Detail

AbstractStaticDataSource

protected AbstractStaticDataSource()
Default constructor that initializes the data source to "public cacheable"

Method Detail

createStaticParameters

public static final java.util.Map<java.lang.String,java.lang.String[]> createStaticParameters()
Fill the parameter map to match the parameters of a static data source

Returns:
the new parameter map
Since:
8.0

setStaticParameters

public static final java.util.Map<java.lang.String,java.lang.String[]> setStaticParameters(java.util.Map<java.lang.String,java.lang.String[]> parameters)
Fill the parameter map to match the parameters of a static data source

Parameters:
parameters - the target parameters
Since:
8.0

clear

public void clear()
Description copied from class: EarlyBindingDataSource
Reset the object

Overrides:
clear in class EarlyBindingDataSource

dispose

public void dispose()
Description copied from interface: Disposable
Indicate that the object will no longer be accessed

Specified by:
dispose in interface Disposable
Overrides:
dispose in class EarlyBindingDataSource