com.spacecode.sdk.user

Class UsersService

java.lang.Object

com.spacecode.sdk.user.UsersService

public class UsersService
extends java.lang.Object

Users management service for local devices.
TcpDevice uses a specialized version of this class.

Constructor Summary

Constructors

Constructor and Description
UsersService(java.util.List<Module> modules) Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addUser(User user) Add a user to the current users list.
java.util.List<User>	addUsers(java.util.Collection<User> users) Add users to the current users list.
boolean	enrollFinger(java.lang.String username, FingerIndex fingerIndex) Start finger enrollment with the master fingerprint reader.
boolean	enrollFinger(java.lang.String username, FingerIndex fingerIndex, boolean useMasterReader) Start finger enrollment with the chosen fingerprint reader (master or slave).
boolean	enrollFinger(java.lang.String username, FingerIndex fingerIndex, java.lang.String t) Deprecated. Deprecated. Please use enrollFinger(String, FingerIndex, boolean).
java.util.List<java.lang.String>	getUnregisteredUsers() Provide the names of users without permission (users not considered by the Device): users removed from the group of granted users (using removeUser(String)).
User	getUserByName(java.lang.String username) Provide an instance of User corresponding to the username, if any user with this name has a permission on this device.
java.util.List<User>	getUsers() Provide access to a copy of the users list.
boolean	removeFingerprint(java.lang.String username, FingerIndex fingerIndex) Allow removing a user's fingerprint.
boolean	removeUser(java.lang.String username) Allow removing a user from the users list.
boolean	updateBadgeNumber(java.lang.String username, java.lang.String badgeNumber) Allow modifying a user's badge number.
boolean	updatePermission(java.lang.String username, GrantType permission) Update a user's permission on current device. Setting GrantType.UNDEFINED as a permission removes the ability for a User to open the device.

Methods inherited from class java.lang.Object

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

Constructor Detail

UsersService

public UsersService(java.util.List<Module> modules)

Default constructor.

Parameters:

modules - Reference to Device's modules list.

Method Detail

enrollFinger

public boolean enrollFinger(java.lang.String username,
                   FingerIndex fingerIndex)
                     throws java.util.concurrent.TimeoutException

Start finger enrollment with the master fingerprint reader.

Parameters:

username - User to be enrolled.

fingerIndex - Index of the finger to be enrolled.

Returns:

True if enrollment succeeded. False otherwise (an error occurred in fingerprint/template reading).

Throws:

java.util.concurrent.TimeoutException - If the enrollment process timeout delay has passed.

enrollFinger

public boolean enrollFinger(java.lang.String username,
                   FingerIndex fingerIndex,
                   boolean useMasterReader)
                     throws java.util.concurrent.TimeoutException

Start finger enrollment with the chosen fingerprint reader (master or slave).

Parameters:

username - User to be enrolled.

fingerIndex - Index of the finger to be enrolled.

useMasterReader - If true, use the master reader, otherwise use the slave.

Returns:

True if enrollment succeeded. False otherwise (an error occurred in fingerprint/template reading).

Throws:

java.util.concurrent.TimeoutException - If the enrollment process timeout delay has passed.

enrollFinger

@Deprecated
public boolean enrollFinger(java.lang.String username,
                              FingerIndex fingerIndex,
                              java.lang.String t)

Deprecated. Deprecated. Please use enrollFinger(String, FingerIndex, boolean).

removeFingerprint

public boolean removeFingerprint(java.lang.String username,
                        FingerIndex fingerIndex)

Allow removing a user's fingerprint.

Parameters:

username - User to be modified.

fingerIndex - FingerIndex of the fingerprint to be removed.

Returns:

True if the operation succeeded, false otherwise (unknown user, null parameter...).

updateBadgeNumber

public boolean updateBadgeNumber(java.lang.String username,
                        java.lang.String badgeNumber)

Allow modifying a user's badge number.

Parameters:

username - User to be modified.

badgeNumber - New badge number.

Returns:

True if success, false otherwise (unknown user).

updatePermission

public boolean updatePermission(java.lang.String username,
                       GrantType permission)

Update a user's permission on current device.

Setting GrantType.UNDEFINED as a permission removes the ability for a User to open the device. However, the user is still considered by the device. To get rid of a user, use removeUser(String), which puts the user in the list of "Unregistered Users" (see getUnregisteredUsers());

Parameters:

username - Name of the User to be authorized / unauthorized.

permission - New permission.

Returns:

True if the operation succeeded, false otherwise (unknown user, null parameter).

addUser

public boolean addUser(User user)

Add a user to the current users list. As users are identified by their username, this last must be unique to each user. Adding a user with a username already in use always fails. A given username must be unique to both "granted" users and unregistered users.

Parameters:

user - Instance of a class implementing GrantType interface.

Returns:

True in case of success, false otherwise (invalid user, or username already in use).

addUsers

public java.util.List<User> addUsers(java.util.Collection<User> users)

Add users to the current users list.

Parameters:

users - List of users to be added.

Returns:

List of User which couldn't be added.

removeUser

public boolean removeUser(java.lang.String username)

Allow removing a user from the users list. If the operation succeeds, the user will be added to the list of "Unregistered Users".

Parameters:

username - Username of the user who should be removed from the users list.

Returns:

True if the user has been removed, false otherwise (invalid parameter or unknown user).

getUserByName

public User getUserByName(java.lang.String username)

Provide an instance of User corresponding to the username, if any user with this name has a permission on this device.

On local devices, the reference to User returned is the same that has been added with addUser(User).
On remote devices, the instance returned is a copy.

Parameters:

username - Desired user's username.

Returns:

Desired User, if the user exists, null otherwise.

getUsers

public java.util.List<User> getUsers()

Provide access to a copy of the users list.

On local devices, the references to User in the list are the same that have been added with addUser(User).
On remote devices, the instances of User are copies.

Returns:

List of Users.

getUnregisteredUsers

public java.util.List<java.lang.String> getUnregisteredUsers()

Provide the names of users without permission (users not considered by the Device): users removed from the group of granted users (using removeUser(String)).

Returns:

Names of Users without a permission on this device.