Package net.shibboleth.idp.plugin.oidc.op.messaging

Class JSONErrorResponse

java.lang.Object

net.shibboleth.idp.plugin.oidc.op.messaging.JSONErrorResponse

All Implemented Interfaces:

ErrorResponse, Message, Response

@Deprecated(since="4.2.0",
            forRemoval=true)
public class JSONErrorResponse
extends Object
implements ErrorResponse

Deprecated, for removal: This API element is subject to removal in a future version.

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

Field Summary

Fields

Modifier and Type	Field	Description
private String	cacheControl	Deprecated, for removal: This API element is subject to removal in a future version. cache control value.
private ErrorObject	error	Deprecated, for removal: This API element is subject to removal in a future version. Error object.
private String	pragma	Deprecated, for removal: This API element is subject to removal in a future version. pragma value.

Constructor Summary

Constructors

Constructor	Description
JSONErrorResponse(ErrorObject errorObject)	Deprecated, for removal: This API element is subject to removal in a future version. Constructor.
JSONErrorResponse(ErrorObject errorObject, String cacheControlValue, String pragmaValue)	Deprecated, for removal: This API element is subject to removal in a future version. Constructor.

Method Summary

Modifier and Type	Method	Description
private String	getContent()	Deprecated, for removal: This API element is subject to removal in a future version. Error content as json.
ErrorObject	getErrorObject()	Deprecated, for removal: This API element is subject to removal in a future version.
boolean	indicatesSuccess()	Deprecated, for removal: This API element is subject to removal in a future version.
HTTPResponse	toHTTPResponse()	Deprecated, for removal: This API element is subject to removal in a future version.

Methods inherited from class java.lang.Object

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

Field Details

error

private ErrorObject error

Deprecated, for removal: This API element is subject to removal in a future version.

Error object.

cacheControl

private String cacheControl

Deprecated, for removal: This API element is subject to removal in a future version.

cache control value.

pragma

private String pragma

Deprecated, for removal: This API element is subject to removal in a future version.

pragma value.

Constructor Details

JSONErrorResponse

public JSONErrorResponse(@Nonnull
 ErrorObject errorObject)

Deprecated, for removal: This API element is subject to removal in a future version.

Constructor.

Parameters:

errorObject - error. MUST not be null.

JSONErrorResponse

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

Deprecated, for removal: This API element is subject to removal in a future version.

Constructor.

Parameters:

errorObject - JSON content.

cacheControlValue - cache control value.

pragmaValue - pragma value.

Method Details

indicatesSuccess

public boolean indicatesSuccess()

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

indicatesSuccess in interface Response

getContent

private String getContent()

Deprecated, for removal: This API element is subject to removal in a future version.

Error content as json.

Returns:

error as json.

toHTTPResponse

public HTTPResponse toHTTPResponse()

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

toHTTPResponse in interface Response

getErrorObject

public ErrorObject getErrorObject()

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

getErrorObject in interface ErrorResponse