com.nimbusds.oauth2.sdk.PushedAuthorizationSuccessResponse 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
Show all versions of oauth2-oidc-sdk Show documentation
OAuth 2.0 SDK with OpenID Connection extensions for developing
client and server applications.
/*
* 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 java.net.URI;
import net.jcip.annotations.Immutable;
import net.minidev.json.JSONObject;
import com.nimbusds.oauth2.sdk.http.CommonContentTypes;
import com.nimbusds.oauth2.sdk.http.HTTPResponse;
import com.nimbusds.oauth2.sdk.util.JSONObjectUtils;
/**
* Pushed authorisation success response.
*
* Example HTTP response:
*
*
* HTTP/1.1 201 Created
* Date: Tue, 2 May 2017 15:22:31 GMT
* Content-Type: application/json
*
* {
* "request_uri" : "urn:example:bwc4JK-ESC0w8acc191e-Y1LTC2",
* "expires_in" : 3600
* }
*
*
* Related specifications:
*
*
* - OAuth 2.0 Pushed Authorization Requests
* (draft-lodderstedt-oauth-par-01)
*
*/
@Immutable
public class PushedAuthorizationSuccessResponse extends PushedAuthorizationResponse {
/**
* The request URI.
*/
private final URI requestURI;
/**
* Lifetime, in seconds.
*/
private final long lifetime;
/**
* Creates a new pushed authorisation success response.
*
* @param requestURI The request URI. Must not be {@code null}.
* @param lifetime The request lifetime, in seconds. Must be a
* positive integer.
*/
public PushedAuthorizationSuccessResponse(final URI requestURI, final long lifetime) {
if (requestURI == null) {
throw new IllegalArgumentException("The request URI must not be null");
}
this.requestURI = requestURI;
if (lifetime <= 0) {
throw new IllegalArgumentException("The request lifetime must be a positive integer");
}
this.lifetime = lifetime;
}
/**
* Returns the request URI.
*
* @return The request URI.
*/
public URI getRequestURI() {
return requestURI;
}
/**
* Returns the request lifetime.
*
* @return The request lifetime, in seconds.
*/
public long getLifetime() {
return lifetime;
}
@Override
public boolean indicatesSuccess() {
return true;
}
/**
* Returns a JSON object representation of this pushed authorisation
* success response.
*
* Example JSON object:
*
*
* {
* "request_uri": "urn:example:bwc4JK-ESC0w8acc191e-Y1LTC2",
* "expires_in": 3600
* }
*
*
* @return The JSON object.
*/
public JSONObject toJSONObject() {
JSONObject o = new JSONObject();
o.put("request_uri", getRequestURI().toString());
o.put("expires_in", getLifetime());
return o;
}
@Override
public HTTPResponse toHTTPResponse() {
HTTPResponse httpResponse = new HTTPResponse(HTTPResponse.SC_CREATED);
httpResponse.setContentType(CommonContentTypes.APPLICATION_JSON);
httpResponse.setContent(toJSONObject().toString());
return httpResponse;
}
/**
* Parses pushed authorisation success response from the specified JSON
* object.
*
* @param jsonObject The JSON object to parse. Must not be
* {@code null}.
*
* @return The pushed authorisation success response.
*
* @throws ParseException If the JSON object couldn't be parsed to a
* pushed authorisation success response.
*/
public static PushedAuthorizationSuccessResponse parse(final JSONObject jsonObject)
throws ParseException {
URI requestURI = JSONObjectUtils.getURI(jsonObject, "request_uri");
long lifetime = JSONObjectUtils.getLong(jsonObject, "expires_in");
return new PushedAuthorizationSuccessResponse(requestURI, lifetime);
}
/**
* Parses a pushed authorisation success response from the specified
* HTTP response.
*
* @param httpResponse The HTTP response. Must not be {@code null}.
*
* @return The pushed authorisation success response.
*
* @throws ParseException If the HTTP response couldn't be parsed to a
* pushed authorisation success response.
*/
public static PushedAuthorizationSuccessResponse parse(final HTTPResponse httpResponse)
throws ParseException {
httpResponse.ensureStatusCode(HTTPResponse.SC_CREATED, HTTPResponse.SC_OK);
JSONObject jsonObject = httpResponse.getContentAsJSONObject();
return parse(jsonObject);
}
}