org.spincast.plugins.attemptslimiter

Class AttemptDefault

java.lang.Object

org.spincast.plugins.attemptslimiter.AttemptDefault

All Implemented Interfaces:

Attempt

public class AttemptDefault
extends Object
implements Attempt

Constructor Summary

Constructors

Constructor and Description
AttemptDefault(SpincastAttemptsLimiterPluginRepository spincastAttemptsLimiterPlguinRepository, boolean maxReached, String actionName, AttemptCriteria... criterias)

Method Summary

Modifier and Type	Method and Description
void	deleteAttempts() Deletes all attempts for this action and criterias.
String	getActionName()
AttemptCriteria[]	getCriterias()
protected SpincastAttemptsLimiterPluginRepository	getSpincastAttemptsLimiterPluginRepository()
void	incrementAttemptsCount() Increments the number of attempts.
boolean	isMaxReached() Max number of attempts reached.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AttemptDefault

public AttemptDefault(SpincastAttemptsLimiterPluginRepository spincastAttemptsLimiterPlguinRepository,
                      boolean maxReached,
                      String actionName,
                      AttemptCriteria... criterias)

Method Detail

getSpincastAttemptsLimiterPluginRepository

protected SpincastAttemptsLimiterPluginRepository getSpincastAttemptsLimiterPluginRepository()

getActionName

public String getActionName()

getCriterias

public AttemptCriteria[] getCriterias()

isMaxReached

public boolean isMaxReached()

Description copied from interface: Attempt

Max number of attempts reached. Your code should deny the protected action.

Specified by:

isMaxReached in interface Attempt

incrementAttemptsCount

public void incrementAttemptsCount()

Description copied from interface: Attempt

Increments the number of attempts.

You have to call this method manually if you don't let the AttemptsManager.attempt(String, org.spincast.plugins.attemptslimiter.AttemptCriteria...) method do it.

Note that calling this method multiple times won't result in multiple increments. The count will be incremented only once!

Specified by:

incrementAttemptsCount in interface Attempt

See Also:

SpincastAttemptsLimiterPluginConfig#getDefaultAttemptAutoIncrementType()} and {@link AttemptsManager#attempt(String, AttemptAutoIncrementType, AttemptCriteria...)}.

deleteAttempts

public void deleteAttempts()

Description copied from interface: Attempt

Deletes all attempts for this action and criterias.

In some situations, you may want to clear the attempts when an action is succesfull.

Specified by:

deleteAttempts in interface Attempt

toString

public String toString()

Overrides:

toString in class Object