Class InMemoryOAuth2AuthorizationService

java.lang.Object

com.codename1.backend.security.oauth2.server.authorization.InMemoryOAuth2AuthorizationService

All Implemented Interfaces:

OAuth2AuthorizationService

public final class InMemoryOAuth2AuthorizationService
extends Object
implements OAuth2AuthorizationService

Grants kept in this process: gone when it stops, and unknown to any other. For development, tests and a server that runs as one process and can lose its refresh tokens on a restart; see JdbcOAuth2AuthorizationService.

Nested Class Summary

Nested classes/interfaces inherited from interface OAuth2AuthorizationService

OAuth2AuthorizationService.StoredToken

Field Summary

Fields inherited from interface OAuth2AuthorizationService

CODE, DEVICE_CODE, REFRESH_TOKEN, USER_CODE

Constructor Summary

Constructors

Constructor	Description
InMemoryOAuth2AuthorizationService()

Method Summary

Modifier and Type	Method	Description
void	addToken(String authorizationId, String kind, String tokenHash, long expiresAt)	Records a secret issued under a grant.
boolean	consumeToken(String kind, String tokenHash, long now)	Uses a secret up, if it is there, unused and has not expired at now, and records now as when.
boolean	decide(String id, boolean approved, String principalName, Map<String,Object> attributes)	Answers a device grant that is OAuth2Authorization.PENDING: makes it OAuth2Authorization.ACTIVE for principalName, or OAuth2Authorization.DENIED.
boolean	extendToken(String kind, String tokenHash, long now, long expiresAt)	Extends an unused, unexpired token to at least expiresAt, atomically.
OAuth2Authorization	findById(String id)	The grant with this id, or null: one that was removed is revoked.
OAuth2AuthorizationService.StoredToken	findToken(String kind, String tokenHash)	What is stored for a secret, whatever its state; null when nothing is.
boolean	issueTokens(String authorizationId, long now, long expiresAt, String refreshTokenHash, boolean reuse)	Issues tokens only while an active, unexpired grant still exists.
boolean	pollToken(String kind, String tokenHash, long now, long intervalMillis)	Claims a polling interval on an unused, unexpired token.
int	purgeExpired(long now, int limit)	Forgets up to limit grants and secrets that expired before now.
void	remove(String id)	Removes the grant and every secret issued under it.
void	save(OAuth2Authorization authorization)	Stores authorization, in place of the one with its id if there is one.
void	touchToken(String kind, String tokenHash, long now)	Records that a secret was presented at now, without checking its previous timestamp.

Methods inherited from class Object

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

Constructor Details

InMemoryOAuth2AuthorizationService

public InMemoryOAuth2AuthorizationService()

Method Details

save

public void save(OAuth2Authorization authorization)

Description copied from interface: OAuth2AuthorizationService

Stores authorization, in place of the one with its id if there is one.

Specified by:

save in interface OAuth2AuthorizationService

findById

public OAuth2Authorization findById(String id)

Description copied from interface: OAuth2AuthorizationService

The grant with this id, or null: one that was removed is revoked.

Specified by:

findById in interface OAuth2AuthorizationService

remove

public void remove(String id)

Description copied from interface: OAuth2AuthorizationService

Removes the grant and every secret issued under it.

Specified by:

remove in interface OAuth2AuthorizationService

addToken

public void addToken(String authorizationId,
 String kind,
 String tokenHash,
 long expiresAt)

Description copied from interface: OAuth2AuthorizationService

Records a secret issued under a grant.

Specified by:

addToken in interface OAuth2AuthorizationService

Parameters:

kind - OAuth2AuthorizationService.CODE, OAuth2AuthorizationService.REFRESH_TOKEN, OAuth2AuthorizationService.DEVICE_CODE or OAuth2AuthorizationService.USER_CODE

tokenHash - the SHA-256 of the secret

expiresAt - epoch milliseconds

issueTokens

public boolean issueTokens(String authorizationId,
 long now,
 long expiresAt,
 String refreshTokenHash,
 boolean reuse)

Description copied from interface: OAuth2AuthorizationService

Issues tokens only while an active, unexpired grant still exists. Extending the grant and adding or extending its refresh token must be one atomic operation with respect to OAuth2AuthorizationService.remove(String), including across server processes. A removed grant must never be recreated. Custom stores must implement this operation before issuing user tokens; the default fails closed.

Specified by:

issueTokens in interface OAuth2AuthorizationService

Parameters:

refreshTokenHash - null when no refresh token is issued

reuse - whether the hash names an existing unused, unexpired refresh token

Returns:

false when the grant or reused refresh token is no longer valid

findToken

public OAuth2AuthorizationService.StoredToken findToken(String kind,
 String tokenHash)

Description copied from interface: OAuth2AuthorizationService

What is stored for a secret, whatever its state; null when nothing is.

Specified by:

findToken in interface OAuth2AuthorizationService

consumeToken

public boolean consumeToken(String kind,
 String tokenHash,
 long now)

Description copied from interface: OAuth2AuthorizationService

Uses a secret up, if it is there, unused and has not expired at now, and records now as when.

Specified by:

consumeToken in interface OAuth2AuthorizationService

Returns:

whether THIS call used it up

touchToken

public void touchToken(String kind,
 String tokenHash,
 long now)

Description copied from interface: OAuth2AuthorizationService

Records that a secret was presented at now, without checking its previous timestamp. Use OAuth2AuthorizationService.pollToken(String, String, long, long) to enforce a polling interval.

Specified by:

touchToken in interface OAuth2AuthorizationService

pollToken

public boolean pollToken(String kind,
 String tokenHash,
 long now,
 long intervalMillis)

Description copied from interface: OAuth2AuthorizationService

Claims a polling interval on an unused, unexpired token. Checking the previous poll and recording now must be one atomic operation, including across processes sharing a database. Rejected polls do not claim an interval. Custom stores must implement this before enabling the device grant.

Specified by:

pollToken in interface OAuth2AuthorizationService

Parameters:

intervalMillis - the minimum time between accepted polls, greater than zero

Returns:

whether this call claimed the interval

extendToken

public boolean extendToken(String kind,
 String tokenHash,
 long now,
 long expiresAt)

Description copied from interface: OAuth2AuthorizationService

Extends an unused, unexpired token to at least expiresAt, atomically. Returns false if it is missing, used or expired at now. Custom stores must implement this before enabling refresh token reuse.

Specified by:

extendToken in interface OAuth2AuthorizationService

decide

public boolean decide(String id,
 boolean approved,
 String principalName,
 Map<String,Object> attributes)

Description copied from interface: OAuth2AuthorizationService

Answers a device grant that is OAuth2Authorization.PENDING: makes it OAuth2Authorization.ACTIVE for principalName, or OAuth2Authorization.DENIED.

Specified by:

decide in interface OAuth2AuthorizationService

Parameters:

attributes - what to remember of the user who approved, merged into the grant's own

Returns:

whether THIS call answered it

purgeExpired

public int purgeExpired(long now,
 int limit)

Description copied from interface: OAuth2AuthorizationService

Forgets up to limit grants and secrets that expired before now.

Specified by:

purgeExpired in interface OAuth2AuthorizationService

Returns:

how many were forgotten