HttpFileBuilder (filter-service-metrics 1.13 1.13 API)

java.lang.Object
- com.linecorp.armeria.server.file.AbstractHttpFileBuilder
- - com.linecorp.armeria.server.file.HttpFileBuilder

public abstract class HttpFileBuilder
extends AbstractHttpFileBuilder

Builds an HttpFile from a file, a classpath resource or an HttpData.


 // Build from a file.
 HttpFile f = HttpFile.builder(Paths.get("/var/www/index.html"))
                      .lastModified(false)
                      .setHeader(HttpHeaderNames.CONTENT_LANGUAGE, "en-US")
                      .build();

 // Build from a classpath resource.
 HttpFile f = HttpFile.builder(MyClass.class.getClassLoader(), "/foo.txt.gz")
                      .setHeader(HttpHeaderNames.CONTENT_ENCODING, "gzip")
                      .build();

 // Build from an HttpData. Can be downcast into AggregatedHttpFile.
 AggregatedHttpFile f = (AggregatedHttpFile)
         HttpFile.builder(HttpData.ofUtf8("content"), System.currentTimeMillis())
                 .entityTag((pathOrUri, attrs) -> "myCustomEntityTag")
                 .build();

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`HttpFileBuilder`	`addHeader(CharSequence name, Object value)` Adds the specified HTTP header.
`HttpFileBuilder`	`addHeaders(Iterable<? extends Map.Entry<? extends CharSequence,?>> headers)` Adds the specified HTTP headers.
`HttpFileBuilder`	`autoDetectedContentType(boolean contentTypeAutoDetectionEnabled)` Sets whether to set the `"content-type"` header automatically based on the extension of the file.
`abstract HttpFile`	`build()` Returns a newly created `HttpFile` with the properties configured so far.
`HttpFileBuilder`	`cacheControl(CacheControl cacheControl)` Sets the `"cache-control"` header.
`HttpFileBuilder`	`cacheControl(CharSequence cacheControl)` Sets the `"cache-control"` header.
`HttpFileBuilder`	`clock(Clock clock)` Sets the `Clock` that provides the current date and time.
`HttpFileBuilder`	`contentType(CharSequence contentType)` Sets the `"content-type"` header.
`HttpFileBuilder`	`contentType(MediaType contentType)` Sets the `"content-type"` header.
`HttpFileBuilder`	`date(boolean dateEnabled)` Sets whether to set the `"date"` header automatically.
`HttpFileBuilder`	`entityTag(BiFunction<String,HttpFileAttributes,String> entityTagFunction)` Sets the function which generates the entity tag that's used for setting the `"etag"` header automatically.
`HttpFileBuilder`	`entityTag(boolean enabled)` Sets whether to set the `"etag"` header automatically based on the path and attributes of the file.
`HttpFileBuilder`	`lastModified(boolean lastModifiedEnabled)` Sets whether to set the `"last-modified"` header automatically.
`static HttpFileBuilder`	`of(File file)` Deprecated. Use `HttpFile.builder(File)`.
`static HttpFileBuilder`	`of(HttpData data)` Deprecated. Use `HttpFile.builder(HttpData)`.
`static HttpFileBuilder`	`of(HttpData data, long lastModifiedMillis)` Deprecated. Use `HttpFile.builder(HttpData, long)`.
`static HttpFileBuilder`	`of(Path path)` Deprecated. Use `HttpFile.builder(Path)`.
`static HttpFileBuilder`	`ofResource(ClassLoader classLoader, String path)` Deprecated. Use `HttpFile.builder(ClassLoader, String)`.
`static HttpFileBuilder`	`ofResource(String path)` Deprecated. Use `HttpFile.builder(ClassLoader, String)`.
`HttpFileBuilder`	`setHeader(CharSequence name, Object value)` Sets the specified HTTP header.
`HttpFileBuilder`	`setHeaders(Iterable<? extends Map.Entry<? extends CharSequence,?>> headers)` Sets the specified HTTP headers.

