AuthController class

Controller for issuing and refreshing OAuth 2.0 access tokens.

This controller issues and refreshes access tokens. Access tokens are issued for valid username and password (resource owner password grant) or for an authorization code (authorization code grant) from a AuthRedirectController.

See operation method grant for more details.

Usage:

  router
    .route("/auth/token")
    .link(() => new AuthController(authServer));

Inheritance

Constructors

AuthController(AuthServer? authServer): Creates a new instance of an AuthController.

Properties

acceptedContentTypes ↔ List<ContentType?>: Types of content this ResourceController will accept.
getter/setter pairinherited
authHeader ↔ String?: Required basic authentication Authorization header containing client ID and secret for the authenticating client.
getter/setter pair
authServer → AuthServer?: A reference to the AuthServer this controller uses to grant tokens.
final
hashCode → int: The hash code for this object.
no setterinherited
logger → Logger: An instance of the 'liquidart' logger.
no setterinherited
nextController → Controller?: Receives requests that this controller does not respond to.
no setterinherited
pathVariables → Map<String, String>: Parameters parsed from the URI of the request, if any exist.
no setterinherited
policy ↔ CORSPolicy?: The CORS policy of this controller.
getter/setter pairinherited
recycledState → Null: Returns state information that is reused across instances of this type.
no setterinherited
request ↔ Request?: The request being processed by this ResourceController.
getter/setter pairinherited
responseContentType ↔ ContentType: The default content type of responses from this ResourceController.
getter/setter pairinherited
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited

Methods

applyCORSHeadersIfNecessary(Request req, Response resp) → void: inherited
didAddToChannel() → void: Lifecycle callback, invoked after added to channel, but before any requests are served.
inherited
didDecodeRequestBody(RequestBody body) → void: Callback to indicate when a request body has been processed.
inherited
documentComponents(APIDocumentContext context) → void: Tells this object to add its components to context.
inherited
documentOperationDescription(APIDocumentContext context, Operation operation) → String?: Returns a documented description for operation.
inherited
documentOperationParameters(APIDocumentContext context, Operation operation) → List<APIParameter?>: Returns a documented list of APIParameter for operation.
override
documentOperationRequestBody(APIDocumentContext context, Operation operation) → APIRequestBody: Returns a documented request body for operation.
override
documentOperationResponses(APIDocumentContext context, Operation operation) → Map<String, APIResponse>: Returns a map of possible responses for operation.
override
documentOperations(APIDocumentContext context, String route, APIPath path) → Map<String, APIOperation>: Tells this object to return all APIOperations it handles.
override
documentOperationSummary(APIDocumentContext context, Operation operation) → String?: Returns a documented summary for operation.
inherited
documentOperationTags(APIDocumentContext context, Operation operation) → List<String>: Returns a list of tags for operation.
inherited
documentPaths(APIDocumentContext context) → Map<String, APIPath>: Tells this object to return all APIPaths it handles.
inherited
grant({String? username, String? password, String? refreshToken, String? authCode, String? grantType, String? scope}) → Future<Response>: Creates or refreshes an authentication token.
handle(Request request) → FutureOr<RequestOrResponse>: The primary request handling method of this object.
inherited
handleError(Request request, dynamic caughtValue, StackTrace trace) → Future: Sends an HTTP response for a request that yields an exception or error.
inherited
link(Controller instantiator()) → Linkable: Links a controller to the receiver to form a request channel.
inherited
linkFunction(FutureOr<RequestOrResponse?> handle(Request request)) → Linkable: Links a function controller to the receiver to form a request channel.
inherited
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
receive(Request req) → Future: Delivers req to this instance to be processed.
inherited
restore(Null state) → void: Provides a new instance of this type with the recycledState of this type.
inherited
toString() → String: A string representation of this object.
inherited
willDecodeRequestBody(RequestBody body) → void: Callback invoked prior to decoding a request body.
inherited
willProcessRequest(Request req) → FutureOr<RequestOrResponse>: Executed prior to handling a request, but after the request has been set.
inherited
willSendResponse(Response response) → void: Executed prior to Response being sent.
override

Operators

operator ==(Object other) → bool: The equality operator.
inherited

Static Methods

tokenResponse(AuthToken token) → Response: Transforms a AuthToken into a Response object with an RFC6749 compliant JSON token as the HTTP response body.