Package net.shibboleth.oidc.profile.messaging

Class JSONErrorResponse

java.lang.Object

net.shibboleth.oidc.profile.messaging.JSONErrorResponse

All Implemented Interfaces:

ErrorResponse, Message, Response

public class JSONErrorResponse
extends Object
implements ErrorResponse

Class for creating JSON Error response for requests expecting JSON response.

Since:

2.2.0

Field Summary

Fields

Modifier and Type	Field	Description
private String	cacheControl	cache control value.
private ErrorObject	error	Error object.
private String	pragma	pragma value.

Constructor Summary

Constructors

Constructor	Description
JSONErrorResponse(ErrorObject errorObject)	Constructor.
JSONErrorResponse(ErrorObject errorObject, String cacheControlValue, String pragmaValue)	Constructor.

Method Summary

Modifier and Type	Method	Description
private String	getContent()	Error content as json.
ErrorObject	getErrorObject()
boolean	indicatesSuccess()
HTTPResponse	toHTTPResponse()

Methods inherited from class java.lang.Object

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

Field Details

error

private ErrorObject error

Error object.

cacheControl

private String cacheControl

cache control value.

pragma

private String pragma

pragma value.

Constructor Details

JSONErrorResponse

public JSONErrorResponse(@Nonnull
 ErrorObject errorObject)

Constructor.

Parameters:

errorObject - error. MUST not be null.

JSONErrorResponse

public JSONErrorResponse(@Nonnull
 ErrorObject errorObject,
 @Nullable
 String cacheControlValue,
 @Nullable
 String pragmaValue)

Constructor.

Parameters:

errorObject - JSON content.

cacheControlValue - cache control value.

pragmaValue - pragma value.

Method Details

indicatesSuccess

public boolean indicatesSuccess()

Specified by:

indicatesSuccess in interface Response

getContent

private String getContent()

Error content as json.

Returns:

error as json.

toHTTPResponse

public HTTPResponse toHTTPResponse()

Specified by:

toHTTPResponse in interface Response

getErrorObject

public ErrorObject getErrorObject()

Specified by:

getErrorObject in interface ErrorResponse