Methods inherited from class com.linecorp.armeria.server.file.AbstractHttpFileBuilder
buildHeaders, clock, entityTagFunction, isContentTypeAutoDetectionEnabled, isDateEnabled, isLastModifiedEnabled

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - of
```
@Deprecated
public static HttpFileBuilder of(File file)
```
    Deprecated. Use HttpFile.builder(File).
    
    Returns a new HttpFileBuilder that builds an HttpFile from the specified File.
  - of
```
@Deprecated
public static HttpFileBuilder of(Path path)
```
    Deprecated. Use HttpFile.builder(Path).
    
    Returns a new HttpFileBuilder that builds an HttpFile from the file at the specified Path.
  - of
```
@Deprecated
public static HttpFileBuilder of(HttpData data)
```
    Deprecated. Use HttpFile.builder(HttpData).
    Returns a new HttpFileBuilder that builds an AggregatedHttpFile from the specified HttpData. The last modified date of the file is set to 'now'. Note that the build() method of the returned builder will always return an AggregatedHttpFile, which guarantees a safe downcast:
```
 AggregatedHttpFile f = (AggregatedHttpFile) HttpFile.builder(HttpData.ofUtf8("foo")).build();
 
```
  - of
```
@Deprecated
public static HttpFileBuilder of(HttpData data,
                                             long lastModifiedMillis)
```
    Deprecated. Use HttpFile.builder(HttpData, long).
    Returns a new HttpFileBuilder that builds an AggregatedHttpFile from the specified HttpData and lastModifiedMillis. Note that the build() method of the returned builder will always return an AggregatedHttpFile, which guarantees a safe downcast:
```
 AggregatedHttpFile f = (AggregatedHttpFile) HttpFile.builder(HttpData.ofUtf8("foo"), 1546923055020)
                                                     .build();
 
```
    Parameters:
    
    data - the content of the file
    
    lastModifiedMillis - the last modified time represented as the number of milliseconds since the epoch
  - ofResource
```
@Deprecated
public static HttpFileBuilder ofResource(String path)
```
    Deprecated. Use HttpFile.builder(ClassLoader, String).
    
    Returns a new HttpFileBuilder that builds an HttpFile from the classpath resource at the specified path. This method is a shortcut for HttpFile.builder(HttpFile.class.getClassLoader(), path).
  - ofResource
```
@Deprecated
public static HttpFileBuilder ofResource(ClassLoader classLoader,
                                                     String path)
```
    Deprecated. Use HttpFile.builder(ClassLoader, String).
    
    Returns a new HttpFileBuilder that builds an HttpFile from the classpath resource at the specified path using the specified ClassLoader.
  - build
```
public abstract HttpFile build()
```
    Returns a newly created HttpFile with the properties configured so far. If this builder was created with HttpFile.builder(HttpData) or HttpFile.builder(HttpData, long), the returned instance will always be an AggregatedHttpFile.
  - clock
```
public HttpFileBuilder clock(Clock clock)
```
    Description copied from class: AbstractHttpFileBuilder
    
    Sets the Clock that provides the current date and time. By default, Clock.systemUTC() is used.
    
    Overrides:
    
    clock in class AbstractHttpFileBuilder
  - date
```
public HttpFileBuilder date(boolean dateEnabled)
```
    Description copied from class: AbstractHttpFileBuilder
    
    Sets whether to set the "date" header automatically. By default, the "date" header is set automatically.
    
    Overrides:
    
    date in class AbstractHttpFileBuilder
  - lastModified
```
public HttpFileBuilder lastModified(boolean lastModifiedEnabled)
```
    Description copied from class: AbstractHttpFileBuilder
    
    Sets whether to set the "last-modified" header automatically. By default, the "last-modified" is set automatically.
    
    Overrides:
    
    lastModified in class AbstractHttpFileBuilder
  - autoDetectedContentType
```
public HttpFileBuilder autoDetectedContentType(boolean contentTypeAutoDetectionEnabled)
```
    Description copied from class: AbstractHttpFileBuilder
    
    Sets whether to set the "content-type" header automatically based on the extension of the file. By default, the "content-type" header is set automatically.
    
    Overrides:
    
    autoDetectedContentType in class AbstractHttpFileBuilder
  - entityTag
