Interface StaticFiles.AccessResolver

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

Resolves whether a resolved static file should be served, denied, or hidden.

Author:

Mark Allen

Method Summary

Modifier and Type	Method	Description
@NonNull StaticFiles.Access	accessFor(@NonNull Path path, @NonNull BasicFileAttributes attributes)	Resolves static-file access for the file being served.
static @NonNull StaticFiles.AccessResolver	allowAllInstance()	Returns a resolver that allows all resolved static files.

Method Details

allowAllInstance

static @NonNull StaticFiles.AccessResolver allowAllInstance()

Returns a resolver that allows all resolved static files.

Returns:

the allow-all access resolver

accessFor

@NonNull StaticFiles.Access accessFor(@NonNull Path path,
 @NonNull BasicFileAttributes attributes)

Resolves static-file access for the file being served.

Implementations must be thread-safe; StaticFiles invokes resolvers concurrently from request-handling threads. This resolver is intentionally path- and attribute-based. For request-aware access decisions, gate StaticFiles.marshaledResponseFor(String, Request) from the resource method or another higher application layer.

Parameters:

path - the resolved file path being served

attributes - the file attributes read for this response

Returns:

the access outcome