Interface StaticFiles.HeadersResolver

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.HeadersResolver

Resolves extra response headers for static-file responses.

Author:

Mark Allen

Method Summary

Modifier and Type	Method	Description
static @NonNull StaticFiles.HeadersResolver	disabledInstance()	Returns a resolver that emits no extra headers.
static @NonNull StaticFiles.HeadersResolver	fromHeaders(@NonNull Map<@NonNull String, @NonNull Set<@NonNull String>> headers)	Returns a resolver that always emits the supplied headers.
@NonNull Map<@NonNull String, @NonNull Set<@NonNull String>>	headersFor(@NonNull Path path, @NonNull BasicFileAttributes attributes)	Resolves extra response headers for the file being served.

Method Details

fromHeaders

static @NonNull StaticFiles.HeadersResolver fromHeaders(@NonNull Map<@NonNull String, @NonNull Set<@NonNull String>> headers)

Returns a resolver that always emits the supplied headers.

The header map and nested value sets are defensively copied.

Parameters:

headers - the headers to emit

Returns:

the constant headers resolver

disabledInstance

static @NonNull StaticFiles.HeadersResolver disabledInstance()

Returns a resolver that emits no extra headers.

Returns:

the disabled headers resolver

headersFor

@NonNull Map<@NonNull String, @NonNull Set<@NonNull String>> headersFor(@NonNull Path path,
 @NonNull BasicFileAttributes attributes)

Resolves extra response headers 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:

extra headers to emit