Package com.authlete.common.dto

Class TokenListResponse

java.lang.Object

com.authlete.common.dto.TokenListResponse

All Implemented Interfaces:

Serializable

public class TokenListResponse
extends Object
implements Serializable

Response from Authlete's /auth/token/get/list API.

Since:

2.22, Authlete 1.1.21

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
TokenListResponse()

Method Summary

Modifier and Type	Method	Description
AccessToken[]	getAccessTokens()	Get the list of access tokens that match the query conditions.
Client	getClient()	Get the client information associated with the value of 'clientIdentifier' parameter in the original request.
int	getEnd()	Get the end index (exclusive) for the result set of the query.
int	getStart()	Get the start index (inclusive) for the result set of the query.
String	getSubject()	Get the value of 'subject' parameter in the original request.
int	getTotalCount()	Get the total count of access tokens.
TokenListResponse	setAccessTokens(AccessToken[] accessTokens)	Set the list of access tokens that match the query conditions.
TokenListResponse	setClient(Client client)	Set the client information associated with the value of 'clientIdentifier' parameter in the original request.
TokenListResponse	setEnd(int end)	Set the end index (exclusive) for the result set of the query.
TokenListResponse	setStart(int start)	Set the start index (inclusive) for the result set of the query.
TokenListResponse	setSubject(String subject)	Set the value of 'subject' parameter in the original request.
TokenListResponse	setTotalCount(int count)	Set the total count of access tokens.

Methods inherited from class java.lang.Object

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

Constructor Detail

TokenListResponse

public TokenListResponse()

Method Detail

getStart

public int getStart()

Get the start index (inclusive) for the result set of the query. It is the value contained in the original request (= the value of 'start' parameter), or the default value (0) if the original request did not contain the parameter.

Returns:

The start index for the result set of the query.

setStart

public TokenListResponse setStart(int start)

Set the start index (inclusive) for the result set of the query.

Parameters:

start - The start index for the result set of the query.

Returns:

this object.

getEnd

public int getEnd()

Get the end index (exclusive) for the result set of the query. It is the value contained in the original request (= the value of 'end' parameter), or the default value defined in Authlete server if the original request did not contain the parameter.

Returns:

The end index for the result set of the query.

setEnd

public TokenListResponse setEnd(int end)

Set the end index (exclusive) for the result set of the query.

Parameters:

end - The end index for the result set of the query.

Returns:

this object.

getClient

public Client getClient()

Get the client information associated with the value of 'clientIdentifier' parameter in the original request. If the original request did not contain the parameter, this method returns null.

Returns:

The client information associated with the value of 'clientIdentifier' parameter in the original request. null is returned if the original request did not contain the parameter.

setClient

public TokenListResponse setClient(Client client)

Set the client information associated with the value of 'clientIdentifier' parameter in the original request.

Parameters:

client - The client information associated with the value of 'clientIdentifier' parameter in the original request.

Returns:

this object.

getSubject

public String getSubject()

Get the value of 'subject' parameter in the original request. If the original request did not contain the parameter, this method returns null.

Returns:

The value of 'subject' parameter in the original request. null is returned if the original request did not contain the parameter.

setSubject

public TokenListResponse setSubject(String subject)

Set the value of 'subject' parameter in the original request.

Parameters:

subject - The value of 'subject' parameter in the original request.

Returns:

this object.

getTotalCount

public int getTotalCount()

Get the total count of access tokens. The meaning of the total count changes depending on the situation as follows.

1. When the value of 'clientIdentifier' parameter is null and the value of 'subject' parameter is null in the original request, it means the total count of the access tokens associated with the service.
2. When the value of 'clientIdentifier' parameter is null and the value of 'subject' parameter is not null in the original request, it means the total count of the access tokens associated with the subject.
3. When the value of 'clientIdentifier' parameter is not null and the value of 'subject' parameter is null in the original request, it means the total count of the access tokens associated with the client application.
4. When the value of 'clientIdentifier' parameter is not null and the value of 'subject' parameter is not null in the original request, it means the total count of the access tokens associated with the client application and the subject.

Returns:

The total count of access tokens.

setTotalCount

public TokenListResponse setTotalCount(int count)

Set the total count of access tokens. The meaning of the total count changes depending on the situation. See getTotalCount() for more details.

Returns:

this object.

getAccessTokens

public AccessToken[] getAccessTokens()

Get the list of access tokens that match the query conditions.

Returns:

List of access tokens, or null when no access tokens matched the query conditions.

setAccessTokens

public TokenListResponse setAccessTokens(AccessToken[] accessTokens)

Set the list of access tokens that match the query conditions.

Parameters:

clients - List of access tokens, or null when no access tokens matched the query conditions.

Returns:

this object.