AuthorizationRequestErrorHandler Class Reference

Handler for error cases of authorization requests. More...

Inheritance diagram for AuthorizationRequestErrorHandler:

Public Member Functions
	AuthorizationRequestErrorHandler ()
	Constructor. More...
HttpResponseMessage	Handle (AuthorizationResponse response)
	Handle an error case of an authorization request. This method returns null when response.Action returns AuthorizationAction.INTERACTION or AuthorizationAction.NO_INTERACTION. In other cases, an instance of HttpResponseMessage is returned. More...
Public Member Functions inherited from AuthorizationRequestBaseHandler
	AuthorizationRequestBaseHandler (IAuthleteApi api)
	Consturctor with an implementation of the IAuthleteApi interface which will be passed to the constructor of the super class. More...
Public Member Functions inherited from BaseRequestHandler
	BaseRequestHandler (IAuthleteApi api)
	Constructor with an implementation of the IAuthleteApi interface. The given value can be referred to as the value of the Api property later. More...

Additional Inherited Members
Protected Member Functions inherited from AuthorizationRequestBaseHandler
async Task< HttpResponseMessage >	AuthorizationIssue (string ticket, string subject, long authTime, string acr, IDictionary< string, object > claims, Property[] properties, string[] scopes, string sub)
	Call Authlete's /api/auth/authorization/issue API and generate an HttpResponseMessage instance according to the value of the "action" parameter in the response from the API. Read the description of AuthorizationIssueRequest for details about the parameters given to this method. More...
async Task< HttpResponseMessage >	AuthorizationFail (string ticket, AuthorizationFailReason reason)
	Call Authlete's /api/auth/authorization/fail API and generate an HttpResponseMessage instance according to the value of the "action" parameter in the response from the API. Read the description of AuthorizationFailRequest for details about the parameters given to this method. More...
Protected Member Functions inherited from BaseRequestHandler
HttpResponseMessage	UnknownAction (string apiPath)
	A utility method to generate an HttpResponseMessage instance with "500 Internal Server Error" and an error message in JSON. This method is expected to be used when the value of the "action" parameter in a response from an Authlete API holds an unexpected value. More...
Properties inherited from BaseRequestHandler
IAuthleteApi	Api [get]
	The implementation of the IAuthleteApi interface. It is the value given to the constructor. More...

Detailed Description

Handler for error cases of authorization requests.

A response from Authlete's /api/auth/authorization API contains an "action" response parameter. When the value of the response parameter is neither "NO_INTERACTION" nor "INTERACTION", the authorization request should be handled as an error case. This class is a handler for such error cases.

Constructor & Destructor Documentation

AuthorizationRequestErrorHandler()

AuthorizationRequestErrorHandler ( )

inline

Constructor.

Member Function Documentation

Handle()

HttpResponseMessage Handle ( AuthorizationResponse  response )

inline

Handle an error case of an authorization request. This method returns null when response.Action returns AuthorizationAction.INTERACTION or AuthorizationAction.NO_INTERACTION. In other cases, an instance of HttpResponseMessage is returned.

Returns

An error response that should be returned to the client application from the authorization endpoint. null is returned when response.Action returns AuthorizationAction.INTERACTION or AuthorizationAction.NO_INTERACTION.

Parameters

response

A response from Authlete's /api/auth/authorization API.

---

The documentation for this class was generated from the following file:

• Authlete/Handler/AuthorizationRequestErrorHandler.cs