javax.portlet.CacheControl Maven / Gradle / Ivy
Show all versions of portlet-api_2.0_spec Show documentation
/* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
/*
* This source code implements specifications defined by the Java
* Community Process. In order to remain compliant with the specification
* DO NOT add / change / or delete method signatures!
*/
package javax.portlet;
/**
* The CacheControl interface represents cache settings
* for a piece of markup. The settings are only valid for the current
* request.
*
* @since 2.0
*/
public interface CacheControl {
/**
* Get the currently set expiration time.
* If no expiration time is set on this response the
* default defined in the portlet deployment descriptor
* with the expiration-cache tag is returned,
* or 0 if no default is defined.
*
* This call returns the same value as the
* getProperty(EXPIRATION_CACHE)
* call.
*
* @return the currently set expiration time in seconds,
* or 0 if no expiration time
* is set.
*/
public int getExpirationTime();
/**
* 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).
*
* @param time expiration time in seconds
*/
public void setExpirationTime(int time);
/**
* 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).
*
* @return true if the cache scope is public for the
* current response.
*/
public boolean isPublicScope();
/**
* 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).
*
* @param publicScope indicating if the cache entry can be shared across users
*/
public void setPublicScope(boolean publicScope);
/**
* 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).
*
* @return the ETag for the current response that is
* used as validation tag, or null
* if no ETag is set.
*/
public String getETag();
/**
* 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.
*
* @param token the ETag token
*/
public void setETag(String token);
/**
* 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.
*
* @return boolean indicating whether the
* caching scope is set to public for the current response
*/
public 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").
*
* @param useCachedContent boolean indication whether the
* the cached content is still valid or not
*/
public void setUseCachedContent(boolean useCachedContent);
}