Package com.authlete.jaxrs

Class DeviceVerificationPageModel

java.lang.Object

com.authlete.jaxrs.DeviceVerificationPageModel

All Implemented Interfaces:

Serializable

public class DeviceVerificationPageModel
extends Object
implements Serializable

Model class to hold data which are referred to in an verification page in device flow.

Feel free to extend this class as necessary.

Since:

2.18

Author:

Hideki Ikeda

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
DeviceVerificationPageModel()	The default constructor with default values.
DeviceVerificationPageModel(String loginId, String userCode, com.authlete.common.types.User user, String notification)	Create an DeviceVerificationPageModel instance using given parameters.

Method Summary

Modifier and Type	Method	Description
String	getLoginId()	Get the login ID which should be set to the login ID field in the verification page as the initial value.
String	getNotification()	Get the notification that should be shown in the verification page.
com.authlete.common.types.User	getUser()	Get the currently logged in user, could be null if no user is logged in.
String	getUserCode()	Get the user code should be set to the user code field in the verification page as the initial value.
DeviceVerificationPageModel	setLoginId(String loginId)	Set the login ID which should be set to the login ID field in the verification page as the initial value.
DeviceVerificationPageModel	setNotification(String notification)	Set the notification that should be shown in the verification page.
DeviceVerificationPageModel	setUser(com.authlete.common.types.User user)	Set the currently logged in user.
DeviceVerificationPageModel	setUserCode(String userCode)	Set the user code should be set to the user code field in the verification page as the initial value.

Methods inherited from class java.lang.Object

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

Constructor Detail

DeviceVerificationPageModel

public DeviceVerificationPageModel()

The default constructor with default values.

DeviceVerificationPageModel

public DeviceVerificationPageModel(String loginId,
                                   String userCode,
                                   com.authlete.common.types.User user,
                                   String notification)

Create an DeviceVerificationPageModel instance using given parameters.

Parameters:

loginId - The login ID that should be used as the initial value for the login ID field in the verification page.

userCode - The user code that should be used as the initial value for the user code field in the verification page.

user - The currently logged in user.

notification - The notification that should be shown in the verification page.

Method Detail

getLoginId

public String getLoginId()

Get the login ID which should be set to the login ID field in the verification page as the initial value.

Returns:

The initial value of the login ID.

setLoginId

public DeviceVerificationPageModel setLoginId(String loginId)

Set the login ID which should be set to the login ID field in the verification page as the initial value.

Parameters:

loginId - The initial value of the login ID.

Returns:

this object.

getUserCode

public String getUserCode()

Get the user code should be set to the user code field in the verification page as the initial value.

Returns:

The initial value of the user code.

setUserCode

public DeviceVerificationPageModel setUserCode(String userCode)

Set the user code should be set to the user code field in the verification page as the initial value.

Parameters:

userCode - The initial value of the user code.

Returns:

this object.

getUser

public com.authlete.common.types.User getUser()

Get the currently logged in user, could be null if no user is logged in.

Returns:

The currently logged in user.

setUser

public DeviceVerificationPageModel setUser(com.authlete.common.types.User user)

Set the currently logged in user.

Parameters:

user - The currently logged in user.

Returns:

this object.

getNotification

public String getNotification()

Get the notification that should be shown in the verification page.

Returns:

The notification that should be shown in the verification page.

setNotification

public DeviceVerificationPageModel setNotification(String notification)

Set the notification that should be shown in the verification page.

Parameters:

notification - The notification that should be shown in the verification page.

Returns:

this object.