com.linecorp.armeria.server.file

Interface HttpVfs

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 interface HttpVfs

A virtual file system that provides the files requested by HttpFileService.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	HttpVfs.AbstractEntry A skeletal HttpVfs.Entry implementation.
static class	HttpVfs.ByteArrayEntry An HttpVfs.Entry whose content is backed by a byte array.
static interface	HttpVfs.Entry A file entry in an HttpVfs.

Method Summary

Modifier and Type	Method and Description
HttpVfs.Entry	get(String path, String contentEncoding) Finds the file at the specified path.
static HttpVfs	ofClassPath(ClassLoader classLoader, String rootDir) Creates a new HttpVfs with the specified rootDir in the current class path.
static HttpVfs	ofClassPath(String rootDir) Creates a new HttpVfs with the specified rootDir in the current class path.
static HttpVfs	ofFileSystem(Path rootDir) Creates a new HttpVfs with the specified rootDir in an O/S file system.
static HttpVfs	ofFileSystem(String rootDir) Creates a new HttpVfs with the specified rootDir in an O/S file system.

Method Detail

ofFileSystem

static HttpVfs ofFileSystem(String rootDir)

Creates a new HttpVfs with the specified rootDir in an O/S file system.

ofFileSystem

static HttpVfs ofFileSystem(Path rootDir)

Creates a new HttpVfs with the specified rootDir in an O/S file system.

ofClassPath

static HttpVfs ofClassPath(String rootDir)

Creates a new HttpVfs with the specified rootDir in the current class path.

ofClassPath

static HttpVfs ofClassPath(ClassLoader classLoader,
                           String rootDir)

Creates a new HttpVfs with the specified rootDir in the current class path.

get

HttpVfs.Entry get(String path,
                  @Nullable
                  String contentEncoding)

Finds the file at the specified path.

Parameters:

path - an absolute path whose component separator is '/'

contentEncoding - the content encoding of the file. Will be non-null for precompressed resources

Returns:

the HttpVfs.Entry of the file at the specified path if found. HttpVfs.Entry.NONE if not found.