org.spincast.plugins.attemptslimiter.config

Interface SpincastAttemptsLimiterPluginConfig

All Known Implementing Classes:

SpincastAttemptsLimiterPluginConfigDefault

public interface SpincastAttemptsLimiterPluginConfig

Configurations for the Spincast Attempts Limiter plugin.

Method Summary

Modifier and Type	Method and Description
AttemptsAutoIncrementType	getDefaultAttemptAutoIncrementType() Should the AttemptsManager.attempt(String, org.spincast.plugins.attemptslimiter.AttemptCriteria...) method automatically increment the number of attempts by default, when not specified otherwise?
int	getDeleteOldAttemptsScheduledTaskIntervalMinutes() The number of minutes between two launches of the scheduled task that will clean the database from old attempts, if isAutoBindDeleteOldAttemptsScheduledTask() is enabled.
boolean	isAutoBindDeleteOldAttemptsScheduledTask() Should the scheduled task to delete old attempts in the database be automatically added?
boolean	isValidationEnabled() Is attempts validation enabled?

Method Detail

isValidationEnabled

boolean isValidationEnabled()

Is attempts validation enabled?

You can set this to true when developing locally.

Defaults to the negation of SpincastConfig.isDevelopmentMode().

isAutoBindDeleteOldAttemptsScheduledTask

boolean isAutoBindDeleteOldAttemptsScheduledTask()

Should the scheduled task to delete old attempts in the database be automatically added?

getDeleteOldAttemptsScheduledTaskIntervalMinutes

int getDeleteOldAttemptsScheduledTaskIntervalMinutes()

The number of minutes between two launches of the scheduled task that will clean the database from old attempts, if isAutoBindDeleteOldAttemptsScheduledTask() is enabled.

getDefaultAttemptAutoIncrementType

AttemptsAutoIncrementType getDefaultAttemptAutoIncrementType()

Should the AttemptsManager.attempt(String, org.spincast.plugins.attemptslimiter.AttemptCriteria...) method automatically increment the number of attempts by default, when not specified otherwise?

If you don't let the method increment the number of attempts, you are responsible to call Attempt.incrementAttemptsCount() by yourself, when required.

Defaults to AttemptsAutoIncrementType.ALWAYS.