HttpFile (filter-service-metrics 1.12 1.12 API)

All Known Subinterfaces:: AggregatedHttpFile

All Known Implementing Classes:: AbstractHttpFile, StreamingHttpFile

public interface HttpFile

A file-like HTTP resource which yields an HttpResponse.


 HttpFile faviconFile = HttpFile.of(new File("/var/www/favicon.ico"));
 ServerBuilder builder = Server.builder();
 builder.service("/favicon.ico", faviconFile.asService());
 Server server = builder.build();

See Also:: HttpFileBuilder

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`CompletableFuture<AggregatedHttpFile>`	`aggregate(Executor fileReadExecutor)` Converts this file into an `AggregatedHttpFile`.
`CompletableFuture<AggregatedHttpFile>`	`aggregateWithPooledObjects(Executor fileReadExecutor, io.netty.buffer.ByteBufAllocator alloc)` Converts this file into an `AggregatedHttpFile`.
`HttpService`	`asService()` Returns an `HttpService` which serves the file for `HEAD` and `GET` requests.
`static AggregatedHttpFile`	`nonExistent()` Returns an `AggregatedHttpFile` which represents a non-existent file.
`static HttpFile`	`of(File file)` Creates a new `HttpFile` which streams the specified `File`.
`static AggregatedHttpFile`	`of(HttpData data)` Creates a new `AggregatedHttpFile` which streams the specified `HttpData`.
`static AggregatedHttpFile`	`of(HttpData data, long lastModifiedMillis)` Creates a new `AggregatedHttpFile` which streams the specified `HttpData` with the specified `lastModifiedMillis`.
`static HttpFile`	`of(Path path)` Creates a new `HttpFile` which streams the file at the specified `Path`.
`static HttpFile`	`ofCached(HttpFile file, int maxCachingLength)` Creates a new `HttpFile` which caches the content and attributes of the specified `HttpFile`.
`static HttpFile`	`ofResource(ClassLoader classLoader, String path)` Creates a new `HttpFile` which streams the resource at the specified `path`, loaded by the specified `ClassLoader`.
`static HttpFile`	`ofResource(String path)` Creates a new `HttpFile` which streams the resource at the specified `path`.
`HttpResponse`	`read(Executor fileReadExecutor, io.netty.buffer.ByteBufAllocator alloc)` Starts to stream this file into the returned `HttpResponse`.
`HttpFileAttributes`	`readAttributes()` Retrieves the attributes of this file.
`ResponseHeaders`	`readHeaders()` Reads the attributes of this file as `ResponseHeaders`, which could be useful for building a response for a `HEAD` request.

- Method Detail
  - of
```
static HttpFile of(File file)
```
    Creates a new HttpFile which streams the specified File.
  - of
```
static HttpFile of(Path path)
```
    Creates a new HttpFile which streams the file at the specified Path.
  - of
```
static AggregatedHttpFile of(HttpData data)
```
    Creates a new AggregatedHttpFile which streams the specified HttpData. This method is a shortcut of HttpFile.of(data, System.currentTimeMillis().
  - of
```
static AggregatedHttpFile of(HttpData data,
                             long lastModifiedMillis)
```
    Creates a new AggregatedHttpFile which streams the specified HttpData with the specified lastModifiedMillis.
    
    Parameters:
    
    data - the data that provides the content of an HTTP response
    
    lastModifiedMillis - when the data has been last modified, represented as the number of millisecond since the epoch
  - ofResource
```
static HttpFile ofResource(String path)
```
    Creates a new HttpFile which streams the resource at the specified path. This method is a shortcut of HttpFile.of(HttpFile.class.getClassLoader(), path).
  - ofResource
```
static HttpFile ofResource(ClassLoader classLoader,
                           String path)
```
    Creates a new HttpFile which streams the resource at the specified path, loaded by the specified ClassLoader.
    
    Parameters:
    
    classLoader - the ClassLoader which will load the resource at the path
    
    path - the path to the resource
  - ofCached
```
static HttpFile ofCached(HttpFile file,
                         int maxCachingLength)
```
    Creates a new HttpFile which caches the content and attributes of the specified HttpFile. The cache is automatically invalidated when the HttpFile is updated.
    
    Parameters:
    
    file - the HttpFile to cache
    
    maxCachingLength - the maximum allowed length of the HttpFile to cache. if the length of the HttpFile exceeds this value, no caching will be performed.
  - nonExistent
```
static AggregatedHttpFile nonExistent()
```
    Returns an AggregatedHttpFile which represents a non-existent file.
  - readAttributes
```
@Nullable
HttpFileAttributes readAttributes()
                                     throws IOException
```
    Retrieves the attributes of this file.
    
    Returns:
    
    the attributes of this file, or null if the file does not exist.
    
    Throws:
    
    IOException - if failed to retrieve the attributes of this file.
  - readHeaders
```
@Nullable
ResponseHeaders readHeaders()
                               throws IOException
```
    Reads the attributes of this file as ResponseHeaders, which could be useful for building a response for a HEAD request.
    
    Returns:
    
    the headers, or null if the file does not exist.
    
    Throws:
    
    IOException - if failed to retrieve the attributes of this file.
  - read
```
@Nullable
HttpResponse read(Executor fileReadExecutor,
                            io.netty.buffer.ByteBufAllocator alloc)
```
    Starts to stream this file into the returned HttpResponse.
    
    Parameters:
    
    fileReadExecutor - the Executor which will perform the read operations against the file
    
    alloc - the ByteBufAllocator which will allocate the buffers that hold the content of the file
    
    Returns:
    
    the response, or null if the file does not exist.
  - aggregate
```
CompletableFuture<AggregatedHttpFile> aggregate(Executor fileReadExecutor)
```
    Converts this file into an AggregatedHttpFile.
    
    Parameters:
    
    fileReadExecutor - the Executor which will perform the read operations against the file
    
    Returns:
    
    a CompletableFuture which will complete when the aggregation process is finished, or a CompletableFuture successfully completed with this, if this file is already an AggregatedHttpFile.
  - aggregateWithPooledObjects
```
CompletableFuture<AggregatedHttpFile> aggregateWithPooledObjects(Executor fileReadExecutor,
                                                                 io.netty.buffer.ByteBufAllocator alloc)
```
    Converts this file into an AggregatedHttpFile. AggregatedHttpFile.content() will return a pooled object, and the caller must ensure to release it. If you don't know what this means, use aggregate(Executor).
    
    Parameters:
    
    fileReadExecutor - the Executor which will perform the read operations against the file
    
    alloc - the ByteBufAllocator which will allocate the content buffer
    
    Returns:
    
    a CompletableFuture which will complete when the aggregation process is finished, or a CompletableFuture successfully completed with this, if this file is already an AggregatedHttpFile.
  - asService
```
HttpService asService()
```
    Returns an HttpService which serves the file for HEAD and GET requests.

Interface HttpFile

Method Summary

Method Detail

of

of

of

of

ofResource

ofResource

ofCached

nonExistent

readAttributes

readHeaders

read

aggregate

aggregateWithPooledObjects

asService