com.nimbusds.oauth2.sdk.RequestObjectPOSTErrorResponse 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

/*
 * 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;


import net.jcip.annotations.Immutable;

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


/**
 * Request object POST error response.
 *
 * Example request object POST error response indicating an invalid JWS
 * signature:
 *
 * 
 * HTTP/1.1 401 Unauthorized
 * Date: Tue, 2 May 2017 15:22:31 GMT
 * 
 *
 * Related specifications:
 *
 * 

 *     Financial-grade API - Part 2: Read and Write API Security Profile,
 *         section 7.
 *     
The OAuth 2.0 Authorization Framework: JWT Secured Authorization
 *         Request (JAR) (draft-ietf-oauth-jwsreq-17).
 * 
 */
@Deprecated
@Immutable
public final class RequestObjectPOSTErrorResponse extends RequestObjectPOSTResponse implements ErrorResponse {
	
	
	/**
	 * Holds the HTTP status code.
	 */
	private final ErrorObject errorObject;
	
	
	/**
	 * Creates a new request object POST error response.
	 *
	 * @param httpStatusCode The HTTP status code. Should be other than
	 *                       2xx.
	 */
	public RequestObjectPOSTErrorResponse(final int httpStatusCode) {
		errorObject = new ErrorObject(null, null, httpStatusCode);
	}
	
	
	public int getHTTPStatusCode() {
		return errorObject.getHTTPStatusCode();
	}
	
	
	@Override
	public ErrorObject getErrorObject() {
		return errorObject;
	}
	
	
	@Override
	public boolean indicatesSuccess() {
		return false;
	}
	
	
	@Override
	public HTTPResponse toHTTPResponse() {
		return new HTTPResponse(getHTTPStatusCode());
	}
	
	
	/**
	 * Parses a request object POST error response from the specified
	 * HTTP response.
	 *
	 * @param httpResponse The HTTP response. Must not be {@code null}.
	 *
	 * @return The request object POST error response.
	 *
	 * @throws ParseException If the HTTP response couldn't be parsed to a
	 *                        request object POST error response.
	 */
	public static RequestObjectPOSTErrorResponse parse(final HTTPResponse httpResponse)
		throws ParseException {
		
		if (httpResponse.getStatusCode() >= 200 && httpResponse.getStatusCode() <= 299) {
			throw new ParseException("Unexpected HTTP status code, must not be 2xx");
		}
		
		return new RequestObjectPOSTErrorResponse(httpResponse.getStatusCode());
	}
}