com.authlete.jaxrs

Class AuthorizationPageModel

java.lang.Object

com.authlete.jaxrs.AuthorizationPageModel

All Implemented Interfaces:

Serializable

public class AuthorizationPageModel
extends Object
implements Serializable

Model class to hold data which are referred to in an authorization page.

Feel free to extend this class as necessary.

Author:

Takahiko Kawasaki

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AuthorizationPageModel() The default constructor with default values.
AuthorizationPageModel(com.authlete.common.dto.AuthorizationResponse info) Create an AuthorizationPageModel instance using information contained in an AuthorizationResponse object, which represents a response from Authlete's /api/auth/authorization API.

Method Summary

Modifier and Type	Method and Description
String	getClientName() Get the name of the client application.
String	getClientUri() Get the URL of the homepage of the client application.
String	getDescription() Get the description of the client application.
String	getLoginId() Get the login ID which should be set to the login ID field in the authorization page as the initial value.
String	getLoginIdReadOnly() Return "readonly" if the initial value of the login ID should not be changed.
String	getLogoUri() Get the URL of the logo image of the client application.
String	getPolicyUri() Get the URL of the policy page of the client application.
com.authlete.common.dto.Scope[]	getScopes() Get the list of scopes requested by the authorization request.
String	getServiceName() Get the name of the service.
String	getTosUri() Get the URL of "Terms of Service" page of the client application.
AuthorizationPageModel	setClientName(String clientName) Set the name of the client application.
AuthorizationPageModel	setClientUri(String clientUri) Set the URL of the homepage of the client application.
AuthorizationPageModel	setDescription(String description) Set the description of the client application.
AuthorizationPageModel	setLoginId(String loginId) Set the login ID which should be set to the login ID field in the authorization page as the initial value.
AuthorizationPageModel	setLoginIdReadOnly(String loginIdReadOnly) Set the value returned from getLoginIdReadOnly().
AuthorizationPageModel	setLogoUri(String logoUri) Set the URL of the logo image of the client application.
AuthorizationPageModel	setPolicyUri(String policyUri) Set the URL of the policy page of the client application.
AuthorizationPageModel	setScopes(com.authlete.common.dto.Scope[] scopes) Set the list of scopes requested by the authorization request.
AuthorizationPageModel	setServiceName(String serviceName) Set the name of the service.
AuthorizationPageModel	setTosUri(String tosUri) Set the URL of "Terms of Service" page of the client application.

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthorizationPageModel

public AuthorizationPageModel()

The default constructor with default values.

AuthorizationPageModel

public AuthorizationPageModel(com.authlete.common.dto.AuthorizationResponse info)

Create an AuthorizationPageModel instance using information contained in an AuthorizationResponse object, which represents a response from Authlete's /api/auth/authorization API.

Parameters:

info - An AuthorizationResponse object, which represents a response from Authlete's /api/auth/authorization API.

Method Detail

getServiceName

public String getServiceName()

Get the name of the service.

Returns:

The name of the service.

setServiceName

public AuthorizationPageModel setServiceName(String serviceName)

Set the name of the service.

Parameters:

serviceName - The name of the service.

Returns:

this object.

getClientName

public String getClientName()

Get the name of the client application.

Returns:

The name of the client application.

setClientName

public AuthorizationPageModel setClientName(String clientName)

Set the name of the client application.

Parameters:

clientName - The name of the client application.

Returns:

this object.

getDescription

public String getDescription()

Get the description of the client application.

Returns:

The description of the client application.

setDescription

public AuthorizationPageModel setDescription(String description)

Set the description of the client application.

Parameters:

description - The description of the client application.

Returns:

this object.

getLogoUri

public String getLogoUri()

Get the URL of the logo image of the client application.

Returns:

The URL of the logo image of the client application.

setLogoUri

public AuthorizationPageModel setLogoUri(String logoUri)

Set the URL of the logo image of the client application.

Parameters:

logoUri - The URL of the logo image of the client application.

Returns:

this object.

getClientUri

public String getClientUri()

Get the URL of the homepage of the client application.

Returns:

The URL of the homepage of the client application.

setClientUri

public AuthorizationPageModel setClientUri(String clientUri)

Set the URL of the homepage of the client application.

Parameters:

clientUri - The URL of the homepage of the client application.

Returns:

this object.

getPolicyUri

public String getPolicyUri()

Get the URL of the policy page of the client application.

Returns:

The URL of the policy page of the client application.

setPolicyUri

public AuthorizationPageModel setPolicyUri(String policyUri)

Set the URL of the policy page of the client application.

Parameters:

policyUri - The URL of the policy page of the client application.

Returns:

this object.

getTosUri

public String getTosUri()

Get the URL of "Terms of Service" page of the client application.

Returns:

The URL of "Terms of Service" page of the client application.

setTosUri

public AuthorizationPageModel setTosUri(String tosUri)

Set the URL of "Terms of Service" page of the client application.

Parameters:

tosUri - The URL of "Terms of Service" page of the client application.

Returns:

this object.

getScopes

public com.authlete.common.dto.Scope[] getScopes()

Get the list of scopes requested by the authorization request.

Returns:

The list of requested scopes.

setScopes

public AuthorizationPageModel setScopes(com.authlete.common.dto.Scope[] scopes)

Set the list of scopes requested by the authorization request.

Parameters:

scopes - The list of requested scopes.

Returns:

this object.

getLoginId

public String getLoginId()

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

Returns:

The initial value of the login ID.

setLoginId

public AuthorizationPageModel setLoginId(String loginId)

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

Parameters:

loginId - The initial value of the login ID.

Returns:

this object.

getLoginIdReadOnly

public String getLoginIdReadOnly()

Return "readonly" if the initial value of the login ID should not be changed.

Returns:

"readonly" if the initial value of the login ID should not be changed. Otherwise, null.

setLoginIdReadOnly

public AuthorizationPageModel setLoginIdReadOnly(String loginIdReadOnly)

Set the value returned from getLoginIdReadOnly().

Parameters:

loginIdReadOnly - Pass "readonly" if the initial value of the login ID should not be changed. Otherwise, pass null.

Returns:

this object.