Package com.authlete.common.dto

Class BackchannelAuthenticationFailRequest

java.lang.Object

com.authlete.common.dto.BackchannelAuthenticationFailRequest

All Implemented Interfaces:

Serializable

public class BackchannelAuthenticationFailRequest
extends Object
implements Serializable

Request to Authlete's /api/backchannel/authentication/fail API.

The API prepares JSON that contains an error. The JSON should be used as the response body of the response which is returned to the client from the backchannel authentication endpoint.

Since:

2.32

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BackchannelAuthenticationFailRequest.Reason	Failure reasons of backchannel authentication requests.

Constructor Summary

Constructors

Constructor	Description
BackchannelAuthenticationFailRequest()

Method Summary

Modifier and Type	Method	Description
String	getErrorDescription()	Get the description of the error.
URI	getErrorUri()	Get the URI of a document which describes the error in detail.
BackchannelAuthenticationFailRequest.Reason	getReason()	Get the reason of the failure of the backchannel authentication request.
String	getTicket()	Get the ticket which should be deleted on a call of Authlete's /api/backchannel/authentication/fail API.
BackchannelAuthenticationFailRequest	setErrorDescription(String description)	Set the description of the error.
BackchannelAuthenticationFailRequest	setErrorUri(URI uri)	Set the URI of a document which describes the error in detail.
BackchannelAuthenticationFailRequest	setReason(BackchannelAuthenticationFailRequest.Reason reason)	Set the reason of the failure of the backchannel authentication request.
BackchannelAuthenticationFailRequest	setTicket(String ticket)	Set the ticket which should be deleted on a call of Authlete's /api/backchannel/authentication/fail API.

Methods inherited from class java.lang.Object

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

Constructor Detail

BackchannelAuthenticationFailRequest

public BackchannelAuthenticationFailRequest()

Method Detail

getTicket

public String getTicket()

Get the ticket which should be deleted on a call of Authlete's /api/backchannel/authentication/fail API.

Returns:

A ticket.

setTicket

public BackchannelAuthenticationFailRequest setTicket(String ticket)

Set the ticket which should be deleted on a call of Authlete's /api/backchannel/authentication/fail API.

This request parameter is not mandatory but optional. If this request parameter is given and the ticket belongs to the service, the specified ticket is deleted from the database. Giving this parameter is recommended to clean up the storage area for the service.

Parameters:

ticket - A ticket previously issued by Authlete's /api/backchannel/authentication API.

Returns:

this object.

getReason

public BackchannelAuthenticationFailRequest.Reason getReason()

Get the reason of the failure of the backchannel authentication request.

Returns:

The reason of the failure of the backchannel authentication request.

setReason

public BackchannelAuthenticationFailRequest setReason(BackchannelAuthenticationFailRequest.Reason reason)

Set the reason of the failure of the backchannel authentication request.

This request parameter is not mandatory but optional. However, giving this parameter is recommended. If omitted, SERVER_ERROR is used as a reason.

Parameters:

reason - The reason of the failure of the backchannel authentication request.

Returns:

this object.

getErrorDescription

public String getErrorDescription()

Get the description of the error. This corresponds to the error_description property in the response to the client.

Returns:

The description of the error.

setErrorDescription

public BackchannelAuthenticationFailRequest setErrorDescription(String description)

Set the description of the error. This corresponds to the error_description property in the response to the client.

If this optional request parameter is given, its value is used as the value of the error_description property.

Parameters:

description - The description of the error.

Returns:

this object.

getErrorUri

public URI getErrorUri()

Get the URI of a document which describes the error in detail. This corresponds to the error_uri property in the response to the client.

Returns:

The URI of a document which describes the error in detail.

setErrorUri

public BackchannelAuthenticationFailRequest setErrorUri(URI uri)

Set the URI of a document which describes the error in detail. This corresponds to the error_uri property in the response to the client.

If this optional request parameter is given, its value is used as the value of the error_uri property.

Parameters:

uri - The URI of a document which describes the error in detail.

Returns:

this object.