Serves files from a directory on the filesystem.

See the constructor for usage.

Inheritance

Constructors

HTTPFileController(String pathOfDirectoryToServe, { Future<Response> onFileNotFound(HTTPFileController controller, Request req) })

Creates an instance of this type that serves files from pathOfDirectoryToServe.

Properties

documentableChild APIDocumentable

@override, read-only, inherited
hashCode → int

The hash code for this object.

read-only, inherited
logger Logger

read-only, inherited
nextController RequestController

read / write, inherited
policy CORSPolicy

The CORS policy of this controller.

read / write, inherited
runtimeType → Type

A representation of the runtime type of the object.

read-only, inherited

Operators

operator ==(other) → bool

The equality operator.

inherited

Methods

addCachePolicy(HTTPCachePolicy policy, bool shouldApplyToPath(String path)) → void

Add a cache policy for file paths that return true for shouldApplyToPath.

cachePolicyForPath(String path) HTTPCachePolicy

Returns the HTTPCachePolicy for path.

contentTypeForExtension(String extension) → ContentType

Returns a ContentType for a file extension.

processRequest(Request request) → Future<RequestOrResponse>

Overridden by subclasses to modify or respond to an incoming request.

setContentTypeForExtension(String extension, ContentType contentType) → void

Sets the associated content type for a file extension.

applyCORSHeadersIfNecessary(Request req, Response resp) → void

inherited
documentAPI(PackagePathResolver resolver) APIDocument

Returns an entire APIDocument describing an OpenAPI specification.

inherited
documentOperations(PackagePathResolver resolver) → List<APIOperation>

Returns all APIOperations this object knows about.

inherited
documentPaths(PackagePathResolver resolver) → List<APIPath>

Returns all APIPath objects this instance knows about.

inherited
documentRequestBodyForOperation(APIOperation operation) APIRequestBody

Returns all APIRequestBodys for operation.

inherited
documentResponsesForOperation(APIOperation operation) → List<APIResponse>

Returns all APIResponses for operation.

inherited
documentSecuritySchemes(PackagePathResolver resolver) → Map<String, APISecurityScheme>

Returns all APISecuritySchemes this instance knows about.

inherited
generate(RequestController generatorFunction()) RequestController

A function that instantiates a RequestController to pass a Request to if this instance returns a Request from processRequest.

inherited
handleError(Request request, caughtValue, StackTrace trace) → Future<bool>

Sends an HTTP response for a request that yields an exception or error.

inherited
listen(Future<RequestOrResponse> requestControllerFunction(Request request)) RequestController

A closure that responds to or forwards a Request.

inherited
noSuchMethod(Invocation invocation) → dynamic

Invoked when a non-existent method or property is accessed.

inherited
pipe(RequestController n) RequestController

The next RequestController to pass a Request to if this instance returns a Request from processRequest.

inherited
receive(Request req) → Future

The mechanism for delivering a Request to this controller for processing.

inherited
toString() → String

Returns a string representation of this object.

inherited
willSendResponse(Response response) → void

Executed prior to Response being sent.

inherited