IntrospectionRequestHandler
extends BaseRequestHandler
in package
Handler for requests to an introspection endpoint.
Table of Contents
Methods
- __construct() : mixed
- Constructor with an implementation of the AuthleteApi interface.
- getApi() : AuthleteApi
- Get the implementation of the AuthleteApi interface.
- handle() : Response
- Handle an introspection 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 with an implementation of the AuthleteApi interface.
public
__construct(AuthleteApi $api) : mixed
The given value can be obtained later by calling getApi() method.
Parameters
- $api : AuthleteApi
-
An implementation of the
AuthleteApiinterface.
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 an introspection request.
public
handle(Request $request) : Response
This method calls Authlete's /api/auth/introspection/standard API.
Parameters
- $request : Request
-
An introspection request which complies with RFC 7662.
Tags
Return values
Response —An HTTP response that should be returned from the introspection 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.