Spring Framework 6.1.4 · org.springframework.http.CacheControl

Modifier and Type	Field and Description
private boolean	cachePrivate
private boolean	cachePublic
private boolean	immutable
private Duration	maxAge
private boolean	mustRevalidate
private boolean	noCache
private boolean	noStore
private boolean	noTransform
private boolean	proxyRevalidate
private Duration	sMaxAge
private Duration	staleIfError
private Duration	staleWhileRevalidate

Access	Constructor and Description
protected	CacheControl() Create an empty CacheControl instance.

Method Summary

Modifier and Type	Method and Description
private void	appendDirective(StringBuilder builder, String value)
public CacheControl	Returns: `this`, to facilitate method chaining cachePrivate() Add a "private" directive.
public CacheControl	Returns: `this`, to facilitate method chaining cachePublic() Add a "public" directive.
public static CacheControl	Returns: `this`, to facilitate method chaining empty() Return an empty directive.
public String	Returns: the header value, or `null` if no directive was added getHeaderValue() Return the "Cache-Control" header value, if any.
public CacheControl	Returns: `this`, to facilitate method chaining immutable() Add an "immutable" directive.
public static CacheControl	Returns: `this`, to facilitate method chaining maxAge(long the maximum time the response should be cached maxAge, TimeUnit the time unit of the `maxAge` argument unit) Add a "max-age=" directive.
public static CacheControl	Returns: `this`, to facilitate method chaining maxAge(Duration the maximum time the response should be cached maxAge) Add a "max-age=" directive.
public CacheControl	Returns: `this`, to facilitate method chaining mustRevalidate() Add a "must-revalidate" directive.
public static CacheControl	Returns: `this`, to facilitate method chaining noCache() Add a "no-cache" directive.
public static CacheControl	Returns: `this`, to facilitate method chaining noStore() Add a "no-store" directive.
public CacheControl	Returns: `this`, to facilitate method chaining noTransform() Add a "no-transform" directive.
public CacheControl	Returns: `this`, to facilitate method chaining proxyRevalidate() Add a "proxy-revalidate" directive.
public CacheControl	Returns: `this`, to facilitate method chaining sMaxAge(long the maximum time the response should be cached sMaxAge, TimeUnit the time unit of the `sMaxAge` argument unit) Add an "s-maxage" directive.
public CacheControl	Returns: `this`, to facilitate method chaining sMaxAge(Duration the maximum time the response should be cached sMaxAge) Add an "s-maxage" directive.
public CacheControl	Returns: `this`, to facilitate method chaining staleIfError(long the maximum time the response should be used when errors are encountered staleIfError, TimeUnit the time unit of the `staleIfError` argument unit) Add a "stale-if-error" directive.
public CacheControl	Returns: `this`, to facilitate method chaining staleIfError(Duration the maximum time the response should be used when errors are encountered staleIfError) Add a "stale-if-error" directive.
public CacheControl	Returns: `this`, to facilitate method chaining staleWhileRevalidate(long the maximum time the response should be used while being revalidated staleWhileRevalidate, TimeUnit the time unit of the `staleWhileRevalidate` argument unit) Add a "stale-while-revalidate" directive.
public CacheControl	Returns: `this`, to facilitate method chaining staleWhileRevalidate(Duration the maximum time the response should be used while being revalidated staleWhileRevalidate) Add a "stale-while-revalidate" directive.
private String	Returns: the header value (potentially empty) toHeaderValue() Return the "Cache-Control" header value.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

cachePrivate	back to summary
private boolean cachePrivate

cachePublic	back to summary
private boolean cachePublic

immutable	back to summary
private boolean immutable

maxAge	back to summary
private Duration maxAge Annotations @Nullable

mustRevalidate	back to summary
private boolean mustRevalidate

noCache	back to summary
private boolean noCache

noStore	back to summary
private boolean noStore

noTransform	back to summary
private boolean noTransform

proxyRevalidate	back to summary
private boolean proxyRevalidate

sMaxAge	back to summary
private Duration sMaxAge Annotations @Nullable

staleIfError	back to summary
private Duration staleIfError Annotations @Nullable

staleWhileRevalidate	back to summary
private Duration staleWhileRevalidate Annotations @Nullable

CacheControl	back to summary
protected CacheControl() Create an empty CacheControl instance. See Also `empty()`

Method Detail

appendDirective	back to summary
private void appendDirective(StringBuilder builder, String value)

cachePrivate back to summary

cachePrivate	back to summary
public CacheControl cachePrivate() Add a "private" directive. This directive indicates that the response message is intended for a single user and MUST NOT be stored by a shared cache. Returns:CacheControl `this`, to facilitate method chaining See Also rfc7234 section 5.2.2.6

public CacheControl cachePrivate()

Add a "private" directive.

