Package com.authlete.jaxrs

Class BaseAuthorizationDecisionEndpoint

java.lang.Object

com.authlete.jaxrs.BaseEndpoint

com.authlete.jaxrs.BaseAuthorizationDecisionEndpoint

public class BaseAuthorizationDecisionEndpoint
extends BaseEndpoint

A base class for authorization decision endpoints.

Since:

1.2

Author:

Takahiko Kawasaki

Constructor Summary

Constructors

Constructor	Description
BaseAuthorizationDecisionEndpoint()

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	handle(com.authlete.common.api.AuthleteApi api, AuthorizationDecisionHandlerSpi spi, AuthorizationDecisionHandler.Params params)	Handle an authorization decision request.
javax.ws.rs.core.Response	handle(com.authlete.common.api.AuthleteApi api, AuthorizationDecisionHandlerSpi spi, AuthorizationDecisionHandler.Params params, com.authlete.common.api.Options authzIssueOptions, com.authlete.common.api.Options authzFailOptions)	Handle an authorization decision request.
javax.ws.rs.core.Response	handle(com.authlete.common.api.AuthleteApi api, AuthorizationDecisionHandlerSpi spi, String ticket, String[] claimNames, String[] claimLocales)	Handle an authorization decision request.
javax.ws.rs.core.Response	handle(com.authlete.common.api.AuthleteApi api, AuthorizationDecisionHandlerSpi spi, String ticket, String[] claimNames, String[] claimLocales, com.authlete.common.api.Options authzIssueOptions, com.authlete.common.api.Options authzFailOptions)	Handle an authorization decision request.

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

BaseAuthorizationDecisionEndpoint

public BaseAuthorizationDecisionEndpoint()

Method Detail

handle

public javax.ws.rs.core.Response handle(com.authlete.common.api.AuthleteApi api,
                                        AuthorizationDecisionHandlerSpi spi,
                                        String ticket,
                                        String[] claimNames,
                                        String[] claimLocales)

Handle an authorization decision request. This method is an alias of handle(api, spi, ticket, claimNames, claimLocales, null, null).

Parameters:

api - An implementation of AuthleteApi.

spi - An implementation of AuthorizationDecisionHandlerSpi.

ticket - A ticket that was issued by Authlete's /api/auth/authorization API.

claimNames - Names of requested claims. Use the value of the claims parameter in a response from Authlete's /api/auth/authorization API.

claimLocales - Requested claim locales. Use the value of the claimsLocales parameter in a response from Authlete's /api/auth/authorization API.

Returns:

A response that should be returned to the client application.

handle

public javax.ws.rs.core.Response handle(com.authlete.common.api.AuthleteApi api,
                                        AuthorizationDecisionHandlerSpi spi,
                                        String ticket,
                                        String[] claimNames,
                                        String[] claimLocales,
                                        com.authlete.common.api.Options authzIssueOptions,
                                        com.authlete.common.api.Options authzFailOptions)

Handle an authorization decision request. This method is an alias of the handle(AuthleteApi, AuthorizationDecisionHandlerSpi, Params, Options, Options) method.

Parameters:

api - An implementation of AuthleteApi.

spi - An implementation of AuthorizationDecisionHandlerSpi.

ticket - A ticket that was issued by Authlete's /api/auth/authorization API.

claimNames - Names of requested claims. Use the value of the claims parameter in a response from Authlete's /api/auth/authorization API.

claimLocales - Requested claim locales. Use the value of the claimsLocales parameter in a response from Authlete's /api/auth/authorization API.

authzIssueOptions - The request options for the /api/auth/authorization/issue API.

authzFailOptions - The request options for the /api/auth/authorization/fail API.

Returns:

A response that should be returned to the client application.

Since:

2.82

handle

public javax.ws.rs.core.Response handle(com.authlete.common.api.AuthleteApi api,
                                        AuthorizationDecisionHandlerSpi spi,
                                        AuthorizationDecisionHandler.Params params)

Handle an authorization decision request. This method is an alias of handle(api, spi, params, null, null).

Parameters:

api - An implementation of AuthleteApi.

spi - An implementation of AuthorizationDecisionHandlerSpi.

params - Parameters necessary to handle the decision.

Returns:

A response that should be returned to the client application.

Since:

2.26

handle

public javax.ws.rs.core.Response handle(com.authlete.common.api.AuthleteApi api,
                                        AuthorizationDecisionHandlerSpi spi,
                                        AuthorizationDecisionHandler.Params params,
                                        com.authlete.common.api.Options authzIssueOptions,
                                        com.authlete.common.api.Options authzFailOptions)

Handle an authorization decision request.

This method internally creates a AuthorizationDecisionHandler instance and calls its handle() method. Then, this method uses the value returned from the handle() method as a response from this method.

When AuthorizationDecisionHandler.handle() method raises a WebApplicationException, this method calls onError() method with the exception. The default implementation of onError() does nothing. You can override the method as necessary. After calling onError() method, this method calls getResponse() method of the exception and uses the returned value as a response from this method.

Parameters:

api - An implementation of AuthleteApi.

spi - An implementation of AuthorizationDecisionHandlerSpi.

params - Parameters necessary to handle the decision.

authzIssueOptions - The request options for the /api/auth/authorization/issue API.

authzFailOptions - The request options for the /api/auth/authorization/fail API.

Returns:

A response that should be returned to the client application.

Since:

2.82