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

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	of(ClassLoader classLoader, String rootDir) Creates a new HttpVfs with the specified rootDir in the current class path.
static HttpVfs	of(File rootDir) Creates a new HttpVfs with the specified rootDir in an O/S file system.
static HttpVfs	of(Path rootDir) Creates a new HttpVfs with the specified rootDir in an O/S file system.
static HttpVfs	ofClassPath(ClassLoader classLoader, String rootDir) Deprecated. Use of(ClassLoader, String).
static HttpVfs	ofClassPath(String rootDir) Deprecated. Use of(ClassLoader, String).
static HttpVfs	ofFileSystem(Path rootDir) Deprecated. Use of(Path).
static HttpVfs	ofFileSystem(String rootDir) Deprecated. Use of(Path).

Method Detail

of

static HttpVfs of(File rootDir)

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

of

static HttpVfs of(Path rootDir)

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

of

static HttpVfs of(ClassLoader classLoader,
                  String rootDir)

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

ofFileSystem

@Deprecated
static HttpVfs ofFileSystem(String rootDir)

Deprecated. Use of(Path).

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

ofFileSystem

@Deprecated
static HttpVfs ofFileSystem(Path rootDir)

Deprecated. Use of(Path).

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

ofClassPath

@Deprecated
static HttpVfs ofClassPath(String rootDir)

Deprecated. Use of(ClassLoader, String).

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

ofClassPath

@Deprecated
static HttpVfs ofClassPath(ClassLoader classLoader,
                                       String rootDir)

Deprecated. Use of(ClassLoader, String).

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

get

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

Finds the file at the specified path.

Parameters:

path - an absolute path that starts with '/', 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 that starts with '/', 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 that starts with '/', 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.