Package com.broadleafcommerce.auth.client.domain.cleanup

Class OAuth2AuthorizedClientEntityCleanupRequest

java.lang.Object

com.broadleafcommerce.auth.client.domain.cleanup.OAuth2AuthorizedClientEntityCleanupRequest

public class OAuth2AuthorizedClientEntityCleanupRequest
extends Object

Contains details required as input to OAuth2AuthorizedClientEntityService.cleanupOutdatedEntities(OAuth2AuthorizedClientEntityCleanupRequest)

Constructor Summary

Constructors

Constructor	Description
OAuth2AuthorizedClientEntityCleanupRequest()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
Instant	getAccessTokenExpThresholdIfNoValidRefreshToken()	For entities where there is no valid refresh token available, OAuth2AuthorizedClientEntity.getAccessTokenExpiresAt() must be less than or equal to this value in order to be considered 'outdated' and eligible for pruning.
Instant	getAccessTokenExpThresholdIfValidRefreshToken()	For entities where there is a valid refresh token available, OAuth2AuthorizedClientEntity.getAccessTokenExpiresAt() must be less than or equal to this value in order to be considered 'outdated' and eligible for pruning.
int	getBatchSizeLimit()	The maximum number of records that should be considered for a batch.
OAuth2AuthorizedClientEntityCleanupResponse	getLastUpdatedResponse()	Contains the response received from the last execution of OAuth2AuthorizedClientEntityService.cleanupOutdatedEntities(OAuth2AuthorizedClientEntityCleanupRequest) in a particular batch sequence.
Instant	getRefreshTokenInvalidExpirationThreshold()	For entities where a refresh token has been set, OAuth2AuthorizedClientEntity.getRefreshTokenExpiresAt() must be less than or equal to this value in order to be considered invalid and unusable.
int	hashCode()
void	setAccessTokenExpThresholdIfNoValidRefreshToken(Instant accessTokenExpThresholdIfNoValidRefreshToken)	For entities where there is no valid refresh token available, OAuth2AuthorizedClientEntity.getAccessTokenExpiresAt() must be less than or equal to this value in order to be considered 'outdated' and eligible for pruning.
void	setAccessTokenExpThresholdIfValidRefreshToken(Instant accessTokenExpThresholdIfValidRefreshToken)	For entities where there is a valid refresh token available, OAuth2AuthorizedClientEntity.getAccessTokenExpiresAt() must be less than or equal to this value in order to be considered 'outdated' and eligible for pruning.
void	setBatchSizeLimit(int batchSizeLimit)	The maximum number of records that should be considered for a batch.
void	setLastUpdatedResponse(OAuth2AuthorizedClientEntityCleanupResponse lastUpdatedResponse)	Contains the response received from the last execution of OAuth2AuthorizedClientEntityService.cleanupOutdatedEntities(OAuth2AuthorizedClientEntityCleanupRequest) in a particular batch sequence.
void	setRefreshTokenInvalidExpirationThreshold(Instant refreshTokenInvalidExpirationThreshold)	For entities where a refresh token has been set, OAuth2AuthorizedClientEntity.getRefreshTokenExpiresAt() must be less than or equal to this value in order to be considered invalid and unusable.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

OAuth2AuthorizedClientEntityCleanupRequest

public OAuth2AuthorizedClientEntityCleanupRequest()

Method Details

getLastUpdatedResponse

@Nullable
public OAuth2AuthorizedClientEntityCleanupResponse getLastUpdatedResponse()

Contains the response received from the last execution of OAuth2AuthorizedClientEntityService.cleanupOutdatedEntities(OAuth2AuthorizedClientEntityCleanupRequest) in a particular batch sequence. Can be null if no prior batch was executed for the current sequence.

getAccessTokenExpThresholdIfNoValidRefreshToken

public Instant getAccessTokenExpThresholdIfNoValidRefreshToken()

For entities where there is no valid refresh token available, OAuth2AuthorizedClientEntity.getAccessTokenExpiresAt() must be less than or equal to this value in order to be considered 'outdated' and eligible for pruning.

See Also:

• OAuth2AuthorizedClientCleanupProperties.getMaxAllowedAccessTokenExpAgeIfNoValidRefreshToken()

getAccessTokenExpThresholdIfValidRefreshToken

public Instant getAccessTokenExpThresholdIfValidRefreshToken()

For entities where there is a valid refresh token available, OAuth2AuthorizedClientEntity.getAccessTokenExpiresAt() must be less than or equal to this value in order to be considered 'outdated' and eligible for pruning.

See Also:

• OAuth2AuthorizedClientCleanupProperties.getMaxAllowedAccessTokenExpAgeIfValidRefreshToken()

getRefreshTokenInvalidExpirationThreshold

public Instant getRefreshTokenInvalidExpirationThreshold()

For entities where a refresh token has been set, OAuth2AuthorizedClientEntity.getRefreshTokenExpiresAt() must be less than or equal to this value in order to be considered invalid and unusable.

It may be preferable to not make this exactly the current time to allow in-flight last-minute refresh attempts to succeed (a sort of grace period).

See Also:

• OAuth2AuthorizedClientCleanupProperties.getRefreshTokenInvalidExpirationGracePeriod()

getBatchSizeLimit

public int getBatchSizeLimit()

The maximum number of records that should be considered for a batch.

setLastUpdatedResponse

public void setLastUpdatedResponse(@Nullable
 OAuth2AuthorizedClientEntityCleanupResponse lastUpdatedResponse)

Contains the response received from the last execution of OAuth2AuthorizedClientEntityService.cleanupOutdatedEntities(OAuth2AuthorizedClientEntityCleanupRequest) in a particular batch sequence. Can be null if no prior batch was executed for the current sequence.

setAccessTokenExpThresholdIfNoValidRefreshToken

public void setAccessTokenExpThresholdIfNoValidRefreshToken(Instant accessTokenExpThresholdIfNoValidRefreshToken)

For entities where there is no valid refresh token available, OAuth2AuthorizedClientEntity.getAccessTokenExpiresAt() must be less than or equal to this value in order to be considered 'outdated' and eligible for pruning.

See Also:

• OAuth2AuthorizedClientCleanupProperties.getMaxAllowedAccessTokenExpAgeIfNoValidRefreshToken()

setAccessTokenExpThresholdIfValidRefreshToken

public void setAccessTokenExpThresholdIfValidRefreshToken(Instant accessTokenExpThresholdIfValidRefreshToken)

For entities where there is a valid refresh token available, OAuth2AuthorizedClientEntity.getAccessTokenExpiresAt() must be less than or equal to this value in order to be considered 'outdated' and eligible for pruning.

See Also:

• OAuth2AuthorizedClientCleanupProperties.getMaxAllowedAccessTokenExpAgeIfValidRefreshToken()

setRefreshTokenInvalidExpirationThreshold

public void setRefreshTokenInvalidExpirationThreshold(Instant refreshTokenInvalidExpirationThreshold)

For entities where a refresh token has been set, OAuth2AuthorizedClientEntity.getRefreshTokenExpiresAt() must be less than or equal to this value in order to be considered invalid and unusable.

It may be preferable to not make this exactly the current time to allow in-flight last-minute refresh attempts to succeed (a sort of grace period).

See Also:

• OAuth2AuthorizedClientCleanupProperties.getRefreshTokenInvalidExpirationGracePeriod()

setBatchSizeLimit

public void setBatchSizeLimit(int batchSizeLimit)

The maximum number of records that should be considered for a batch.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object