This directive indicates that the response message is intended for a single user and MUST NOT be stored by a shared cache.

Returns:CacheControl: this, to facilitate method chaining
See Also: rfc7234 section 5.2.2.6

cachePublic back to summary

cachePublic	back to summary
public CacheControl cachePublic() Add a "public" directive. This directive indicates that any cache MAY store the response, even if the response would normally be non-cacheable or cacheable only within a private cache. Returns:CacheControl `this`, to facilitate method chaining See Also rfc7234 section 5.2.2.5

public CacheControl cachePublic()

Add a "public" directive.

This directive indicates that any cache MAY store the response, even if the response would normally be non-cacheable or cacheable only within a private cache.

Returns:CacheControl: this, to facilitate method chaining
See Also: rfc7234 section 5.2.2.5

empty back to summary

empty	back to summary
public static CacheControl empty() Return an empty directive. This is well suited for using other optional directives without "max-age", "no-cache" or "no-store". Returns:CacheControl `this`, to facilitate method chaining

public static CacheControl empty()

Return an empty directive.

This is well suited for using other optional directives without "max-age", "no-cache" or "no-store".

Returns:CacheControl: this, to facilitate method chaining

getHeaderValue back to summary

getHeaderValue	back to summary
public String getHeaderValue() Return the "Cache-Control" header value, if any. Returns:String the header value, or `null` if no directive was added Annotations @Nullable

public String getHeaderValue()

Return the "Cache-Control" header value, if any.

Returns:String

the header value, or null if no directive was added

Annotations

@Nullable

immutable back to summary

immutable	back to summary
public CacheControl immutable() Add an "immutable" directive. This directive indicates that the origin server will not update the representation of that resource during the freshness lifetime of the response. Adding a `max-age` directive is strongly advised to enforce the actual freshness lifetime. Returns:CacheControl `this`, to facilitate method chaining Since 6.0.5 See Also rfc8246

public CacheControl immutable()

Add an "immutable" directive.

This directive indicates that the origin server will not update the representation of that resource during the freshness lifetime of the response. Adding a max-age directive is strongly advised to enforce the actual freshness lifetime.

Returns:CacheControl: this, to facilitate method chaining
Since: 6.0.5
See Also: rfc8246

maxAge back to summary

maxAge	back to summary
public static CacheControl maxAge(long maxAge, TimeUnit unit) Add a "max-age=" directive. This directive is well suited for publicly caching resources, knowing that they won't change within the configured amount of time. Additional directives can be also used, in case resources shouldn't be cached (`cachePrivate()`) or transformed (`noTransform()`) by shared caches. In order to prevent caches to reuse the cached response even when it has become stale (i.e. the "max-age" delay is passed), the "must-revalidate" directive should be set (`mustRevalidate()` Parameters maxAge:long the maximum time the response should be cached unit:TimeUnit the time unit of the `maxAge` argument Returns:CacheControl `this`, to facilitate method chaining See Also `maxAge(Duration)`, rfc7234 section 5.2.2.8

public static CacheControl maxAge(long maxAge, TimeUnit unit)

Add a "max-age=" directive.

This directive is well suited for publicly caching resources, knowing that they won't change within the configured amount of time. Additional directives can be also used, in case resources shouldn't be cached (cachePrivate()) or transformed (noTransform()) by shared caches.

In order to prevent caches to reuse the cached response even when it has become stale (i.e. the "max-age" delay is passed), the "must-revalidate" directive should be set (mustRevalidate()

Parameters

maxAge:long: the maximum time the response should be cached
unit:TimeUnit: the time unit of the maxAge argument

Returns:CacheControl

this, to facilitate method chaining

maxAge back to summary

maxAge	back to summary
public static CacheControl maxAge(Duration maxAge) Add a "max-age=" directive. This directive is well suited for publicly caching resources, knowing that they won't change within the configured amount of time. Additional directives can be also used, in case resources shouldn't be cached (`cachePrivate()`) or transformed (`noTransform()`) by shared caches. In order to prevent caches to reuse the cached response even when it has become stale (i.e. the "max-age" delay is passed), the "must-revalidate" directive should be set (`mustRevalidate()` Parameters maxAge:Duration the maximum time the response should be cached Returns:CacheControl `this`, to facilitate method chaining Since 5.2 See Also rfc7234 section 5.2.2.8

public static CacheControl maxAge(Duration maxAge)

Add a "max-age=" directive.

In order to prevent caches to reuse the cached response even when it has become stale (i.e. the "max-age" delay is passed), the "must-revalidate" directive should be set (mustRevalidate()

Parameters

maxAge:Duration: the maximum time the response should be cached

Returns:CacheControl

this, to facilitate method chaining

Since

5.2

See Also

rfc7234 section 5.2.2.8

mustRevalidate back to summary

mustRevalidate	back to summary
public CacheControl mustRevalidate() Add a "must-revalidate" directive. This directive indicates that once it has become stale, a cache MUST NOT use the response to satisfy subsequent requests without successful validation on the origin server. Returns:CacheControl `this`, to facilitate method chaining See Also rfc7234 section 5.2.2.1

public CacheControl mustRevalidate()

Add a "must-revalidate" directive.

This directive indicates that once it has become stale, a cache MUST NOT use the response to satisfy subsequent requests without successful validation on the origin server.

Returns:CacheControl: this, to facilitate method chaining
See Also: rfc7234 section 5.2.2.1

noCache back to summary

noCache	back to summary
public static CacheControl noCache() Add a "no-cache" directive. This directive is well suited for telling caches that the response can be reused only if the client revalidates it with the server. This directive won't disable cache altogether and may result with clients sending conditional requests (with "ETag", "If-Modified-Since" headers) and the server responding with "304 - Not Modified" status. In order to disable caching and minimize requests/responses exchanges, the `noStore()` directive should be used instead of `#noCache()`. Returns:CacheControl `this`, to facilitate method chaining See Also rfc7234 section 5.2.2.2

public static CacheControl noCache()

Add a "no-cache" directive.

This directive is well suited for telling caches that the response can be reused only if the client revalidates it with the server. This directive won't disable cache altogether and may result with clients sending conditional requests (with "ETag", "If-Modified-Since" headers) and the server responding with "304 - Not Modified" status.

In order to disable caching and minimize requests/responses exchanges, the noStore() directive should be used instead of #noCache().

Returns:CacheControl: this, to facilitate method chaining
See Also: rfc7234 section 5.2.2.2

noStore back to summary

noStore	back to summary
public static CacheControl noStore() Add a "no-store" directive. This directive is well suited for preventing caches (browsers and proxies) to cache the content of responses. Returns:CacheControl `this`, to facilitate method chaining See Also rfc7234 section 5.2.2.3

public static CacheControl noStore()

Add a "no-store" directive.

This directive is well suited for preventing caches (browsers and proxies) to cache the content of responses.

Returns:CacheControl: this, to facilitate method chaining
See Also: rfc7234 section 5.2.2.3

noTransform back to summary

noTransform	back to summary
public CacheControl noTransform() Add a "no-transform" directive. This directive indicates that intermediaries (caches and others) should not transform the response content. This can be useful to force caches and CDNs not to automatically gzip or optimize the response content. Returns:CacheControl `this`, to facilitate method chaining See Also rfc7234 section 5.2.2.4

public CacheControl noTransform()

Add a "no-transform" directive.

This directive indicates that intermediaries (caches and others) should not transform the response content. This can be useful to force caches and CDNs not to automatically gzip or optimize the response content.

Returns:CacheControl: this, to facilitate method chaining
See Also: rfc7234 section 5.2.2.4

proxyRevalidate back to summary

proxyRevalidate	back to summary
public CacheControl proxyRevalidate() Add a "proxy-revalidate" directive. This directive has the same meaning as the "must-revalidate" directive, except that it does not apply to private caches (i.e. browsers, HTTP clients). Returns:CacheControl `this`, to facilitate method chaining See Also rfc7234 section 5.2.2.7

public CacheControl proxyRevalidate()

Add a "proxy-revalidate" directive.

This directive has the same meaning as the "must-revalidate" directive, except that it does not apply to private caches (i.e. browsers, HTTP clients).

Returns:CacheControl: this, to facilitate method chaining
See Also: rfc7234 section 5.2.2.7

sMaxAge back to summary

sMaxAge	back to summary
public CacheControl sMaxAge(long sMaxAge, TimeUnit unit) Add an "s-maxage" directive. This directive indicates that, in shared caches, the maximum age specified by this directive overrides the maximum age specified by other directives. Parameters sMaxAge:long the maximum time the response should be cached unit:TimeUnit the time unit of the `sMaxAge` argument Returns:CacheControl `this`, to facilitate method chaining See Also `sMaxAge(Duration)`, rfc7234 section 5.2.2.9

public CacheControl sMaxAge(long sMaxAge, TimeUnit unit)

Add an "s-maxage" directive.

This directive indicates that, in shared caches, the maximum age specified by this directive overrides the maximum age specified by other directives.

Parameters

sMaxAge:long: the maximum time the response should be cached
unit:TimeUnit: the time unit of the sMaxAge argument

Returns:CacheControl

this, to facilitate method chaining

sMaxAge back to summary

sMaxAge	back to summary
public CacheControl sMaxAge(Duration sMaxAge) Add an "s-maxage" directive. This directive indicates that, in shared caches, the maximum age specified by this directive overrides the maximum age specified by other directives. Parameters sMaxAge:Duration the maximum time the response should be cached Returns:CacheControl `this`, to facilitate method chaining Since 5.2 See Also rfc7234 section 5.2.2.9

public CacheControl sMaxAge(Duration sMaxAge)

Add an "s-maxage" directive.

This directive indicates that, in shared caches, the maximum age specified by this directive overrides the maximum age specified by other directives.

Parameters

sMaxAge:Duration: the maximum time the response should be cached

Returns:CacheControl

this, to facilitate method chaining

Since

5.2

See Also

rfc7234 section 5.2.2.9

staleIfError back to summary

staleIfError	back to summary
public CacheControl staleIfError(long staleIfError, TimeUnit unit) Add a "stale-if-error" directive. This directive indicates that when an error is encountered, a cached stale response MAY be used to satisfy the request, regardless of other freshness information. Parameters staleIfError:long the maximum time the response should be used when errors are encountered unit:TimeUnit the time unit of the `staleIfError` argument Returns:CacheControl `this`, to facilitate method chaining See Also `staleIfError(Duration)`, rfc5861 section 4

public CacheControl staleIfError(long staleIfError, TimeUnit unit)

Add a "stale-if-error" directive.

This directive indicates that when an error is encountered, a cached stale response MAY be used to satisfy the request, regardless of other freshness information.

Parameters

staleIfError:long: the maximum time the response should be used when errors are encountered
unit:TimeUnit: the time unit of the staleIfError argument

Returns:CacheControl

this, to facilitate method chaining

staleIfError back to summary

staleIfError	back to summary
public CacheControl staleIfError(Duration staleIfError) Add a "stale-if-error" directive. This directive indicates that when an error is encountered, a cached stale response MAY be used to satisfy the request, regardless of other freshness information. Parameters staleIfError:Duration the maximum time the response should be used when errors are encountered Returns:CacheControl `this`, to facilitate method chaining Since 5.2 See Also rfc5861 section 4

public CacheControl staleIfError(Duration staleIfError)

Add a "stale-if-error" directive.

This directive indicates that when an error is encountered, a cached stale response MAY be used to satisfy the request, regardless of other freshness information.

Parameters

staleIfError:Duration: the maximum time the response should be used when errors are encountered

Returns:CacheControl

this, to facilitate method chaining

Since

5.2

See Also

rfc5861 section 4

staleWhileRevalidate back to summary

staleWhileRevalidate	back to summary
public CacheControl staleWhileRevalidate(long staleWhileRevalidate, TimeUnit unit) Add a "stale-while-revalidate" directive. This directive indicates that caches MAY serve the response in which it appears after it becomes stale, up to the indicated number of seconds. If a cached response is served stale due to the presence of this extension, the cache SHOULD attempt to revalidate it while still serving stale responses (i.e. without blocking). Parameters staleWhileRevalidate:long the maximum time the response should be used while being revalidated unit:TimeUnit the time unit of the `staleWhileRevalidate` argument Returns:CacheControl `this`, to facilitate method chaining See Also `staleWhileRevalidate(Duration)`, rfc5861 section 3

public CacheControl staleWhileRevalidate(long staleWhileRevalidate, TimeUnit unit)

Add a "stale-while-revalidate" directive.

This directive indicates that caches MAY serve the response in which it appears after it becomes stale, up to the indicated number of seconds. If a cached response is served stale due to the presence of this extension, the cache SHOULD attempt to revalidate it while still serving stale responses (i.e. without blocking).

Parameters

staleWhileRevalidate:long: the maximum time the response should be used while being revalidated
unit:TimeUnit: the time unit of the staleWhileRevalidate argument

Returns:CacheControl

this, to facilitate method chaining

staleWhileRevalidate back to summary

staleWhileRevalidate	back to summary
public CacheControl staleWhileRevalidate(Duration staleWhileRevalidate) Add a "stale-while-revalidate" directive. This directive indicates that caches MAY serve the response in which it appears after it becomes stale, up to the indicated number of seconds. If a cached response is served stale due to the presence of this extension, the cache SHOULD attempt to revalidate it while still serving stale responses (i.e. without blocking). Parameters staleWhileRevalidate:Duration the maximum time the response should be used while being revalidated Returns:CacheControl `this`, to facilitate method chaining Since 5.2 See Also rfc5861 section 3

public CacheControl staleWhileRevalidate(Duration staleWhileRevalidate)

Add a "stale-while-revalidate" directive.

Parameters

staleWhileRevalidate:Duration: the maximum time the response should be used while being revalidated

Returns:CacheControl

this, to facilitate method chaining

Since

5.2

See Also

rfc5861 section 3

toHeaderValue	back to summary
private String toHeaderValue() Return the "Cache-Control" header value. Returns:String the header value (potentially empty)

toHeaderValue

back to summary

private String toHeaderValue()

Return the "Cache-Control" header value.

Returns:String: the header value (potentially empty)

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

public Class CacheControl

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail