com.nimbusds.oauth2.sdk.http

Class HTTPResponse

java.lang.Object

com.nimbusds.oauth2.sdk.http.HTTPResponse

@ThreadSafe
public class HTTPResponse
extends Object

HTTP response with support for the parameters required to construct an OAuth 2.0 response message.

Provided HTTP status code constants:

• HTTP 200 OK
• HTTP 201 Created
• HTTP 302 Redirect
• HTTP 400 Bad request
• HTTP 401 Unauthorized
• HTTP 403 Forbidden
• HTTP 500 Server error

Supported response headers:

• Location
• Content-Type
• Cache-Control
• Pragma
• Www-Authenticate

Field Summary

Fields

Modifier and Type	Field and Description
static int	SC_BAD_REQUEST HTTP status code (400) indicating a bad request.
static int	SC_CREATED HTTP status code (201) indicating the request succeeded with a new resource being created.
static int	SC_FORBIDDEN HTTP status code (403) indicating that access to the resource was forbidden.
static int	SC_FOUND HTTP status code (302) indicating that the resource resides temporarily under a different URI (redirect).
static int	SC_OK HTTP status code (200) indicating the request succeeded.
static int	SC_SERVER_ERROR HTTP status code (500) indicating an internal server error.
static int	SC_SERVICE_UNAVAILABLE HTTP status code (503) indicating the server is unavailable.
static int	SC_UNAUTHORIZED HTTP status code (401) indicating that the request requires HTTP authentication.

Constructor Summary

Constructors

Constructor and Description
HTTPResponse(int statusCode) Creates a new minimal HTTP response with the specified status code.

Method Summary

Methods

Modifier and Type	Method and Description
void	ensureContentType() Ensures this HTTP message has a Content-Type header value.
void	ensureContentType(javax.mail.internet.ContentType contentType) Ensures this HTTP message has the specified Content-Type header value.
void	ensureStatusCode(int... expectedStatusCode) Ensures this HTTP response has the specified status code.
void	ensureStatusCodeNotOK() Ensures this HTTP response does not have a 200 OK status code.
String	getCacheControl() Gets the Cache-Control header value.
String	getContent() Gets the raw response content.
net.minidev.json.JSONArray	getContentAsJSONArray() Gets the response content as a JSON array.
net.minidev.json.JSONObject	getContentAsJSONObject() Gets the response content as a JSON object.
com.nimbusds.jwt.JWT	getContentAsJWT() Gets the response content as a JSON Web Token (JWT).
javax.mail.internet.ContentType	getContentType() Gets the Content-Type header value.
String	getHeader(String name) Gets a HTTP header value.
Map<String,String>	getHeaders() Returns the HTTP headers.
URI	getLocation() Gets the Location header value (for redirects).
String	getPragma() Gets the Pragma header value.
int	getStatusCode() Gets the HTTP status code.
String	getWWWAuthenticate() Gets the WWW-Authenticate header value.
boolean	indicatesSuccess() Returns true if the HTTP status code indicates success (2xx).
void	setCacheControl(String cacheControl) Sets the Cache-Control header value.
void	setContent(String content) Sets the raw response content.
void	setContentType(javax.mail.internet.ContentType ct) Sets the Content-Type header value.
void	setContentType(String ct) Sets the Content-Type header value.
void	setHeader(String name, String value) Sets a HTTP header value.
void	setLocation(URI location) Sets the Location header value (for redirects).
void	setPragma(String pragma) Sets the Pragma header value.
void	setWWWAuthenticate(String wwwAuthenticate) Sets the WWW-Authenticate header value.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SC_OK

public static final int SC_OK

HTTP status code (200) indicating the request succeeded.

See Also:

Constant Field Values

SC_CREATED

public static final int SC_CREATED

HTTP status code (201) indicating the request succeeded with a new resource being created.

See Also:

Constant Field Values

SC_FOUND

public static final int SC_FOUND

HTTP status code (302) indicating that the resource resides temporarily under a different URI (redirect).

See Also:

Constant Field Values

SC_BAD_REQUEST

public static final int SC_BAD_REQUEST

HTTP status code (400) indicating a bad request.

See Also:

Constant Field Values

SC_UNAUTHORIZED

public static final int SC_UNAUTHORIZED

HTTP status code (401) indicating that the request requires HTTP authentication.

See Also:

Constant Field Values

SC_FORBIDDEN

public static final int SC_FORBIDDEN

HTTP status code (403) indicating that access to the resource was forbidden.

See Also:

Constant Field Values

SC_SERVER_ERROR

public static final int SC_SERVER_ERROR

HTTP status code (500) indicating an internal server error.

See Also:

Constant Field Values

SC_SERVICE_UNAVAILABLE

public static final int SC_SERVICE_UNAVAILABLE

HTTP status code (503) indicating the server is unavailable.

See Also:

Constant Field Values

Constructor Detail

