com.nimbusds.oauth2.sdk.TokenIntrospectionResponse 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 com.nimbusds.oauth2.sdk.http.HTTPResponse;


/**
 * Token introspection response. This is the base abstract class for token
 * introspection success and error responses.
 *
 * Related specifications:
 *
 * 

 *     OAuth 2.0 Token Introspection (RFC 7662).
 * 
 */
public abstract class TokenIntrospectionResponse implements Response {
	
	
	/**
	 * Casts this response to a token introspection success response.
	 *
	 * @return The token introspection success response.
	 */
	public TokenIntrospectionSuccessResponse toSuccessResponse() {
		
		return (TokenIntrospectionSuccessResponse) this;
	}
	
	
	/**
	 * Casts this response to a token introspection error response.
	 *
	 * @return The token introspection error response.
	 */
	public TokenIntrospectionErrorResponse toErrorResponse() {
		
		return (TokenIntrospectionErrorResponse) this;
	}
	

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

		if (httpResponse.getStatusCode() == HTTPResponse.SC_OK) {
			return TokenIntrospectionSuccessResponse.parse(httpResponse);
		} else {
			return TokenIntrospectionErrorResponse.parse(httpResponse);
		}
	}
}