• Home
• org.spincast
• spincast-website
• 2.1.1
• source code
• AttemptsManager.html

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

public.javadoc.org.spincast.plugins.attemptslimiter.AttemptsManager.html Maven / Gradle / Ivy

Package org.spincast.plugins.attemptslimiter
Interface AttemptsManager



All Known Implementing Classes:
AttemptsManagerDefault


public interface AttemptsManager
Attempts manager.






Method Summary

All MethodsInstance MethodsAbstract Methods


Modifier and Type
Method
Description
Attempt
attempt(String attemptName,
 AttemptCriteria... criterias)

Gets the current Attempt, given the action to protect
 and criterias.

Attempt
attempt(String attemptName,
 AttemptsAutoIncrementType attemptsAutoIncrementType,
 AttemptCriteria... criterias)

Gets the current Attempt, given the action to protect
 and criterias.

Map<String,AttemptRule>
getAttemptRulesByActionName()

Gets all the registered AttemptRule rules, 
 by action names.

void
registerAttempRule(String actionName,
 int nbrMaxAttemptsPerDuration,
 Duration duration)

Creates and registers a AttemptRule 
 rule from the required informations.

void
registerAttempRule(AttemptRule attemptRule)

Registers a AttemptRule rule.













Method Details



attempt
Attempt attempt(String attemptName,
 AttemptCriteria... criterias)
Gets the current Attempt, given the action to protect
 and criterias. With this object you can:
 

 

 Know if the action should be allowed or blocked,
 by calling Attempt.isMaxReached().
 
 

 Manually increment the number of attempts using Attempt.incrementAttemptsCount(), 
 if you didn't let the {attempt(String, AttemptCriteria...)} method do
 it automatically 
 (see SpincastAttemptsLimiterPluginConfig.getDefaultAttemptAutoIncrementType()).
 
 
 





attempt
Attempt attempt(String attemptName,
 AttemptsAutoIncrementType attemptsAutoIncrementType,
 AttemptCriteria... criterias)
Gets the current Attempt, given the action to protect
 and criterias. With this object you can:
 

 

 Know if the action should be allowed or blocked,
 by calling Attempt.isMaxReached().
 
 

 Manually increment the number of attempts using Attempt.incrementAttemptsCount(), 
 if you didn't let the {{@link #attempt(String, AttemptAutoIncrementType, AttemptCriteria...))}} method do
 it automatically.
 
 

Parameters:
attemptsAutoIncrementType - Specifies if the method should increment the
 number of attempts by itself. If you don't let it do it, you need to increment
 the number of attempts by yourself, by calling Attempt.incrementAttemptsCount()
 on the returned object.





registerAttempRule
void registerAttempRule(AttemptRule attemptRule)
Registers a AttemptRule rule.




registerAttempRule
void registerAttempRule(String actionName,
 int nbrMaxAttemptsPerDuration,
 Duration duration)
Creates and registers a AttemptRule 
 rule from the required informations.




getAttemptRulesByActionName
Map<String,AttemptRule> getAttemptRulesByActionName()
Gets all the registered AttemptRule rules, 
 by action names.