|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface CacheControl
The CacheControl interface represents cache settings for a piece of markup. The settings are only valid for the current request.
Method Summary | |
---|---|
java.lang.String | getETag()
Returns the ETag for the current response that is used as validation tag, or null if no ETag is set on the response. |
int | getExpirationTime()
Get the currently set expiration time. |
boolean | isPublicScope()
Returns a boolean indicating whether the caching scope is set to public for the current response. |
void | setETag(java.lang.String token)
Sets an ETag for the current response that is used as validation tag. |
void | setExpirationTime(int time)
Sets a new expiration time for the current response in seconds. |
void | setPublicScope(boolean publicScope)
Sets the caching scope for the current response to public with true as publicScope and to private with false as publicScope. |
void | setUseCachedContent(boolean useCachedContent)
Sets the indication whether the cached content for the provided ETag at the request is still valid or not. |
boolean | useCachedContent()
Returns a boolean indicating whether the cached content for the provided ETag at the request can still be considerated valid. |
Method Detail |
---|
int getExpirationTime()
This call returns the same value as the getProperty(EXPIRATION_CACHE) call.
void setExpirationTime(int time)
If the expiration value is set to 0, caching is disabled for this portlet; if the value is set to -1, the cache does not expire.
This call is equivalent to calling setProperty(EXPIRATION_CACHE).
boolean isPublicScope()
Public cache scope indicates that the cache entry can be shared across users. Non-public, or private cache scope indicates that the cache entry must not be shared across users.
This call is equivalent to calling getProperty(CACHE_SCOPE).equals(PUBLIC_SCOPE).
void setPublicScope(boolean publicScope)
Public cache scope indicates that the cache entry can be shared across users. Non-public, or private cache scope indicates that the cache entry must not be shared across users.
This call is equivalent to calling (publicScope ? setProperty(CACHE_SCOPE, PUBLIC_SCOPE | setProperty(CACHE_SCOPE, PRIVATE_SCOPE).
java.lang.String getETag()
This call is equivalent to calling getProperty(ETAG).
void setETag(java.lang.String token)
This call is equivalent to calling setProperty(ETAG, token).
Setting the ETag to null removes the currently set ETag.
boolean useCachedContent()
This call is equivalent to calling getProperty(USE_CACHED_CONTENT) and getting a non-null value back.
void setUseCachedContent(boolean useCachedContent)
This call is equivalent to calling setProperty(USE_CACHED_CONTENT, "true").
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |