Package io.micronaut.http.cachecontrol

Class CacheControl.Builder

java.lang.Object

io.micronaut.http.cachecontrol.CacheControl.Builder

Enclosing class:

CacheControl

public static final class CacheControl.Builder
extends Object

Cache-Control Builder.

Method Summary

Modifier and Type	Method	Description
@NonNull CacheControl	build()
@NonNull CacheControl.Builder	inmutable()	Sets Cache-Control as inmmutable.
@NonNull CacheControl.Builder	maxAge(@NonNull Long maxAge)
@NonNull CacheControl.Builder	maxAge(@NonNull Duration maxAge)
@NonNull CacheControl.Builder	mustRevalidate()	Enables mustRevalidate.
@NonNull CacheControl.Builder	mustUnderstand()
@NonNull CacheControl.Builder	noCache()
@NonNull CacheControl.Builder	noStore()
@NonNull CacheControl.Builder	noTransform()
@NonNull CacheControl.Builder	privateDirective()	The private response directive indicates that the response can be stored only in a private cache (e.g.
@NonNull CacheControl.Builder	proxyRevalidate()	Enables proxyRevalidate.
@NonNull CacheControl.Builder	publicDirective()	The public response directive indicates that the response can be stored in a shared cache.
@NonNull CacheControl.Builder	sMaxAge(@NonNull Long sMaxAge)
@NonNull CacheControl.Builder	sMaxAge(@NonNull Duration sMaxAge)
@NonNull CacheControl.Builder	staleIfError(@NonNull Long seconds)
@NonNull CacheControl.Builder	staleIfError(@NonNull Duration staleIfError)
@NonNull CacheControl.Builder	staleWhileRevalidate(@NonNull Long seconds)
@NonNull CacheControl.Builder	staleWhileRevalidate(@NonNull Duration staleWhileRevalidate)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

proxyRevalidate

@NonNull
public @NonNull CacheControl.Builder proxyRevalidate()

Enables proxyRevalidate. If cache is stale, it must revalidate with the proxy before use but only for shared caches.

Returns:

The Cache-Control Builder.

mustRevalidate

@NonNull
public @NonNull CacheControl.Builder mustRevalidate()

Enables mustRevalidate. If cache is stale, it must revalidate with the server before use.

Returns:

The Cache-Control Builder.

sMaxAge

@NonNull
public @NonNull CacheControl.Builder sMaxAge(@NonNull
 @NonNull Long sMaxAge)

Parameters:

sMaxAge - How long (in seconds) the response is considered fresh for shared (e.g., CDN) caches.

Returns:

The Cache-Control Builder.

sMaxAge

@NonNull
public @NonNull CacheControl.Builder sMaxAge(@NonNull
 @NonNull Duration sMaxAge)

Parameters:

sMaxAge - How long (in seconds) the response is considered fresh for shared (e.g., CDN) caches.

Returns:

The Cache-Control Builder.

maxAge

@NonNull
public @NonNull CacheControl.Builder maxAge(@NonNull
 @NonNull Long maxAge)

Parameters:

maxAge - How long (in seconds) the response is considered fresh.

Returns:

The Cache-Control Builder.

maxAge

@NonNull
public @NonNull CacheControl.Builder maxAge(@NonNull
 @NonNull Duration maxAge)

Parameters:

maxAge - How long the response is considered fresh.

Returns:

The Cache-Control Builder.

inmutable

@NonNull
public @NonNull CacheControl.Builder inmutable()

Sets Cache-Control as inmmutable. It indicates the response won't change, so no revalidation is needed.

Returns:

The Cache-Control Builder.

publicDirective

@NonNull
public @NonNull CacheControl.Builder publicDirective()

The public response directive indicates that the response can be stored in a shared cache.

Returns:

The Cache-Control Builder.

privateDirective

@NonNull
public @NonNull CacheControl.Builder privateDirective()

The private response directive indicates that the response can be stored only in a private cache (e.g. local caches in browsers).

Returns:

The Cache-Control Builder.

noStore

@NonNull
public @NonNull CacheControl.Builder noStore()

Returns:

The Cache-Control Builder.

noCache

@NonNull
public @NonNull CacheControl.Builder noCache()

Returns:

The Cache-Control Builder.

mustUnderstand

@NonNull
public @NonNull CacheControl.Builder mustUnderstand()

Returns:

The Cache-Control Builder.

noTransform

@NonNull
public @NonNull CacheControl.Builder noTransform()

Returns:

The Cache-Control Builder.

staleWhileRevalidate

@NonNull
public @NonNull CacheControl.Builder staleWhileRevalidate(@NonNull
 @NonNull Duration staleWhileRevalidate)

Parameters:

staleWhileRevalidate - Stale while revalidate duration

Returns:

The Cache-Control Builder.

staleWhileRevalidate

@NonNull
public @NonNull CacheControl.Builder staleWhileRevalidate(@NonNull
 @NonNull Long seconds)

Parameters:

seconds - Stale while revalidate seconds

Returns:

The Cache-Control Builder.

staleIfError

@NonNull
public @NonNull CacheControl.Builder staleIfError(@NonNull
 @NonNull Duration staleIfError)

Parameters:

staleIfError - Stale if error duration

Returns:

The Cache-Control Builder.

staleIfError

@NonNull
public @NonNull CacheControl.Builder staleIfError(@NonNull
 @NonNull Long seconds)

Parameters:

seconds - Stale if error seconds

Returns:

The Cache-Control Builder.

build

@NonNull
public @NonNull CacheControl build()

Returns:

A Cache-Control