com.ontimize.locator

Class ErrorAccessControl

java.lang.Object

com.ontimize.locator.ErrorAccessControl

public class ErrorAccessControl
extends Object

This class is used to implement a login lock to users who have inserted their credentials wrong a specific number of times. This is used if in the locator.properties exist the property "ControlAccessAttempts = true" This object stores a Hashtable whose keys are the usernames and the values the AccesObject associated with these users.

Since:

5.6.0

Author:

Imatia Innovation SL

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ErrorAccessControl.AccessObject This object is the logic lock.

Field Summary

Fields

Modifier and Type	Field and Description
protected Hashtable<String,ErrorAccessControl.AccessObject>	hAccessControl
int	numMaxErrorAccess

Constructor Summary

Constructors

Constructor and Description
ErrorAccessControl(int numberMaxAcces)

Method Summary

Methods

Modifier and Type	Method and Description
void	addAccessAttempToUser(String user) Add an access attempt to the user which username is passed by param.
void	allowLogin(String user) Unlocks a blocked user which username is passed by param.
boolean	checkAccessControl(String user) Check if the user which username is passed by param is blocked.
boolean	checkLastAttempt(String user) Check if the last attempt to login is more or equals to the max number of allowed attempts
int	getNumMaxErrorAccess()
ErrorAccessControl.AccessObject	getUserAccessObject(String user) Return the AccessObject of the user which username is passed by param.

Methods inherited from class java.lang.Object

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

Field Detail

numMaxErrorAccess

public int numMaxErrorAccess

hAccessControl

protected Hashtable<String,ErrorAccessControl.AccessObject> hAccessControl

Constructor Detail

ErrorAccessControl

public ErrorAccessControl(int numberMaxAcces)

Method Detail

getNumMaxErrorAccess

public int getNumMaxErrorAccess()

checkAccessControl

public boolean checkAccessControl(String user)
                           throws UserBlockedException

Check if the user which username is passed by param is blocked.

Parameters:

user - The username to check

Returns:

True if the user is blocked. False otherwise

Throws:

UserBlockedException

allowLogin

public void allowLogin(String user)

Unlocks a blocked user which username is passed by param.

Parameters:

user - The user who will be allowed access

getUserAccessObject

public ErrorAccessControl.AccessObject getUserAccessObject(String user)

Return the AccessObject of the user which username is passed by param.

Parameters:

user - The username of the AccessObject to be recovered.

Returns:

The AccessObject of user or null if no exists.

addAccessAttempToUser

public void addAccessAttempToUser(String user)

Add an access attempt to the user which username is passed by param. If the attempts is more than numMaxErrorAccess in ErrorAccessControl, the user will be blocked.

Parameters:

user - The user of the AccessObject to which you will add a new attempt.

checkLastAttempt

public boolean checkLastAttempt(String user)

Check if the last attempt to login is more or equals to the max number of allowed attempts

Parameters:

user - The user of the object to which you will retrieve the last attempt

Returns:

True is the user number of attempts is more than numMaxErrorAcces in ErrorAccesControl, false otherwise