com.nimbusds.oauth2.sdk.device.DeviceAuthorizationResponse Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of oauth2-oidc-sdk Show documentation

OAuth 2.0 SDK with OpenID Connection extensions for developing client and server applications.

There is a newer version: 11.19.1

/*
 * oauth2-oidc-sdk
 *
 * Copyright 2012-2016, Connect2id Ltd and contributors.
 *
 * 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.nimbusds.oauth2.sdk.device;


import net.minidev.json.JSONObject;

import com.nimbusds.oauth2.sdk.ParseException;
import com.nimbusds.oauth2.sdk.Response;
import com.nimbusds.oauth2.sdk.http.HTTPResponse;


/**
 * Token endpoint response. This is the base abstract class for device
 * authorization success and error responses.
 *
 * Related specifications:
 *
 * 

 *     OAuth 2.0 Device Authorization Grant (RFC 8628)
 * 
 */
public abstract class DeviceAuthorizationResponse implements Response {

	
	/**
	 * Casts this response to an authorization success response.
	 *
	 * @return The authorization success response.
	 */
	public DeviceAuthorizationSuccessResponse toSuccessResponse() {

		return (DeviceAuthorizationSuccessResponse) this;
	}


	/**
	 * Casts this response to a device authorization error response.
	 *
	 * @return The device authorization error response.
	 */
	public DeviceAuthorizationErrorResponse toErrorResponse() {

		return (DeviceAuthorizationErrorResponse) this;
	}


	/**
	 * Parses a device authorization response from the specified JSON
	 * object.
	 *
	 * @param jsonObject The JSON object to parse. Must not be
	 *                   {@code null}.
	 *
	 * @return The device authorization success or error response.
	 *
	 * @throws ParseException If the JSON object couldn't be parsed to a
	 *                        device authorization response.
	 */
	public static DeviceAuthorizationResponse parse(final JSONObject jsonObject) throws ParseException {

		if (jsonObject.containsKey("device_code"))
			return DeviceAuthorizationSuccessResponse.parse(jsonObject);
		else
			return DeviceAuthorizationErrorResponse.parse(jsonObject);
	}


	/**
	 * Parses a device authorization response from the specified HTTP
	 * response.
	 *
	 * @param httpResponse The HTTP response. Must not be {@code null}.
	 *
	 * @return The device authorization success or error response.
	 *
	 * @throws ParseException If the HTTP response couldn't be parsed to a
	 *                        device authorization response.
	 */
	public static DeviceAuthorizationResponse parse(final HTTPResponse httpResponse) throws ParseException {

		if (httpResponse.getStatusCode() == HTTPResponse.SC_OK)
			return DeviceAuthorizationSuccessResponse.parse(httpResponse);
		else
			return DeviceAuthorizationErrorResponse.parse(httpResponse);
	}
}