A RequestController for routes in a Router.

When adding a route to a Router (Router.route), an instance of this type is returned. Subsequent RequestControllers can be chained off instances of this class and will only be reached when a reqeust matches this instance's pattern. Do not create instances of this class manually.

Inheritance

Constructors

RouteController(List<RouteSpecification> patterns)

Do not create instances of this class manually.

Properties

patterns → List<RouteSpecification>

Route specifications for this controller.

final
documentableChild APIDocumentable

@override, read-only, inherited
hashCode → int

The hash code for this object.

read-only, inherited
logger Logger

An instance of the 'aqueduct' logger.

read-only, inherited
nextController RequestController

Receives requests that this controller does not respond to.

read-only, 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

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 instantiator()) RequestController

Sets the nextController that will receive a request after this one.

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

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

inherited
listen(dynamic process(Request request)) RequestController

Sets the nextController that will receive a request after this one.

inherited
noSuchMethod(Invocation invocation) → dynamic

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

inherited
pipe(RequestController next) RequestController

Sets the nextController that will receive a request after this one.

inherited
processRequest(Request req) → dynamic

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

inherited
receive(Request req) → Future

Delivers req to this instance to be processed.

inherited
toString() → String

Returns a string representation of this object.

inherited
willSendResponse(Response response) → void

Executed prior to Response being sent.

inherited