bayou.file

Class FileHttpEntity

java.lang.Object

bayou.file.FileHttpEntity

All Implemented Interfaces:

HttpEntity

public class FileHttpEntity
extends Object
implements HttpEntity

An HttpEntity based on a file.

The body of the entity is the content of the file.

This is a sharable entity.

Constructor Summary

Constructors

Constructor and Description
FileHttpEntity(Path filePath, ContentType contentType) Create an FileHttpEntity over the file specified by `filePath`.

Method Summary

Instance Methods
ByteSource	body() The body of the entity, same as the content of the file.
ContentType	contentType() The content type.
Long	contentLength() Return the size of the file.
Instant	lastModified() Return the last modified time of the file.

Methods inherited from class java.lang.Object

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

Methods inherited from interface bayou.http.HttpEntity

bodyBytes, bodyString, contentEncoding, etag, etagIsWeak, expires

Constructor Detail

FileHttpEntity

public FileHttpEntity(Path filePath,
                      ContentType contentType)
               throws Exception

Create an FileHttpEntity over the file specified by `filePath`.

If contentType==null, we'll use FileSuffixToContentType.getGlobalInstance() to get the content type from the file suffix.

CAUTION: this constructor reads file metadata from OS, which may involve blocking IO operations.

Throws:

Exception

Method Detail

body

public ByteSource body()

The body of the entity, same as the content of the file.

Specified by:

body in interface HttpEntity

contentType

public ContentType contentType()

The content type.

Specified by:

contentType in interface HttpEntity

contentLength

public Long contentLength()

Return the size of the file.

Specified by:

contentLength in interface HttpEntity

lastModified

public Instant lastModified()

Return the last modified time of the file.

Specified by:

lastModified in interface HttpEntity