com.authlete.common.dto

Class ClientAuthorizationGetListRequest

java.lang.Object

com.authlete.common.dto.ClientAuthorizationGetListRequest

All Implemented Interfaces:

Serializable

public class ClientAuthorizationGetListRequest
extends Object
implements Serializable

Request to Authlete's /api/client/authorization/get/list API.

The API returns a list of client applications to which an end-user has given authorization.

subject

The subject (= unique identifier) of the end-user who has granted authorization to the client application.

start

Start index of search results (inclusive). The default value is DEFAULT_START (= 0).

end

End index of search results (exclusive). The default value is DEFAULT_END (= 5).

developer

Unique developer ID. The default value is DEFAULT_DEVELOPER (= null).

Since:

2.1

Author:

Takahiko Kawasaki

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_DEVELOPER The default value of developer (= null).
static int	DEFAULT_END The default value of end (= 5).
static int	DEFAULT_START The default value of start (= 0).

Constructor Summary

Constructors

Constructor and Description
ClientAuthorizationGetListRequest() The default constructor.
ClientAuthorizationGetListRequest(String subject) A constructor with a subject value.
ClientAuthorizationGetListRequest(String subject, int start, int end) A constructor with a subject value, a start index and an end index of search results.
ClientAuthorizationGetListRequest(String subject, String developer) A constructor with a subject value and a developer value.
ClientAuthorizationGetListRequest(String subject, String developer, int start, int end) A constructor with all request parameters.

Method Summary

Modifier and Type	Method and Description
String	getDeveloper() Get the developer of client applications.
int	getEnd() Get the end index of search results (exclusive).
int	getStart() Get the start index of search results (inclusive).
String	getSubject() Get the subject (= unique identifier) of the end-user.
ClientAuthorizationGetListRequest	setDeveloper(String developer) Set the developer of client applications.
ClientAuthorizationGetListRequest	setEnd(int end) Set the end index of search results (exclusive).
ClientAuthorizationGetListRequest	setStart(int start) Set the start index of search results (inclusive).
ClientAuthorizationGetListRequest	setSubject(String subject) Set the subject (= unique identifier) of the end-user.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_DEVELOPER

public static final String DEFAULT_DEVELOPER

The default value of developer (= null).

DEFAULT_START

public static final int DEFAULT_START

The default value of start (= 0).

See Also:

Constant Field Values

DEFAULT_END

public static final int DEFAULT_END

The default value of end (= 5).

See Also:

Constant Field Values

Constructor Detail

ClientAuthorizationGetListRequest

public ClientAuthorizationGetListRequest()

The default constructor. This constructor is an alias of this(null, DEFAULT_DEVELOPER, DEFAULT_START, DEFAULT_END). Because the subject parameter is mandatory for /api/client/authorization/get/list API, a non-null value should be set using setSubject(String) method later.

ClientAuthorizationGetListRequest

public ClientAuthorizationGetListRequest(String subject)

A constructor with a subject value. This constructor is an alias of this(subject, DEFAULT_DEVELOPER, DEFAULT_START, DEFAULT_END).

Parameters:

subject - Unique identifier of an end-user.

ClientAuthorizationGetListRequest

public ClientAuthorizationGetListRequest(String subject,
                                         String developer)

A constructor with a subject value and a developer value. This constructor is an alias of this(subject, developer, DEFAULT_START, DEFAULT_END).

Parameters:

subject - Unique identifier of an end-user.

developer - Unique identifier of a developer. If a non-null value is given, client applications which do not belong to the developer won't be included in a response from the API.

ClientAuthorizationGetListRequest

public ClientAuthorizationGetListRequest(String subject,
                                         int start,
                                         int end)

A constructor with a subject value, a start index and an end index of search results. This constructor is an alias of this(subject, DEFAULT_DEVELOPER, start, end).

Parameters:

subject - Unique identifier of an end-user.

start - Start index of search results (inclusive).

end - End index of search results (exclusive).

ClientAuthorizationGetListRequest

public ClientAuthorizationGetListRequest(String subject,
                                         String developer,
                                         int start,
                                         int end)

A constructor with all request parameters.

Parameters:

subject - Unique identifier of an end-user.

developer - Unique identifier of a developer. If a non-null value is given, client applications which do not belong to the developer won't be included in a response from the API.

start - Start index of search results (inclusive).

end - End index of search results (exclusive).

Method Detail

getSubject

public String getSubject()

Get the subject (= unique identifier) of the end-user.

Returns:

The subject (= unique identifier) of the end-user.

setSubject

public ClientAuthorizationGetListRequest setSubject(String subject)

Set the subject (= unique identifier) of the end-user.

Parameters:

subject - The subject of the end-user.

Returns:

this object.

getDeveloper

public String getDeveloper()

Get the developer of client applications.

Returns:

The developer of client applications. This may be null.

setDeveloper

public ClientAuthorizationGetListRequest setDeveloper(String developer)

Set the developer of client applications.

Parameters:

developer - The developer of client applications. If a non-null value is given, client applications which do not belong to the developer won't be included in a response from the API.

Returns:

this object.

getStart

public int getStart()

Get the start index of search results (inclusive).

Returns:

The start index of search results (inclusive).

setStart

public ClientAuthorizationGetListRequest setStart(int start)

Set the start index of search results (inclusive).

Parameters:

start - The start index of search results (inclusive).

Returns:

this object.

getEnd

public int getEnd()

Get the end index of search results (exclusive).

Returns:

The end index of search results (exclusive).

setEnd

public ClientAuthorizationGetListRequest setEnd(int end)

Set the end index of search results (exclusive).

Parameters:

end - The end index of search results (exclusive).

Returns:

this object.