TokenRequestHandler
extends BaseRequestHandler
in package
Handler for requests to a token endpoint.
Table of Contents
Methods
- __construct() : mixed
- Constructor.
- getApi() : AuthleteApi
- Get the implementation of the AuthleteApi interface.
- handle() : Response
- Handle a token request.
- unknownAction() : Response
- A utility method to generate a Response instance with "500 Internal Server Error" and an error message in JSON.
Methods
__construct()
Constructor.
public
__construct(AuthleteApi $api, TokenRequestHandlerSpi $spi) : mixed
Parameters
- $api : AuthleteApi
-
An implementation of the
AuthleteApiinterface. - $spi : TokenRequestHandlerSpi
-
An implementation of the
TokenRequestHandlerSpiinterface.
getApi()
Get the implementation of the AuthleteApi interface.
public
getApi() : AuthleteApi
The value returned from this method is the instance that was given to the constructor.
Return values
AuthleteApi —An implementation of the AuthleteApi interface.
handle()
Handle a token request.
public
handle(Request $request) : Response
This method calls Authlete's /api/auth/token API and optionally
/api/auth/token/issue API or /api/auth/token/fail API.
Parameters
- $request : Request
-
A token request.
Tags
Return values
Response —An HTTP response that should be returned from the token endpoint implementation to the client application.
unknownAction()
A utility method to generate a Response instance with "500 Internal Server Error" and an error message in JSON.
protected
unknownAction(string $apiPath) : Response
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.
Parameters
- $apiPath : string
-
The path of an Authlete API.
Return values
Response —A Response instahce which represents a server error.