org.cyclos.impl.access

Interface FailedActionHandler

public interface FailedActionHandler

Handles the failed attempts to perform an action

Author:

jcomas

Method Summary

Modifier and Type	Method and Description
void	clearGuestFailures(org.cyclos.impl.access.FailedAction action, java.lang.String remoteAddress) Clears all the guest failures for the given action and remote address
void	clearPasswordFailures(BasicUser user, PasswordType passwordType) Clears all the password failures for the given user and password type
void	clearUserFailures(org.cyclos.impl.access.FailedAction action, BasicUser user) Clears all the user failures for the given action and user
int	countGuestFailures(org.cyclos.impl.access.FailedAction action, java.lang.String remoteAddress, TimeInterval time) Returns the number of guest failures for the given action and remote address
int	countPasswordFailures(BasicUser user, PasswordType passwordType) Returns the number of password failures for the given user and password type.
int	countUserFailures(org.cyclos.impl.access.FailedAction action, BasicUser user) Returns the number of user failures for the given action and user.
boolean	isBlocked(java.lang.String remoteAddress) Returns whether the given remote address is blocked
boolean	recordForgotPasswordRequestFailure(java.lang.String remoteAddress, UserLocatorVO locator, java.lang.Integer maxAttempts, TimeInterval blockTime) Registers a transaction end listener to actually record a request forgot password attempt.
boolean	recordPasswordFailure(BasicUser user, PasswordType passwordType, java.lang.Integer maxAttempts, java.lang.String remoteAddress, java.lang.Runnable onMaxReached) Registers a transaction end listener to actually record the password failure.
boolean	recordPrincipalFailure(java.lang.String remoteAddress, UserLocatorVO locator, java.lang.Integer maxAttempts, TimeInterval blockTime) Registers a transaction end listener to actually record the principal failure.
boolean	recordUserActionFailure(org.cyclos.impl.access.FailedAction action, BasicUser user, java.lang.Integer maxAttempts, java.lang.Runnable onMaxReached) Registers a transaction end listener to actually record the user action failure.

Method Detail

clearGuestFailures

void clearGuestFailures(org.cyclos.impl.access.FailedAction action,
                        java.lang.String remoteAddress)
                 throws FrameworkException

Clears all the guest failures for the given action and remote address

Throws:

FrameworkException

clearPasswordFailures

void clearPasswordFailures(BasicUser user,
                           PasswordType passwordType)

Clears all the password failures for the given user and password type

clearUserFailures

void clearUserFailures(org.cyclos.impl.access.FailedAction action,
                       BasicUser user)
                throws FrameworkException

Clears all the user failures for the given action and user

Throws:

FrameworkException

countGuestFailures

int countGuestFailures(org.cyclos.impl.access.FailedAction action,
                       java.lang.String remoteAddress,
                       TimeInterval time)
                throws FrameworkException

Returns the number of guest failures for the given action and remote address

Throws:

FrameworkException

countPasswordFailures

int countPasswordFailures(BasicUser user,
                          PasswordType passwordType)
                   throws FrameworkException

Returns the number of password failures for the given user and password type.

Throws:

FrameworkException

countUserFailures

int countUserFailures(org.cyclos.impl.access.FailedAction action,
                      BasicUser user)
               throws FrameworkException

Returns the number of user failures for the given action and user.

Throws:

FrameworkException

isBlocked

boolean isBlocked(java.lang.String remoteAddress)
           throws FrameworkException

Returns whether the given remote address is blocked

Throws:

FrameworkException

recordForgotPasswordRequestFailure

boolean recordForgotPasswordRequestFailure(java.lang.String remoteAddress,
                                           UserLocatorVO locator,
                                           java.lang.Integer maxAttempts,
                                           TimeInterval blockTime)
                                    throws FrameworkException

Registers a transaction end listener to actually record a request forgot password attempt. Also returns if the maximum attempts has been reached, so callers can already do some logic regarding it.

Throws:

FrameworkException

recordPasswordFailure

boolean recordPasswordFailure(BasicUser user,
                              PasswordType passwordType,
                              java.lang.Integer maxAttempts,
                              java.lang.String remoteAddress,
                              java.lang.Runnable onMaxReached)
                       throws FrameworkException

Registers a transaction end listener to actually record the password failure. If so, calls the onMaxReached in the new transaction, after the current transaction. Also returns if the maximum attempts has been reached, so callers can already do some logic regarding it.

Throws:

FrameworkException

recordPrincipalFailure

boolean recordPrincipalFailure(java.lang.String remoteAddress,
                               UserLocatorVO locator,
                               java.lang.Integer maxAttempts,
                               TimeInterval blockTime)
                        throws FrameworkException

Registers a transaction end listener to actually record the principal failure. If so, calls the listener in the new transaction, after the current transaction. Also returns if the maximum attempts has been reached, so callers can already do some logic regarding it.

Throws:

FrameworkException

recordUserActionFailure

boolean recordUserActionFailure(org.cyclos.impl.access.FailedAction action,
                                BasicUser user,
                                java.lang.Integer maxAttempts,
                                java.lang.Runnable onMaxReached)
                         throws FrameworkException

Registers a transaction end listener to actually record the user action failure. If so, calls the onMaxReached in the new transaction, after the current transaction. Also returns if the maximum attempts has been reached, so callers can already do some logic regarding it.

Throws:

FrameworkException