com.authlete.common.dto

Class AuthorizationAuthenticateRequest

java.lang.Object

com.authlete.common.dto.AuthorizationAuthenticateRequest

All Implemented Interfaces:

Serializable

public class AuthorizationAuthenticateRequest
extends Object
implements Serializable

Request to Authlete's /auth/authorization/authenticate 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).

loginId (REQUIRED)

The login ID of the end-user to authenticate.

password (REQUIRED)

The password of the end-user to authenticate.

claims (OPTIONAL)

A space-delimited names of claims to request.

claimsLocales (OPTIONAL)

A space-delimited locales for claims.

Author:

Takahiko Kawasaki

See Also:

AuthorizationResponse, Serialized Form

Constructor Summary

Constructors

Constructor and Description
AuthorizationAuthenticateRequest()

Method Summary

Modifier and Type	Method and Description
String	getClaims() Get the space-delimited names of claims to request.
String	getClaimsLocales() Get the space-delimited locales for claims.
String	getLoginId() Get the login ID of the end-user to authenticate.
String	getPassword() Get the password of the end-user to authenticate.
String	getTicket() Get the value of "ticket" which is the ticket issued by Authlete's /auth/authorization API to the service implementation.
AuthorizationAuthenticateRequest	setClaims(String claims) Set the space-delimited names of claims to request.
AuthorizationAuthenticateRequest	setClaimsLocales(String claimsLocales) Set the space-delimited locales for claims.
AuthorizationAuthenticateRequest	setLoginId(String loginId) Set the login ID of the end-user to authenticate.
AuthorizationAuthenticateRequest	setPassword(String password) Set the password of the end-user to authenticate.
AuthorizationAuthenticateRequest	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

AuthorizationAuthenticateRequest

public AuthorizationAuthenticateRequest()

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 AuthorizationAuthenticateRequest 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.

getLoginId

public String getLoginId()

Get the login ID of the end-user to authenticate.

Returns:

The login ID of the end-user to authenticate.

setLoginId

public AuthorizationAuthenticateRequest setLoginId(String loginId)

Set the login ID of the end-user to authenticate.

Parameters:

loginId - The login ID of the end-user to authenticate.

Returns:

this object.

getPassword

public String getPassword()

Get the password of the end-user to authenticate.

Returns:

The password of the end-user to authenticate.

setPassword

public AuthorizationAuthenticateRequest setPassword(String password)

Set the password of the end-user to authenticate.

Parameters:

password - The password of the end-user to authenticate.

Returns:

this object.

getClaims

public String getClaims()

Get the space-delimited names of claims to request.

Returns:

The space-delimited names of claims to request.

setClaims

public AuthorizationAuthenticateRequest setClaims(String claims)

Set the space-delimited names of claims to request.

Parameters:

claims - The space-delimited names of claims to request.

Returns:

this object.

getClaimsLocales

public String getClaimsLocales()

Get the space-delimited locales for claims.

Returns:

The space-delimited locales for claims.

setClaimsLocales

public AuthorizationAuthenticateRequest setClaimsLocales(String claimsLocales)

Set the space-delimited locales for claims.

Parameters:

claimsLocales - The space-delimited locales for claims.

Returns:

this object.