|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.pluto.internal.impl.CacheControlImpl
public class CacheControlImpl
Implementation of JSR-286 CacheControl
.
Constructor Summary | |
---|---|
CacheControlImpl()
|
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 arg0)
Sets an ETag for the current response that is used as validation tag. |
void |
setExpirationTime(int arg0)
Sets a new expiration time for the current response in seconds. |
void |
setPublicScope(boolean arg0)
Sets the caching scope for the current response to public with true as
publicScope and to private with
false as publicScope . |
void |
setUseCachedContent(boolean arg0)
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. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public CacheControlImpl()
Method Detail |
---|
public java.lang.String getETag()
CacheControl
null
if no ETag is set on the response.
This call is equivalent to calling
getProperty(ETAG)
.
- Specified by:
getETag
in interface CacheControl
- Returns:
- the ETag for the current response that is
used as validation tag, or
null
if no ETag is set.
public int getExpirationTime()
CacheControl
expiration-cache tag is returned,
or 0
if no default is defined.
This call returns the same value as the
getProperty(EXPIRATION_CACHE)
call.
- Specified by:
getExpirationTime
in interface CacheControl
- Returns:
- the currently set expiration time in seconds,
or
0
if no expiration time
is set.
public boolean isPublicScope()
CacheControl
cache-scope
tag is returned,
or false
if no default is defined.
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)
.
isPublicScope
in interface CacheControl
public void setETag(java.lang.String arg0)
CacheControl
This call is equivalent to calling
setProperty(ETAG, token)
.
Setting the ETag to null
removes
the currently set ETag.
setETag
in interface CacheControl
arg0
- the ETag tokenpublic void setExpirationTime(int arg0)
CacheControl
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)
.
setExpirationTime
in interface CacheControl
arg0
- expiration time in secondspublic void setPublicScope(boolean arg0)
CacheControl
true
as
publicScope
and to private with
false
as 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)
.
setPublicScope
in interface CacheControl
arg0
- indicating if the cache entry can be shared across userspublic void setUseCachedContent(boolean arg0)
CacheControl
true
no output should be rendered,
but a new expiration time should be set for the
markup with the given ETag .
This call is equivalent to calling
setProperty(USE_CACHED_CONTENT, "true")
.
setUseCachedContent
in interface CacheControl
public boolean useCachedContent()
CacheControl
false
.
This call is equivalent to calling
getProperty(USE_CACHED_CONTENT)
and getting a non-null
value back.
useCachedContent
in interface CacheControl
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |