Package com.atlassian.oauth2.client.api.storage.token

Interface ClientTokenStorageService

public interface ClientTokenStorageService

Method Summary

Modifier and Type	Method	Description
void	delete(String id)
List<ClientTokenEntity>	getAccessTokensExpiringBefore(Instant timestamp)
Optional<ClientTokenEntity>	getById(String id)
ClientTokenEntity	getByIdOrFail(String id)
List<ClientTokenEntity>	getRefreshTokensExpiringBefore(Instant timestamp)
ClientTokenEntity	save(ClientTokenEntity clientTokenEntity)	Creates or updates the ClientTokenEntity

Method Details

save

@Nonnull
ClientTokenEntity save(@Nonnull
 ClientTokenEntity clientTokenEntity)
                throws TokenNotFoundException

Creates or updates the ClientTokenEntity

Parameters:

clientTokenEntity - the entity to create

Returns:

The saved entity, with the ID if created

Throws:

TokenNotFoundException - if the token for the given id wasn't found

delete

void delete(@Nonnull
 String id)
     throws TokenNotFoundException

Parameters:

id - of the ClientTokenEntity to delete

Throws:

TokenNotFoundException - if the token for the given id wasn't found

getById

@Nonnull
Optional<ClientTokenEntity> getById(@Nonnull
 String id)

Parameters:

id - of the ClientTokenEntity from the store

Returns:

The ClientTokenEntity from the store for the id, or Optional.empty()

getByIdOrFail

@Nonnull
ClientTokenEntity getByIdOrFail(@Nonnull
 String id)
                         throws TokenNotFoundException

Parameters:

id - of the ClientTokenEntity from the store

Returns:

The ClientTokenEntity from the store for the id

Throws:

TokenNotFoundException - if the token for the given id wasn't found

getAccessTokensExpiringBefore

@Nonnull
List<ClientTokenEntity> getAccessTokensExpiringBefore(@Nonnull
 Instant timestamp)

Returns:

All the saved ClientTokenEntity access tokens expiring before the timestamp, or an empty list

getRefreshTokensExpiringBefore

@Nonnull
List<ClientTokenEntity> getRefreshTokensExpiringBefore(@Nonnull
 Instant timestamp)

Returns:

All the saved ClientTokenEntity refresh tokens expiring before the timestamp, or an empty list