Java Portlet API V3.0 3.0.1 · javax.portlet.CacheControl

Method Summary

Modifier and Type	Method and Description
public String	Returns: the ETag for the current response that is used as validation tag, or `null` if no ETag is set. getETag() Returns the ETag for the current response that is used as validation tag, or `null` if no ETag is set on the response.
public int	Returns: the currently set expiration time in seconds; 0 indicates caching is disabled for this portlet; -1 indicates the cache does not expire. getExpirationTime() Get the currently set expiration time.
public boolean	Returns: true if the cache scope is public for the current response. isPublicScope() Returns a boolean indicating whether the caching scope is set to public for the current response.
public void	setETag(String the ETag token token) Sets an ETag for the current response that is used as validation tag.
public void	setExpirationTime(int expiration time in seconds time) Sets a new expiration time for the current response in seconds.
public void	setPublicScope(boolean indicating if the cache entry can be shared across users publicScope) Sets the caching scope for the current response to public with `true` as `publicScope` and to private with `false` as `publicScope`.
public void	setUseCachedContent(boolean boolean indication whether the the cached content is still valid or not useCachedContent) Sets the indication whether the cached content for the provided ETag at the request is still valid or not.
public boolean	Returns: boolean indicating whether the caching scope is set to public for the current response useCachedContent() Returns a boolean indicating whether the cached content for the provided ETag at the request can still be considerated valid.

Method Detail

getETag back to summary

getETag	back to summary
public 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. This call is equivalent to calling `getProperty(ETAG)`. Returns:String the ETag for the current response that is used as validation tag, or `null` if no ETag is set.

public 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.

This call is equivalent to calling getProperty(ETAG).

Returns:String: the ETag for the current response that is used as validation tag, or null if no ETag is set.

getExpirationTime back to summary

getExpirationTime	back to summary
public int getExpirationTime() Get the currently set expiration time. If no expiration time has been explicitly set on this response, the default defined in the portlet deployment descriptor with the `expiration-cache` tag is returned; If no default value is provided in the portlet deployment descriptor, 0 is returned. This call returns the same value as the `getProperty(EXPIRATION_CACHE)` call. Returns:int the currently set expiration time in seconds; 0 indicates caching is disabled for this portlet; -1 indicates the cache does not expire.

public int getExpirationTime()

Get the currently set expiration time. If no expiration time has been explicitly set on this response, the default defined in the portlet deployment descriptor with the expiration-cache tag is returned; If no default value is provided in the portlet deployment descriptor, 0 is returned.

This call returns the same value as the getProperty(EXPIRATION_CACHE) call.

Returns:int: the currently set expiration time in seconds; 0 indicates caching is disabled for this portlet; -1 indicates the cache does not expire.

isPublicScope back to summary

isPublicScope	back to summary
public boolean isPublicScope() Returns a boolean indicating whether the caching scope is set to public for the current response. If no caching scope is set on this response, the default defined in the deployment descriptor with the `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)`. Returns:boolean true if the cache scope is public for the current response.

public boolean isPublicScope()

Returns a boolean indicating whether the caching scope is set to public for the current response. If no caching scope is set on this response, the default defined in the deployment descriptor with the 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).

Returns:boolean: true if the cache scope is public for the current response.

setETag back to summary

setETag	back to summary
public void setETag(String token) Sets an ETag for the current response that is used as validation tag. If an ETag was already set it is replaced with the new value. This call is equivalent to calling `setProperty(ETAG, token)`. Setting the ETag to `null` removes the currently set ETag. Parameters token:String the ETag token

public void setETag(String token)

Sets an ETag for the current response that is used as validation tag. If an ETag was already set it is replaced with the new value.

This call is equivalent to calling setProperty(ETAG, token).

Setting the ETag to null removes the currently set ETag.

Parameters

token:String: the ETag token

setExpirationTime back to summary

setExpirationTime	back to summary
public void setExpirationTime(int time) Sets a new expiration time for the current response in seconds. 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)`. Parameters time:int expiration time in seconds

public void setExpirationTime(int time)

Sets a new expiration time for the current response in seconds.

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).

Parameters

time:int: expiration time in seconds

setPublicScope back to summary

setPublicScope	back to summary
public 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`. 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)`. Parameters publicScope:boolean indicating if the cache entry can be shared across users

public 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.

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).

Parameters

publicScope:boolean: indicating if the cache entry can be shared across users

setUseCachedContent back to summary

setUseCachedContent	back to summary
public void setUseCachedContent(boolean useCachedContent) Sets the indication whether the cached content for the provided ETag at the request is still valid or not. If set to `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")`. Parameters useCachedContent:boolean boolean indication whether the the cached content is still valid or not

public void setUseCachedContent(boolean useCachedContent)

Sets the indication whether the cached content for the provided ETag at the request is still valid or not. If set to 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").

Parameters

useCachedContent:boolean: boolean indication whether the the cached content is still valid or not

useCachedContent back to summary

useCachedContent	back to summary
public boolean useCachedContent() Returns a boolean indicating whether the cached content for the provided ETag at the request can still be considerated valid. If not set, the default is `false`. This call is equivalent to calling `getProperty(USE_CACHED_CONTENT)` and getting a non-null value back. Returns:boolean boolean indicating whether the caching scope is set to public for the current response

public boolean useCachedContent()

Returns a boolean indicating whether the cached content for the provided ETag at the request can still be considerated valid. If not set, the default is false.

This call is equivalent to calling getProperty(USE_CACHED_CONTENT) and getting a non-null value back.

Returns:boolean: boolean indicating whether the caching scope is set to public for the current response

public Interface CacheControl

Method Summary

Method Detail