com.ibm.portal.resolver.data
Enum CacheControlDataSource.CACHE_SCOPE

java.lang.Object
  java.lang.Enum<CacheControlDataSource.CACHE_SCOPE>
      com.ibm.portal.resolver.data.CacheControlDataSource.CACHE_SCOPE

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CacheControlDataSource.CACHE_SCOPE>

Enclosing interface:

CacheControlDataSource

public static enum CacheControlDataSource.CACHE_SCOPE
extends java.lang.Enum<CacheControlDataSource.CACHE_SCOPE>

Possible scope for the cache result

Enum Constant Summary

PRIVATE
Indicates that all or part of the response message is intended for a single user and MUST NOT be cached by a shared cache.

PUBLIC
Indicates that the response MAY be cached by any cache, even if it would normally be non-cacheable or cacheable only within a non- shared cache.

UNDEFINED
Indicates that the data source does not explicitly defines the cache scope, the server will compute the scope based on the existence of a security context.

Method Summary

abstract CacheControlDataSource.CACHE_SCOPE	combine(CacheControlDataSource.CACHE_SCOPE aScope) Combines a cache scope with an existing scope
static CacheControlDataSource.CACHE_SCOPE	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static CacheControlDataSource.CACHE_SCOPE[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

PRIVATE

public static final CacheControlDataSource.CACHE_SCOPE PRIVATE

Indicates that all or part of the response message is intended for a single user and MUST NOT be cached by a shared cache. This allows an origin server to state that the specified parts of the response are intended for only one user and are not a valid response for requests by other users. A private (non-shared) cache MAY cache the response.

PUBLIC

public static final CacheControlDataSource.CACHE_SCOPE PUBLIC

Indicates that the response MAY be cached by any cache, even if it would normally be non-cacheable or cacheable only within a non- shared cache.

UNDEFINED

public static final CacheControlDataSource.CACHE_SCOPE UNDEFINED

Indicates that the data source does not explicitly defines the cache scope, the server will compute the scope based on the existence of a security context.

Method Detail

values

public static CacheControlDataSource.CACHE_SCOPE[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (CacheControlDataSource.CACHE_SCOPE c : CacheControlDataSource.CACHE_SCOPE.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CacheControlDataSource.CACHE_SCOPE valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

combine

public abstract CacheControlDataSource.CACHE_SCOPE combine(CacheControlDataSource.CACHE_SCOPE aScope)

Combines a cache scope with an existing scope

Parameters:

aScope - the cache scope to combine

Returns:

the new policy