com.linecorp.armeria.server.file

Interface HttpVfs

All Known Implementing Classes:

AbstractHttpVfs

public interface HttpVfs

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

Method Summary

Modifier and Type	Method and Description
boolean	canList(String path) Returns whether the file at the specified path is a directory.
HttpFile	get(String path, Clock clock, String contentEncoding, HttpHeaders additionalHeaders) Finds the file at the specified path.
List<String>	list(String path) Lists the files at the specified directory path non-recursively.
String	meterTag() Returns the value of the "vfs" Tag in a Meter.
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

HttpFile get(String path,
             Clock clock,
             @Nullable
             String contentEncoding,
             HttpHeaders additionalHeaders)

Finds the file at the specified path.

Parameters:

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

clock - the Clock which provides the current date and time

contentEncoding - the desired 'content-encoding' header value of the file. null to omit the header.

additionalHeaders - the additional HTTP headers to add to the returned HttpFile.

Returns:

the HttpFile at the specified path

canList

boolean canList(String path)

Returns whether the file at the specified path is a directory.

Parameters:

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

Returns:

true if the file is a directory. false if the directory does not exist or the file listing is not available.

list

List<String> list(String path)

Lists the files at the specified directory path non-recursively.

Parameters:

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

Returns:

the list of the file names. If the file is a directory, the file name will end with '/'. If the directory does not exist or the file listing is not available, an empty List is returned.

meterTag

String meterTag()

Returns the value of the "vfs" Tag in a Meter.