com.authlete.common.dto

Class TokenFailRequest

java.lang.Object

com.authlete.common.dto.TokenFailRequest

All Implemented Interfaces:

Serializable

public class TokenFailRequest
extends Object
implements Serializable

Request for Authlete's /auth/token/fail API.

ticket (REQUIRED)

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

reason (REQUIRED)

The reason of the failure of the token request. See the description of TokenResponse as to which reason should be chosen.

Author:

Takahiko Kawasaki

See Also:

TokenResponse, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TokenFailRequest.Reason Failure reasons of token requests.

Constructor Summary

Constructors

Constructor and Description
TokenFailRequest()

Method Summary

Modifier and Type	Method and Description
TokenFailRequest.Reason	getReason() Get the value of "reason" which is the reason of the failure of the token request.
String	getTicket() Get the value of "ticket" which is the ticket issued by Authlete's /auth/token API to the service implementation.
TokenFailRequest	setReason(TokenFailRequest.Reason reason) Set the value of "reason" which is the reason of the failure of the token request.
TokenFailRequest	setTicket(String ticket) Set the value of "ticket" which is the ticket issued by Authlete's /auth/token 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

TokenFailRequest

public TokenFailRequest()

Method Detail

getTicket

public String getTicket()

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

Returns:

The ticket.

setTicket

public TokenFailRequest setTicket(String ticket)

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

Parameters:

ticket - The ticket.

Returns:

this object.

getReason

public TokenFailRequest.Reason getReason()

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

Returns:

The reason of the failure.

setReason

public TokenFailRequest setReason(TokenFailRequest.Reason reason)

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

Parameters:

reason - The reason of the failure.

Returns:

this object.