org.spincast.plugins.attemptslimiter.config

Class SpincastAttemptsLimiterPluginConfigDefault

java.lang.Object

org.spincast.plugins.attemptslimiter.config.SpincastAttemptsLimiterPluginConfigDefault

All Implemented Interfaces:

SpincastAttemptsLimiterPluginConfig

public class SpincastAttemptsLimiterPluginConfigDefault
extends Object
implements SpincastAttemptsLimiterPluginConfig

Default configurations for Spincast Attempts Limiter plugin.

Constructor Summary

Constructors

Constructor and Description
SpincastAttemptsLimiterPluginConfigDefault(SpincastConfig spincastConfig)

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 SpincastAttemptsLimiterPluginConfig.isAutoBindDeleteOldAttemptsScheduledTask() is enabled.
protected SpincastConfig	getSpincastConfig()
boolean	isAutoBindDeleteOldAttemptsScheduledTask() Should the scheduled task to delete old attempts in the database be automatically added?
boolean	isValidationEnabled() Is attempts validation enabled?

Methods inherited from class java.lang.Object

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

Constructor Detail

SpincastAttemptsLimiterPluginConfigDefault

@Inject
public SpincastAttemptsLimiterPluginConfigDefault(SpincastConfig spincastConfig)

Method Detail

getSpincastConfig

protected SpincastConfig getSpincastConfig()

isAutoBindDeleteOldAttemptsScheduledTask

public boolean isAutoBindDeleteOldAttemptsScheduledTask()

Description copied from interface: SpincastAttemptsLimiterPluginConfig

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

Specified by:

isAutoBindDeleteOldAttemptsScheduledTask in interface SpincastAttemptsLimiterPluginConfig

getDeleteOldAttemptsScheduledTaskIntervalMinutes

public int getDeleteOldAttemptsScheduledTaskIntervalMinutes()

Description copied from interface: SpincastAttemptsLimiterPluginConfig

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

Specified by:

getDeleteOldAttemptsScheduledTaskIntervalMinutes in interface SpincastAttemptsLimiterPluginConfig

getDefaultAttemptAutoIncrementType

public AttemptsAutoIncrementType getDefaultAttemptAutoIncrementType()

Description copied from interface: SpincastAttemptsLimiterPluginConfig

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.

Specified by:

getDefaultAttemptAutoIncrementType in interface SpincastAttemptsLimiterPluginConfig

isValidationEnabled

public boolean isValidationEnabled()

Description copied from interface: SpincastAttemptsLimiterPluginConfig

Is attempts validation enabled?

You can set this to true when developing locally.

Defaults to the negation of SpincastConfig.isDevelopmentMode().

Specified by:

isValidationEnabled in interface SpincastAttemptsLimiterPluginConfig