```
public HttpFileBuilder entityTag(boolean enabled)
```
    Description copied from class: AbstractHttpFileBuilder
    
    Sets whether to set the "etag" header automatically based on the path and attributes of the file. By default, the "etag" header is set automatically. Use AbstractHttpFileBuilder.entityTag(BiFunction) to customize how an entity tag is generated.
    
    Overrides:
    
    entityTag in class AbstractHttpFileBuilder
  - entityTag
```
public HttpFileBuilder entityTag(BiFunction<String,HttpFileAttributes,String> entityTagFunction)
```
    Description copied from class: AbstractHttpFileBuilder
    
    Sets the function which generates the entity tag that's used for setting the "etag" header automatically.
    
    Overrides:
    
    entityTag in class AbstractHttpFileBuilder
    
    Parameters:
    
    entityTagFunction - the entity tag function that generates the entity tag, or null to disable setting the "etag" header.
  - addHeader
```
public HttpFileBuilder addHeader(CharSequence name,
                                 Object value)
```
    Description copied from class: AbstractHttpFileBuilder
    
    Adds the specified HTTP header.
    
    Overrides:
    
    addHeader in class AbstractHttpFileBuilder
  - addHeaders
```
public HttpFileBuilder addHeaders(Iterable<? extends Map.Entry<? extends CharSequence,?>> headers)
```
    Description copied from class: AbstractHttpFileBuilder
    
    Adds the specified HTTP headers.
    
    Overrides:
    
    addHeaders in class AbstractHttpFileBuilder
  - setHeader
```
public HttpFileBuilder setHeader(CharSequence name,
                                 Object value)
```
    Description copied from class: AbstractHttpFileBuilder
    
    Sets the specified HTTP header.
    
    Overrides:
    
    setHeader in class AbstractHttpFileBuilder
  - setHeaders
```
public HttpFileBuilder setHeaders(Iterable<? extends Map.Entry<? extends CharSequence,?>> headers)
```
    Description copied from class: AbstractHttpFileBuilder
    
    Sets the specified HTTP headers.
    
    Overrides:
    
    setHeaders in class AbstractHttpFileBuilder
  - contentType
```
public HttpFileBuilder contentType(MediaType contentType)
```
    Description copied from class: AbstractHttpFileBuilder
    Sets the "content-type" header. This method is a shortcut for:
```
 builder.autoDetectedContentType(false);
 builder.setHeader(HttpHeaderNames.CONTENT_TYPE, contentType);
 
```
    Overrides:
    
    contentType in class AbstractHttpFileBuilder
  - contentType
```
public HttpFileBuilder contentType(CharSequence contentType)
```
    Description copied from class: AbstractHttpFileBuilder
    Sets the "content-type" header. This method is a shortcut for:
```
 builder.autoDetectedContentType(false);
 builder.setHeader(HttpHeaderNames.CONTENT_TYPE, contentType);
 
```
    Overrides:
    
    contentType in class AbstractHttpFileBuilder
  - cacheControl
```
public HttpFileBuilder cacheControl(CacheControl cacheControl)
```
    Description copied from class: AbstractHttpFileBuilder
    Sets the "cache-control" header. This method is a shortcut for:
```
 builder.setHeader(HttpHeaderNames.CACHE_CONTROL, cacheControl);
 
```
    Overrides:
    
    cacheControl in class AbstractHttpFileBuilder
  - cacheControl
```
public HttpFileBuilder cacheControl(CharSequence cacheControl)
```
    Description copied from class: AbstractHttpFileBuilder
    Sets the "cache-control" header. This method is a shortcut for:
```
 builder.setHeader(HttpHeaderNames.CACHE_CONTROL, cacheControl);
 
```
    Overrides:
    
    cacheControl in class AbstractHttpFileBuilder

Class HttpFileBuilder

Method Summary

Methods inherited from class com.linecorp.armeria.server.file.AbstractHttpFileBuilder

Methods inherited from class java.lang.Object

Method Detail

of

of

of

of

ofResource

ofResource

build

clock

date

lastModified

autoDetectedContentType

entityTag

entityTag

addHeader

addHeaders

setHeader

setHeaders

contentType

contentType

cacheControl

cacheControl