com.authlete.common.dto

Class TokenUpdateRequest

java.lang.Object

com.authlete.common.dto.TokenUpdateRequest

All Implemented Interfaces:

Serializable

public class TokenUpdateRequest
extends Object
implements Serializable

Request to Authlete's /auth/token/update API.

The API is used to update an existing access token.

accessToken

An existing access token.

accessTokenExpiresAt

A new date at which the access token will expire in milliseconds since the Unix epoch (1970-01-01). If the accessTokenExpiresAt request parameter is not included in a request or its value is 0 (or negative), the expiration date of the access token is not changed.

scopes

A new set of scopes assigned to the access token. Scopes that are not supported by the service and those that the client application associated with the access token is not allowed to request are ignored on the server side. If the scopes request parameter is not included in a request or its value is null, the scopes of the access token are not changed.

properties

A new set of properties assigned to the access token. If the properties request parameter is not included in a request or its value is null, the properties of the access token are not changed.

Since:

1.34

Author:

Takahiko Kawasaki

See Also:

TokenUpdateResponse, Serialized Form

Constructor Summary

Constructors

Constructor and Description
TokenUpdateRequest()

Method Summary

Modifier and Type	Method and Description
String	getAccessToken() Get the access token to update.
long	getAccessTokenExpiresAt() Get the new date at which the access token will expire.
Property[]	getProperties() Get a new set of properties assigned to the access token.
String[]	getScopes() Get the new set of scopes assigned to the access token.
TokenUpdateRequest	setAccessToken(String accessToken) Set an existing access token to update.
TokenUpdateRequest	setAccessTokenExpiresAt(long expiresAt) Set the new date at which the access token will expire.
TokenUpdateRequest	setProperties(Property[] properties) Set a new set of properties assigned to the access token.
TokenUpdateRequest	setScopes(String[] scopes) Set a new set of scopes assigned to the access token.

Methods inherited from class java.lang.Object

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

Constructor Detail

TokenUpdateRequest

public TokenUpdateRequest()

Method Detail

getAccessToken

public String getAccessToken()

Get the access token to update.

Returns:

The access token to update.

setAccessToken

public TokenUpdateRequest setAccessToken(String accessToken)

Set an existing access token to update.

Parameters:

accessToken - An existing access token to update.

Returns:

this object.

getAccessTokenExpiresAt

public long getAccessTokenExpiresAt()

Get the new date at which the access token will expire.

Returns:

The new expiration date in milliseconds since the Unix epoch (1970-01-01).

setAccessTokenExpiresAt

public TokenUpdateRequest setAccessTokenExpiresAt(long expiresAt)

Set the new date at which the access token will expire.

If 0 or a negative value is given, the expiration date of the access token is not changed.

Parameters:

expiresAt - The new expiration date in milliseconds since the Unix epoch (1970-01-01).

Returns:

this object.

getScopes

public String[] getScopes()

Get the new set of scopes assigned to the access token.

Returns:

The new set of scopes.

setScopes

public TokenUpdateRequest setScopes(String[] scopes)

Set a new set of scopes assigned to the access token.

If null is given, the scope set associated with the access token is not changed.

Parameters:

scopes - A new set of scopes. null means that scopes are not changed.

Returns:

this object.

getProperties

public Property[] getProperties()

Get a new set of properties assigned to the access token.

Returns:

A new set of properties.

setProperties

public TokenUpdateRequest setProperties(Property[] properties)

Set a new set of properties assigned to the access token.

If null is given, the property set associated with the access token is not changed.

Parameters:

properties - A new set of properties. null means that properties are not changed.

Returns:

this object.