FileService (filter-service-metrics 1.13 1.13 API)

java.lang.Object
- com.linecorp.armeria.server.AbstractHttpService
- - com.linecorp.armeria.server.file.FileService

All Implemented Interfaces:

Unwrappable, HttpService, Service<HttpRequest,HttpResponse>

Direct Known Subclasses:

HttpFileService
```
public class FileService
extends AbstractHttpService
```
An HttpService that serves static files from a file system.

See Also:

FileServiceBuilder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static FileServiceBuilder`	`builder(ClassLoader classLoader, String rootDir)` Returns a new `FileServiceBuilder` with the specified `rootDir` in the current class path.
`static FileServiceBuilder`	`builder(File rootDir)` Returns a new `FileServiceBuilder` with the specified `rootDir` in an O/S file system.
`static FileServiceBuilder`	`builder(HttpVfs vfs)` Returns a new `FileServiceBuilder` with the specified `HttpVfs`.
`static FileServiceBuilder`	`builder(Path rootDir)` Returns a new `FileServiceBuilder` with the specified `rootDir` in an O/S file system.
`FileServiceConfig`	`config()` Returns the configuration.
`protected HttpResponse`	`doGet(ServiceRequestContext ctx, HttpRequest req)` Handles a `GET` request.
`static FileService`	`of(ClassLoader classLoader, String rootDir)` Returns a new `FileService` for the specified `rootDir` in the current class path.
`static FileService`	`of(File rootDir)` Returns a new `FileService` for the specified `rootDir` in an O/S file system.
`static FileService`	`of(HttpVfs vfs)` Returns a new `FileService` for the specified `HttpVfs`.
`static FileService`	`of(Path rootDir)` Returns a new `FileService` for the specified `rootDir` in an O/S file system.
`HttpService`	`orElse(HttpService nextService)` Creates a new `HttpService` that tries this `FileService` first and then the specified `HttpService` when this `FileService` 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, Route route)` 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.HttpService
decorate, decorate

Methods inherited from interface com.linecorp.armeria.server.Service
as, decorate

- Method Detail
  - of
```
public static FileService of(File rootDir)
```
    Returns a new FileService for the specified rootDir in an O/S file system.
  - of
```
public static FileService of(Path rootDir)
```
    Returns a new FileService for the specified rootDir in an O/S file system.
  - of
```
public static FileService of(ClassLoader classLoader,
                             String rootDir)
```
    Returns a new FileService for the specified rootDir in the current class path.
  - of
```
public static FileService of(HttpVfs vfs)
```
    Returns a new FileService for the specified HttpVfs.
  - builder
```
public static FileServiceBuilder builder(File rootDir)
```
    Returns a new FileServiceBuilder with the specified rootDir in an O/S file system.
  - builder
```
public static FileServiceBuilder builder(Path rootDir)
```
    Returns a new FileServiceBuilder with the specified rootDir in an O/S file system.
  - builder
```
public static FileServiceBuilder builder(ClassLoader classLoader,
                                         String rootDir)
```
    Returns a new FileServiceBuilder with the specified rootDir in the current class path.
  - builder
```
public static FileServiceBuilder builder(HttpVfs vfs)
```
    Returns a new FileServiceBuilder with 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,
                               String query,
                               Route route)
```
    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 FileServiceConfig config()
```
    Returns the configuration.
  - doGet
```
protected HttpResponse doGet(ServiceRequestContext ctx,
                             HttpRequest req)
                      throws Exception
```
    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
    
    Throws:
    
    Exception
  - orElse
```
public HttpService orElse(HttpService nextService)
```
    Creates a new HttpService that tries this FileService first and then the specified HttpService when this FileService does not have a requested resource.
    
    Parameters:
    
    nextService - the HttpService to try secondly

Class FileService

Method Summary

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

Methods inherited from class java.lang.Object

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

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

Method Detail

of

of

of

of

builder

builder

builder

builder

serviceAdded

shouldCachePath

config

doGet

orElse