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.
Header names are checked case-insensitively. Content-Length, Content-Range,
Accept-Ranges, Content-Type, Content-Encoding, Cache-Control,
ETag, Last-Modified, and Transfer-Encoding are managed by file responses
and must not be returned here. Use the builder's StaticFiles.Builder.mimeTypeResolver(MimeTypeResolver),
StaticFiles.Builder.cacheControlResolver(CacheControlResolver), StaticFiles.Builder.entityTagResolver(EntityTagResolver),
StaticFiles.Builder.lastModifiedResolver(LastModifiedResolver), or
StaticFiles.Builder.rangeRequestsResolver(RangeRequestsResolver) where applicable; framing is computed by the transport.
- Author:
- Mark Allen
-
Method Summary
Modifier and TypeMethodDescriptionReturns a resolver that emits no extra headers.Returns a resolver that always emits the supplied headers.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 List<@NonNull String>> headers) Returns a resolver that always emits the supplied headers.The header map and nested value sets are defensively copied. Managed headers listed on
StaticFiles.HeadersResolverare rejected immediately.- Parameters:
headers- the headers to emit- Returns:
- the constant headers resolver
- Throws:
IllegalArgumentException- if a header is controlled by file responses
-
disabledInstance
Returns a resolver that emits no extra headers.- Returns:
- the disabled headers resolver
-
headersFor
@NonNull Map<@NonNull String, @NonNull List<@NonNull String>> headersFor(@NonNull Path path, @NonNull BasicFileAttributes attributes) Resolves extra response headers for the file being served. Managed headers listed onStaticFiles.HeadersResolverare rejected when the response is produced.Implementations must be thread-safe;
StaticFilesinvokes resolvers concurrently from request-handling threads.- Parameters:
path- the resolved file path being servedattributes- the file attributes read for this response- Returns:
- extra headers to emit
-