Package com.linecorp.armeria.server.file

Class HttpFileService

java.lang.Object

com.linecorp.armeria.server.AbstractHttpService

com.linecorp.armeria.server.file.HttpFileService

All Implemented Interfaces:

HttpService, Service<HttpRequest,HttpResponse>

public final class HttpFileService
extends AbstractHttpService

An HttpService that serves static files from a file system.

See Also:

HttpFileServiceBuilder

Method Summary

Modifier and Type	Method	Description
HttpFileServiceConfig	config()	Returns the configuration.
protected HttpResponse	doGet(ServiceRequestContext ctx, HttpRequest req)	Handles a GET request.
static HttpFileService	forClassPath(ClassLoader classLoader, String rootDir)	Creates a new HttpFileService for the specified rootDir in the current class path.
static HttpFileService	forClassPath(String rootDir)	Creates a new HttpFileService for the specified rootDir in the current class path.
static HttpFileService	forFileSystem(String rootDir)	Creates a new HttpFileService for the specified rootDir in an O/S file system.
static HttpFileService	forFileSystem(Path rootDir)	Creates a new HttpFileService for the specified rootDir in an O/S file system.
static HttpFileService	forVfs(HttpVfs vfs)	Creates a new HttpFileService for the specified HttpVfs.
HttpService	orElse(Service<HttpRequest,HttpResponse> nextService)	Creates a new HttpService that tries this HttpFileService first and then the specified HttpService when this HttpFileService does not have a requested resource.
void	serviceAdded(ServiceConfig cfg)	Invoked when this Service has been added to a Server with the specified configuration.
boolean	shouldCachePath(String path, String query, PathMapping pathMapping)	Returns whether the given path and query should be cached if the service's result is successful.

Methods inherited from class com.linecorp.armeria.server.AbstractHttpService

doDelete, doDelete, doGet, doHead, doHead, doOptions, doOptions, doPatch, doPatch, doPost, doPost, doPut, doPut, doTrace, doTrace, serve

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.linecorp.armeria.server.Service

as, decorate, decorate, decorate

Method Detail

forFileSystem

public static HttpFileService forFileSystem(String rootDir)

Creates a new HttpFileService for the specified rootDir in an O/S file system.

forFileSystem

public static HttpFileService forFileSystem(Path rootDir)

Creates a new HttpFileService for the specified rootDir in an O/S file system.

forClassPath

public static HttpFileService forClassPath(String rootDir)

Creates a new HttpFileService for the specified rootDir in the current class path.

forClassPath

public static HttpFileService forClassPath(ClassLoader classLoader,
                                           String rootDir)

Creates a new HttpFileService for the specified rootDir in the current class path.

forVfs

public static HttpFileService forVfs(HttpVfs vfs)

Creates a new HttpFileService for the specified HttpVfs.

serviceAdded

public void serviceAdded(ServiceConfig cfg)
                  throws Exception

Description copied from interface: Service

Invoked when this Service has been added to a Server with the specified configuration. Please note that this method can be invoked more than once if this Service has been added more than once.

Throws:

Exception

shouldCachePath

public boolean shouldCachePath(String path,
                               @Nullable
                               String query,
                               PathMapping pathMapping)

Description copied from interface: Service

Returns whether the given path and query should be cached if the service's result is successful. By default, exact path mappings with no input query are cached.

config

public HttpFileServiceConfig config()

Returns the configuration.

doGet

protected HttpResponse doGet(ServiceRequestContext ctx,
                             HttpRequest req)

Description copied from class: AbstractHttpService

Handles a GET request. This method sends a 405 Method Not Allowed response by default.

Overrides:

doGet in class AbstractHttpService

orElse

public HttpService orElse(Service<HttpRequest,HttpResponse> nextService)

Creates a new HttpService that tries this HttpFileService first and then the specified HttpService when this HttpFileService does not have a requested resource.

Parameters:

nextService - the HttpService to try secondly