com.authlete.jakarta.BaseDeviceCompleteEndpoint Maven / Gradle / Ivy
/*
* Copyright (C) 2019-2022 Authlete, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
* either express or implied. See the License for the specific
* language governing permissions and limitations under the
* License.
*/
package com.authlete.jakarta;
import jakarta.ws.rs.WebApplicationException;
import jakarta.ws.rs.core.Response;
import com.authlete.common.api.AuthleteApi;
import com.authlete.jakarta.spi.DeviceCompleteRequestHandlerSpi;
/**
* A base class for device complete endpoints of OAuth 2.0 Device Authorization
* Grant (Device Flow).
*
* @since 2.18
*
* @author Hideki Ikeda
*/
public class BaseDeviceCompleteEndpoint extends BaseEndpoint
{
/**
* Handle a device complete request.
*
*
* This method internally creates a {@link DeviceCompleteRequestHandler} instance and
* calls its {@link DeviceCompleteRequestHandler#handle(String, String[])} method.
* Then, this method uses the value returned from the {@code handle()} method
* as a response from this method.
*
*
*
* When {@code DeviceCompleteRequestHandler.handle()} method raises a {@link
* WebApplicationException}, this method calls {@link #onError(WebApplicationException)
* onError()} method with the exception. The default implementation of {@code onError()}
* does nothing. You can override the method as necessary. After calling
* {@code onError()} method, this method calls {@code getResponse()} method of
* the exception and uses the returned value as a response from this method.
*
*
* @param api
* An implementation of {@link AuthleteApi}.
*
* @param spi
* An implementation of {@link DeviceCompleteRequestHandlerSpi}.
*
* @param userCode
* The user code that the end-user input.
*
* @param claimNames
* Names of requested claims. Use the value of the {@code claimNames}
* parameter in a response from Authlete's {@code /api/device/verification} API.
*
* @return
* A response that should be returned to the end-user.
*/
public Response handle(
AuthleteApi api, DeviceCompleteRequestHandlerSpi spi, String userCode,
String[] claimNames)
{
try
{
// Create a handler.
DeviceCompleteRequestHandler handler = new DeviceCompleteRequestHandler(api, spi);
// Delegate the task to the handler.
return handler.handle(userCode, claimNames);
}
catch (WebApplicationException e)
{
// An error occurred in the handler.
onError(e);
// Convert the error to a Response.
return e.getResponse();
}
}
}