Package com.authlete.jaxrs

Class BaseGrantManagementEndpoint

java.lang.Object

com.authlete.jaxrs.BaseEndpoint

com.authlete.jaxrs.BaseResourceEndpoint

com.authlete.jaxrs.BaseGrantManagementEndpoint

public class BaseGrantManagementEndpoint
extends BaseResourceEndpoint

A base class for grant management endpoint.

Since:

2.38

See Also:

Grant Management for OAuth 2.0

Constructor Summary

Constructors

Constructor	Description
BaseGrantManagementEndpoint()

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	handle(com.authlete.common.api.AuthleteApi api, javax.servlet.http.HttpServletRequest req, String grantId)	Handle a grant management request.
javax.ws.rs.core.Response	handle(com.authlete.common.api.AuthleteApi api, javax.servlet.http.HttpServletRequest req, String grantId, com.authlete.common.api.Options options)	Handle a grant management request.

Methods inherited from class com.authlete.jaxrs.BaseResourceEndpoint

extractAccessToken, validateAccessToken, validateAccessToken, validateAccessToken, validateAccessToken, validateAccessToken, validateAccessToken, validateAccessToken, validateAccessToken, validateAccessToken, validateAccessToken, validateAccessToken, validateAccessToken

Methods inherited from class com.authlete.jaxrs.BaseEndpoint

extractClientCertificate, extractClientCertificateChain, extractHeadersAsPairs, onError, takeAttribute

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BaseGrantManagementEndpoint

public BaseGrantManagementEndpoint()

Method Detail

handle

public javax.ws.rs.core.Response handle(com.authlete.common.api.AuthleteApi api,
                                        javax.servlet.http.HttpServletRequest req,
                                        String grantId)
                                 throws javax.ws.rs.WebApplicationException

Handle a grant management request. This method is an alias of handle (api, req, grantId, null).

Parameters:

api - An implementation of AuthleteApi.

req - An HTTP request that the grant management endpoint received. Its HTTP method must be either GET or DELETE.

grantId - The grant ID included in the API call to the grant management endpoint. The last part of the path of the URL.

Returns:

A response that should be returned to the client application.

Throws:

javax.ws.rs.WebApplicationException - An exception generated by GMRequestHandler.

handle

public javax.ws.rs.core.Response handle(com.authlete.common.api.AuthleteApi api,
                                        javax.servlet.http.HttpServletRequest req,
                                        String grantId,
                                        com.authlete.common.api.Options options)
                                 throws javax.ws.rs.WebApplicationException

Handle a grant management request.

This method internally creates a GMRequestHandler instance and calls its GMRequestHandler.handle(GMRequest, Options) method.

Parameters:

api - An implementation of AuthleteApi.

req - An HTTP request that the grant management endpoint received. Its HTTP method must be either GET or DELETE.

grantId - The grant ID included in the API call to the grant management endpoint. The last part of the path of the URL.

options - The request options for the /api/gm API.

Returns:

A response that should be returned to the client application.

Throws:

javax.ws.rs.WebApplicationException - An exception generated by GMRequestHandler.

Since:

2.82