org.assistments.service.security

Class AccessTokenManagerImpl

java.lang.Object

org.assistments.service.security.AccessTokenManagerImpl

All Implemented Interfaces:

AccessTokenManager

@Component
public class AccessTokenManagerImpl
extends java.lang.Object
implements AccessTokenManager

Nested Class Summary

Nested classes/interfaces inherited from interface org.assistments.service.security.AccessTokenManager

AccessTokenManager.UpdateField

Constructor Summary

Constructors

Constructor and Description
AccessTokenManagerImpl()

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)

Methods inherited from class java.lang.Object

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

Constructor Detail

AccessTokenManagerImpl

public AccessTokenManagerImpl()

Method Detail

persist

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

Description copied from interface: AccessTokenManager

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

Specified by:

persist in interface AccessTokenManager

Parameters:

xInfo - A User's XPair

Returns:

Created access token

Throws:

NotFoundException

persist

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

Specified by:

persist in interface AccessTokenManager

Throws:

NotFoundException

getXUserId

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

Description copied from interface: AccessTokenManager

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

Specified by:

getXUserId in interface AccessTokenManager

Parameters:

appRef - Application partner reference

accessTokenStr - Access token

Returns:

external user ID

Throws:

NotFoundException

getXRef

public ExternalReference getXRef(java.lang.String accessTokenStr)

Description copied from interface: AccessTokenManager

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

Specified by:

getXRef in interface AccessTokenManager

Returns:

Access token

findByXRef

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

Description copied from interface: AccessTokenManager

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

Specified by:

findByXRef in interface AccessTokenManager

Parameters:

appRef - Application partner reference

xInfo - External user info

Returns:

Access token

Throws:

NotFoundException

renewToken

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

Specified by:

renewToken in interface AccessTokenManager

Throws:

NotFoundException

invalidateToken

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

Specified by:

invalidateToken in interface AccessTokenManager

Throws:

NotFoundException

getExpiration

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

Specified by:

getExpiration in interface AccessTokenManager

Throws:

NotFoundException

isExpired

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

Specified by:

isExpired in interface AccessTokenManager

Throws:

NotFoundException

findByToken

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

Specified by:

findByToken in interface AccessTokenManager

Throws:

NotFoundException

purge

public void purge(int unusedDays)

Description copied from interface: AccessTokenManager

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

Specified by:

purge in interface AccessTokenManager

Parameters:

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

purge

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

Description copied from interface: AccessTokenManager

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.

Specified by:

purge in interface AccessTokenManager

Parameters:

appRef - Application reference whose tokens are to be purged.

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