• Home
• org.spincast
• spincast-website
• 2.1.1
• source code
• AttemptsManagerDefault.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.AttemptsManagerDefault.html Maven / Gradle / Ivy

Package org.spincast.plugins.attemptslimiter
Class AttemptsManagerDefault

java.lang.Object
org.spincast.plugins.attemptslimiter.AttemptsManagerDefault



All Implemented Interfaces:
AttemptsManager


public class AttemptsManagerDefault
extends Object
implements AttemptsManager






Field Summary
Fields

Modifier and Type
Field
Description
protected static final org.slf4j.Logger
logger
 






Constructor Summary
Constructors

Constructor
Description
AttemptsManagerDefault(SpincastAttemptsLimiterPluginRepository SpincastAttemptsLimiterPluginRepository,
 AttemptFactory attemptFactory,
 SpincastAttemptsLimiterPluginConfig spincastAttemptsLimiterPluginConfig)
 






Method Summary

All MethodsInstance MethodsConcrete Methods


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

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

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

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

protected AttemptFactory
getAttemptFactory()
 
protected AttemptRule
getAttemptRule(String actionName)
 
Map<String,AttemptRule>
getAttemptRulesByActionName()

Gets all the registered AttemptRule rules, 
 by action names.

protected SpincastAttemptsLimiterPluginConfig
getSpincastAttemptsLimiterPluginConfig()
 
protected SpincastAttemptsLimiterPluginRepository
getSpincastAttemptsLimiterPluginRepository()
 
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.





Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait









Field Details



logger
protected static final org.slf4j.Logger logger








Constructor Details



AttemptsManagerDefault
@Inject
public AttemptsManagerDefault(SpincastAttemptsLimiterPluginRepository SpincastAttemptsLimiterPluginRepository,
 AttemptFactory attemptFactory,
 SpincastAttemptsLimiterPluginConfig spincastAttemptsLimiterPluginConfig)








Method Details



getSpincastAttemptsLimiterPluginRepository
protected SpincastAttemptsLimiterPluginRepository getSpincastAttemptsLimiterPluginRepository()




getAttemptRulesByActionName
public Map<String,AttemptRule> getAttemptRulesByActionName()
Description copied from interface: AttemptsManager
Gets all the registered AttemptRule rules, 
 by action names.

Specified by:
getAttemptRulesByActionName in interface AttemptsManager





getAttemptRule
protected AttemptRule getAttemptRule(String actionName)




getAttemptFactory
protected AttemptFactory getAttemptFactory()




getSpincastAttemptsLimiterPluginConfig
protected SpincastAttemptsLimiterPluginConfig getSpincastAttemptsLimiterPluginConfig()




attempt
public Attempt attempt(String actionName,
 AttemptCriteria... criterias)
Description copied from interface: AttemptsManager
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 {AttemptsManager.attempt(String, AttemptCriteria...)} method do
 it automatically 
 (see SpincastAttemptsLimiterPluginConfig.getDefaultAttemptAutoIncrementType()).
 
 
 


Specified by:
attempt in interface AttemptsManager





attempt
public Attempt attempt(String actionName,
 AttemptsAutoIncrementType attemptsAutoIncrementType,
 AttemptCriteria... criterias)
Description copied from interface: AttemptsManager
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.
 
 

Specified by:
attempt in interface AttemptsManager
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
public void registerAttempRule(AttemptRule attemptRule)
Description copied from interface: AttemptsManager
Registers a AttemptRule rule.

Specified by:
registerAttempRule in interface AttemptsManager





registerAttempRule
public void registerAttempRule(String actionName,
 int nbrMaxAttemptsPerDuration,
 Duration duration)
Description copied from interface: AttemptsManager
Creates and registers a AttemptRule 
 rule from the required informations.

Specified by:
registerAttempRule in interface AttemptsManager