Class StaticFiles.Builder

java.lang.Object

com.soklet.StaticFiles.Builder

Enclosing class:

StaticFiles

@NotThreadSafe
public static final class StaticFiles.Builder
extends Object

Author:

Mark Allen

Method Summary

Modifier and Type	Method	Description
@NonNull StaticFiles.Builder	accessResolver(@Nullable StaticFiles.AccessResolver accessResolver)	Sets the resolver used to decide whether resolved files are served, denied, or hidden.
@NonNull StaticFiles	build()
@NonNull StaticFiles.Builder	cacheControlResolver(@Nullable StaticFiles.CacheControlResolver cacheControlResolver)
@NonNull StaticFiles.Builder	entityTagResolver(@Nullable StaticFiles.EntityTagResolver entityTagResolver)
@NonNull StaticFiles.Builder	followSymlinks(@Nullable Boolean followSymlinks)
@NonNull StaticFiles.Builder	headersResolver(@Nullable StaticFiles.HeadersResolver headersResolver)
@NonNull StaticFiles.Builder	indexFileNames(@Nullable List<@NonNull String> indexFileNames)
@NonNull StaticFiles.Builder	lastModifiedResolver(@Nullable StaticFiles.LastModifiedResolver lastModifiedResolver)
@NonNull StaticFiles.Builder	mimeTypeResolver(@Nullable MimeTypeResolver mimeTypeResolver)	Sets the resolver used to produce Content-Type values.
@NonNull StaticFiles.Builder	rangeRequestsResolver(@Nullable StaticFiles.RangeRequestsResolver rangeRequestsResolver)

Methods inherited from class Object

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

Method Details

indexFileNames

public @NonNull StaticFiles.Builder indexFileNames(@Nullable List<@NonNull String> indexFileNames)

mimeTypeResolver

public @NonNull StaticFiles.Builder mimeTypeResolver(@Nullable MimeTypeResolver mimeTypeResolver)

Sets the resolver used to produce Content-Type values.

The configured resolver fully replaces the default resolver. Soklet's default resolver uses a curated deterministic set of common web-asset extensions, returns Optional.empty() for unknown extensions, and does not call Files.probeContentType(Path). Applications that need OS-level MIME database behavior can configure a resolver that calls Files.probeContentType(...) directly.

Parameters:

mimeTypeResolver - the resolver to use, or null to restore the default resolver

Returns:

this builder

entityTagResolver

public @NonNull StaticFiles.Builder entityTagResolver(@Nullable StaticFiles.EntityTagResolver entityTagResolver)

accessResolver

public @NonNull StaticFiles.Builder accessResolver(@Nullable StaticFiles.AccessResolver accessResolver)

Sets the resolver used to decide whether resolved files are served, denied, or hidden.

The access resolver runs after path safety, index-file resolution, symlink policy, readability, regular-file checks, and attribute reads, but before MIME, validator, cache-control, extra-header, and range-request resolvers. It receives the resolved file path, not the original request path.

Parameters:

accessResolver - the resolver to use, or null to restore the allow-all default

Returns:

this builder

lastModifiedResolver

public @NonNull StaticFiles.Builder lastModifiedResolver(@Nullable StaticFiles.LastModifiedResolver lastModifiedResolver)

cacheControlResolver

public @NonNull StaticFiles.Builder cacheControlResolver(@Nullable StaticFiles.CacheControlResolver cacheControlResolver)

headersResolver

public @NonNull StaticFiles.Builder headersResolver(@Nullable StaticFiles.HeadersResolver headersResolver)

rangeRequestsResolver

public @NonNull StaticFiles.Builder rangeRequestsResolver(@Nullable StaticFiles.RangeRequestsResolver rangeRequestsResolver)

followSymlinks

public @NonNull StaticFiles.Builder followSymlinks(@Nullable Boolean followSymlinks)

build

public @NonNull StaticFiles build()