org.assistments.service.security

Interface AccessTokenManager

All Known Implementing Classes:

AccessTokenManagerImpl

public interface AccessTokenManager

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	AccessTokenManager.UpdateField

Method Summary

Modifier and Type	Method and Description
AccessToken	findByToken(java.lang.String appRef, java.lang.String accessTokenStr)
java.lang.String	findByXRef(java.lang.String appRef, XInfoImpl xInfo) Returns the access token for the specified application partner, user pair
java.time.Instant	getExpiration(java.lang.String appRef, java.lang.String accessTokenStr)
ExternalReference	getXRef(java.lang.String accessTokenStr) Returns the access token for the specified application partner, user pair
int	getXUserId(java.lang.String appRef, java.lang.String accessTokenStr) Returns the external user ID for the specified application partner, access token pair.
void	invalidateToken(java.lang.String appRef, java.lang.String accessTokenStr)
boolean	isExpired(java.lang.String appRef, java.lang.String accessTokenStr)
java.lang.String	persist(java.lang.String partnerRef, XInfoImpl xInfo)
java.lang.String	persist(XInfoImpl xInfo) Creates, stores, and returns an access token for the specified user for the current partner.
void	purge(int unusedDays) Delete your application's access tokens that have been unused for a specified number of days.
void	purge(java.lang.String appRef, int unusedDays) For an admin application: Delete tokens that have been unused for a specified number of days.
java.lang.String	renewToken(java.lang.String appRef, java.lang.String accessTokenStr)

Method Detail

persist

java.lang.String persist(XInfoImpl xInfo)
                  throws NotFoundException

Creates, stores, and returns an access token for the specified user for the current partner.

Parameters:

xInfo - A User's XPair

Returns:

Created access token

Throws:

NotFoundException

persist

java.lang.String persist(java.lang.String partnerRef,
                         XInfoImpl xInfo)
                  throws NotFoundException

Throws:

NotFoundException

getXUserId

int getXUserId(java.lang.String appRef,
               java.lang.String accessTokenStr)
        throws NotFoundException

Returns the external user ID for the specified application partner, access token pair.

Parameters:

appRef - Application partner reference

accessTokenStr - Access token

Returns:

external user ID

Throws:

NotFoundException

InvalidPartnerException

getXRef

ExternalReference getXRef(java.lang.String accessTokenStr)

Returns the access token for the specified application partner, user pair

Parameters:

appRef - Application partner reference

xUserId - External user ID of interest

Returns:

Access token

Throws:

NotFoundException

InvalidPartnerException

findByXRef

java.lang.String findByXRef(java.lang.String appRef,
                            XInfoImpl xInfo)
                     throws NotFoundException

Returns the access token for the specified application partner, user pair

Parameters:

appRef - Application partner reference

xInfo - External user info

Returns:

Access token

Throws:

NotFoundException

InvalidPartnerException

renewToken

java.lang.String renewToken(java.lang.String appRef,
                            java.lang.String accessTokenStr)
                     throws NotFoundException

Throws:

NotFoundException

invalidateToken

void invalidateToken(java.lang.String appRef,
                     java.lang.String accessTokenStr)
              throws NotFoundException

Throws:

NotFoundException

getExpiration

java.time.Instant getExpiration(java.lang.String appRef,
                                java.lang.String accessTokenStr)
                         throws NotFoundException

Throws:

NotFoundException

isExpired

boolean isExpired(java.lang.String appRef,
                  java.lang.String accessTokenStr)
           throws NotFoundException

Throws:

NotFoundException

findByToken

AccessToken findByToken(java.lang.String appRef,
                        java.lang.String accessTokenStr)
                 throws NotFoundException

Throws:

NotFoundException

purge

void purge(int unusedDays)

Delete your application's access tokens that have been unused for a specified number of days.

Parameters:

unusedDays - Length of time, in days, a token has been unused.

purge

void purge(java.lang.String appRef,
           int unusedDays)

For an admin application: Delete tokens that have been unused for a specified number of days.

If appRef is not same as the application calling the method, the caller must be the admin app.

Parameters:

appRef - Application reference whose tokens are to be purged.

unusedDays - Length of time, in days, a token has been unused.