Interface StaticFiles.CacheControlResolver

Enclosing class:

StaticFiles

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public static interface StaticFiles.CacheControlResolver

Resolves Cache-Control values for static-file responses.

Author:

Mark Allen

Method Summary

Modifier and Type	Method	Description
@NonNull Optional<String>	cacheControlFor(@NonNull Path path, @NonNull BasicFileAttributes attributes)	Resolves the Cache-Control value for the file being served.
static @NonNull StaticFiles.CacheControlResolver	disabledInstance()	Returns a resolver that omits Cache-Control.
static @NonNull StaticFiles.CacheControlResolver	fromValue(@NonNull String cacheControl)	Returns a resolver that always emits the supplied Cache-Control value.

Method Details

fromValue

static @NonNull StaticFiles.CacheControlResolver fromValue(@NonNull String cacheControl)

Returns a resolver that always emits the supplied Cache-Control value.

Parameters:

cacheControl - the cache-control value to emit

Returns:

the constant cache-control resolver

disabledInstance

static @NonNull StaticFiles.CacheControlResolver disabledInstance()

Returns a resolver that omits Cache-Control.

Returns:

the disabled cache-control resolver

cacheControlFor

@NonNull Optional<String> cacheControlFor(@NonNull Path path,
 @NonNull BasicFileAttributes attributes)

Resolves the Cache-Control value for the file being served.

Implementations must be thread-safe; StaticFiles invokes resolvers concurrently from request-handling threads.

Parameters:

path - the resolved file path being served

attributes - the file attributes read for this response

Returns:

the cache-control value to emit, or Optional.empty() to omit it