com.sapportals.portal.prt.component

Interface ICacheValidator

All Superinterfaces:

ICachablePortalComponent, IPortalComponent

public interface ICacheValidator
extends ICachablePortalComponent

An ICachableValidator is implemented by components that wants to control the validity of the cache using a key which is stored in the cache content

Method Summary

String	getValidationKey(IPortalComponentRequest request) Computes a key that will be stored in the cache and that will passed in the method isCacheValid at each request
boolean	isCacheValid(IPortalComponentRequest request, String key) Test whether the cache is valid or not given a key which is stored in the cache content

Methods inherited from interface com.sapportals.portal.prt.component.ICachablePortalComponent

getCachingLevel, hasExpired

Methods inherited from interface com.sapportals.portal.prt.component.IPortalComponent

destroy, init, service

Method Detail

isCacheValid

boolean isCacheValid(IPortalComponentRequest request,
                     String key)

Test whether the cache is valid or not given a key which is stored in the cache content

Parameters:

request - the IPortalComponentRequest

key - the key which is stored

getValidationKey

String getValidationKey(IPortalComponentRequest request)

Computes a key that will be stored in the cache and that will passed in the method isCacheValid at each request

Returns:

a string, the validity key

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] EP-BASIS-API	[sap.com] tc/epbc/prt/api	api	EP-PIN
[sap.com] EP-BASIS-API	[sap.com] epbc.prtapi._apideprecated	default	EP-PIN-PRT
[sap.com] EP-BASIS-API	[sap.com] tc/epbc/prt/lib/api	api	EP-PIN