com.authlete.common.dto

Class AuthorizationFailRequest

java.lang.Object

com.authlete.common.dto.AuthorizationFailRequest

All Implemented Interfaces:

Serializable

public class AuthorizationFailRequest
extends Object
implements Serializable

Request to Authlete's /auth/authorization/fail API.

ticket (REQUIRED)

The ticket issued by Authlete's /auth/authorization API to the service implementation. It is the value of "ticket" contained in the response from Authlete's /auth/authorization API (AuthorizationResponse).

reason (REQUIRED)

The reason of the failure of the authorization request. See the description of AuthorizationResponse as to which reason should be chosen.

Author:

Takahiko Kawasaki

See Also:

AuthorizationResponse, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AuthorizationFailRequest.Reason Failure reasons of authorization requests.

Constructor Summary

Constructors

Constructor and Description
AuthorizationFailRequest()

Method Summary

Modifier and Type	Method and Description
String	getDescription() Get the custom description about the authorization failure.
AuthorizationFailRequest.Reason	getReason() Get the value of "reason" which is the reason of the failure of the authorization request.
String	getTicket() Get the value of "ticket" which is the ticket issued by Authlete's /auth/authorization API to the service implementation.
AuthorizationFailRequest	setDescription(String description) Set the custom description about the authorization failure.
AuthorizationFailRequest	setReason(AuthorizationFailRequest.Reason reason) Set the value of "reason" which is the reason of the failure of the authorization request.
AuthorizationFailRequest	setTicket(String ticket) Set the value of "ticket" which is the ticket issued by Authlete's /auth/authorization API to the service implementation.

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthorizationFailRequest

public AuthorizationFailRequest()

Method Detail

getTicket

public String getTicket()

Get the value of "ticket" which is the ticket issued by Authlete's /auth/authorization API to the service implementation.

Returns:

The ticket.

setTicket

public AuthorizationFailRequest setTicket(String ticket)

Set the value of "ticket" which is the ticket issued by Authlete's /auth/authorization API to the service implementation.

Parameters:

ticket - The ticket.

Returns:

this object.

getReason

public AuthorizationFailRequest.Reason getReason()

Get the value of "reason" which is the reason of the failure of the authorization request.

Returns:

The reason of the failure.

setReason

public AuthorizationFailRequest setReason(AuthorizationFailRequest.Reason reason)

Set the value of "reason" which is the reason of the failure of the authorization request.

Parameters:

reason - The reason of the failure.

Returns:

this object.

getDescription

public String getDescription()

Get the custom description about the authorization failure.

Returns:

The custom description.

Since:

1.3

setDescription

public AuthorizationFailRequest setDescription(String description)

Set the custom description about the authorization failure.

Parameters:

description - The custom description.

Returns:

this object.

Since:

1.3