com.nimbusds.openid.connect.sdk.federation.api.FederationAPIError Maven / Gradle / Ivy

Go to download
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.20.1
/*
 * oauth2-oidc-sdk
 *
 * Copyright 2012-2020, 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.openid.connect.sdk.federation.api;


import net.jcip.annotations.Immutable;
import net.minidev.json.JSONObject;

import com.nimbusds.oauth2.sdk.ErrorObject;
import com.nimbusds.oauth2.sdk.ParseException;
import com.nimbusds.oauth2.sdk.http.HTTPResponse;
import com.nimbusds.oauth2.sdk.util.JSONObjectUtils;


/**
 * Federation API error.
 *
 * 
 *     OpenID Connect Federation 1.0, section 6.4.
 * 
 */
@Immutable
public class FederationAPIError extends ErrorObject {
	
	
	private static final long serialVersionUID = 2116693118039606386L;
	
	
	/**
	 * The operation type.
	 */
	private final OperationType operationType;
	
	
	/**
	 * Creates a new federation API error.
	 *
	 * @param operationType The operation type, {@code null} if not
	 *                      specified.
	 * @param code          The error code, {@code null} if not specified.
	 * @param description   The error description, {@code null} if not
	 *                      specified.
	 */
	public FederationAPIError(final OperationType operationType, final String code, final String description) {
		this(operationType, code, description, 0);
	}
	
	
	/**
	 * Creates a new federation API error.
	 *
	 * @param operationType  The operation type, {@code null} if not
	 *                       specified.
	 * @param code           The error code, {@code null} if not specified.
	 * @param description    The error description, {@code null} if not
	 *                       specified.
	 * @param httpStatusCode The HTTP status code, zero if not specified.
	 */
	public FederationAPIError(final OperationType operationType,
				  final String code,
				  final String description,
				  final int httpStatusCode) {
		super(code, description, httpStatusCode);
		this.operationType = operationType;
	}
	
	
	/**
	 * Returns the operation type.
	 *
	 * @return The operation type, {@code null} if not specified.
	 */
	public OperationType getOperationType() {
		return operationType;
	}
	
	
	/**
	 * Returns a copy of this federation API error with the specified HTTP
	 * status code.
	 *
	 * @param httpStatusCode The HTTP status code, zero if not specified.
	 *
	 * @return The new federation API error.
	 */
	public FederationAPIError withStatusCode(final int httpStatusCode) {
		return new FederationAPIError(getOperationType(), getCode(), getDescription(), httpStatusCode);
	}
	
	
	@Override
	public JSONObject toJSONObject() {
		JSONObject jsonObject = super.toJSONObject();
		if (getOperationType() != null) {
			jsonObject.put("operation", getOperationType().getValue());
		}
		return jsonObject;
	}
	
	
	/**
	 * Parses a federation API error object from the specified JSON object.
	 *
	 * @param jsonObject The JSON object to parse. Must not be
	 *                   {@code null}.
	 *
	 * @return The federation API error object.
	 */
	public static FederationAPIError parse(final JSONObject jsonObject) {
		ErrorObject errorObject = ErrorObject.parse(jsonObject);
		OperationType operationType = null;
		try {
			operationType = new OperationType(JSONObjectUtils.getString(jsonObject, "operation"));
		} catch (ParseException e) {
			// ignore
		}
		return new FederationAPIError(operationType, errorObject.getCode(), errorObject.getDescription());
	}
	
	
	/**
	 * Parses a federation API error object from the specified HTTP
	 * response.
	 *
	 * @param httpResponse The HTTP response to parse. Must not be
	 *                     {@code null}.
	 *
	 * @return The federation API error object.
	 */
	public static FederationAPIError parse(final HTTPResponse httpResponse) {
		JSONObject jsonObject;
		try {
			jsonObject = httpResponse.getContentAsJSONObject();
		} catch (ParseException e) {
			jsonObject = new JSONObject();
		}
		return FederationAPIError.parse(jsonObject).withStatusCode(httpResponse.getStatusCode());
	}
}