HTTPResponse

public HTTPResponse(int statusCode)

Creates a new minimal HTTP response with the specified status code.

Parameters:

statusCode - The HTTP status code.

Method Detail

getStatusCode

public int getStatusCode()

Gets the HTTP status code.

Returns:

The HTTP status code.

indicatesSuccess

public boolean indicatesSuccess()

Returns true if the HTTP status code indicates success (2xx).

Returns:

true if the HTTP status code indicates success, else false.

ensureStatusCode

public void ensureStatusCode(int... expectedStatusCode)
                      throws ParseException

Ensures this HTTP response has the specified status code.

Parameters:

expectedStatusCode - The expected status code(s).

Throws:

ParseException - If the status code of this HTTP response doesn't match the expected.

ensureStatusCodeNotOK

public void ensureStatusCodeNotOK()
                           throws ParseException

Ensures this HTTP response does not have a 200 OK status code.

Throws:

ParseException - If the status code of this HTTP response is 200 OK.

getLocation

public URI getLocation()

Gets the Location header value (for redirects).

Returns:

The header value, null if not specified.

setLocation

public void setLocation(URI location)

Sets the Location header value (for redirects).

Parameters:

location - The header value, null if not specified.

getCacheControl

public String getCacheControl()

Gets the Cache-Control header value.

Returns:

The header value, null if not specified.

setCacheControl

public void setCacheControl(String cacheControl)

Sets the Cache-Control header value.

Parameters:

cacheControl - The header value, null if not specified.

getPragma

public String getPragma()

Gets the Pragma header value.

Returns:

The header value, null if not specified.

setPragma

public void setPragma(String pragma)

Sets the Pragma header value.

Parameters:

pragma - The header value, null if not specified.

getWWWAuthenticate

public String getWWWAuthenticate()

Gets the WWW-Authenticate header value.

Returns:

The header value, null if not specified.

setWWWAuthenticate

public void setWWWAuthenticate(String wwwAuthenticate)

Sets the WWW-Authenticate header value.

Parameters:

wwwAuthenticate - The header value, null if not specified.

getContent

public String getContent()

Gets the raw response content.

Returns:

The raw response content, null if none.

getContentAsJSONObject

public net.minidev.json.JSONObject getContentAsJSONObject()
                                                   throws ParseException

Gets the response content as a JSON object.

Returns:

The response content as a JSON object.

Throws:

ParseException - If the Content-Type header isn't application/json, the response content is null, empty or couldn't be parsed to a valid JSON object.

getContentAsJSONArray

public net.minidev.json.JSONArray getContentAsJSONArray()
                                                 throws ParseException

Gets the response content as a JSON array.

Returns:

The response content as a JSON array.

Throws:

ParseException - If the Content-Type header isn't application/json, the response content is null, empty or couldn't be parsed to a valid JSON array.

getContentAsJWT

public com.nimbusds.jwt.JWT getContentAsJWT()
                                     throws ParseException

Gets the response content as a JSON Web Token (JWT).

Returns:

The response content as a JSON Web Token (JWT).

Throws:

ParseException - If the Content-Type header isn't application/jwt, the response content is null, empty or couldn't be parsed to a valid JSON Web Token (JWT).

setContent

public void setContent(String content)

Sets the raw response content.

Parameters:

content - The raw response content, null if none.

getContentType

public javax.mail.internet.ContentType getContentType()

Gets the Content-Type header value.

Returns:

The Content-Type header value, null if not specified.

setContentType

public void setContentType(javax.mail.internet.ContentType ct)

Sets the Content-Type header value.

Parameters:

ct - The Content-Type header value, null if not specified.

setContentType

public void setContentType(String ct)
                    throws ParseException

Sets the Content-Type header value.

Parameters:

ct - The Content-Type header value, null if not specified.

Throws:

ParseException - If the header value couldn't be parsed to a valid content type.

ensureContentType

public void ensureContentType()
                       throws ParseException

Ensures this HTTP message has a Content-Type header value.

Throws:

ParseException - If the Content-Type header is missing.

ensureContentType

public void ensureContentType(javax.mail.internet.ContentType contentType)
                       throws ParseException

Ensures this HTTP message has the specified Content-Type header value. This method compares only the primary type and subtype; any content type parameters, such as charset, are ignored.

Parameters:

contentType - The expected content type. Must not be null.

Throws:

ParseException - If the Content-Type header is missing or its primary and subtype don't match.

getHeader

public String getHeader(String name)

Gets a HTTP header value.

Parameters:

name - The header name. Must not be null.

Returns:

The header value, null if not specified.

setHeader

public void setHeader(String name,
             String value)

Sets a HTTP header value.

Parameters:

name - The header name. Must not be null.

value - The header value. If null and a header with the same name is specified, it will be deleted.

getHeaders

public Map<String,String> getHeaders()

Returns the HTTP headers.

Returns:

The HTTP headers.