Package com.appliedrec.verid.core2

Class UserManagement

java.lang.Object

com.appliedrec.verid.core2.UserManagement

All Implemented Interfaces:

IUserManagement

public class UserManagement
extends java.lang.Object
implements IUserManagement

Default implementation of the IUserManagement interface

Since:

1.0.0

Method Summary

Modifier and Type	Method	Description
void	assignFacesToUser(IRecognizable[] faces, java.lang.String userId)	Assign faces to user.
void	close()	Indicate that the instance will no longer be used and can free its resources.
int	countFacesWithVersion(VerIDFaceTemplateVersion version)
void	deleteFaces(IRecognizable[] faces)	Delete faces.
void	deleteUsers(java.lang.String[] userIds)	Delete users and their registered faces.
IRecognizable[]	getFaces()	Get all registered faces.
IRecognizable[]	getFaces(VerIDFaceTemplateVersion faceTemplateVersion)
IRecognizable[]	getFacesOfUser(java.lang.String userId)	Get faces associated with user.
IRecognizable[]	getFacesOfUser(java.lang.String userId, VerIDFaceTemplateVersion faceTemplateVersion)
IFaceTemplateEncryption	getFaceTemplateEncryption()
java.lang.String	getUserInFace(IRecognizable face)
java.lang.String[]	getUsers()	Get registered users.
java.lang.String[]	getUsers(VerIDFaceTemplateVersion faceTemplateVersion)
boolean	isAutomaticFaceTemplateMigrationEnabled()
boolean	isEncryptionDisabled()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.appliedrec.verid.core2.IUserManagement

assignFacesToUserCompletable, deleteFacesCompletable, deleteUsersCompletable, getFacesOfUserSingle, getFacesSingle, getFaceTemplateVersions, getUserInFaceSingle, getUsersSingle, inferDefaultFaceTemplateVersion, usersAreSubsetOfUserAtIndex

Method Detail

getFaceTemplateEncryption

public IFaceTemplateEncryption getFaceTemplateEncryption()

Returns:

Face template encryption instance

Since:

1.12.0

isEncryptionDisabled

public boolean isEncryptionDisabled()

Returns:

true if face template encryption is enabled on this instance

Since:

1.12.0

assignFacesToUser

public void assignFacesToUser(IRecognizable[] faces,
                              java.lang.String userId)
                       throws VerIDCoreException

Description copied from interface: IUserManagement

Assign faces to user.

Specified by:

assignFacesToUser in interface IUserManagement

Parameters:

faces - Faces to assign to the user

userId - ID of the user

Throws:

VerIDCoreException - if the assignment fails

deleteFaces

public void deleteFaces(IRecognizable[] faces)
                 throws VerIDCoreException

Description copied from interface: IUserManagement

Delete faces.

Specified by:

deleteFaces in interface IUserManagement

Parameters:

faces - Faces to delete

Throws:

VerIDCoreException - if the deletion fails

getUsers

@WorkerThread
public java.lang.String[] getUsers()

Description copied from interface: IUserManagement

Get registered users.

Specified by:

getUsers in interface IUserManagement

Returns:

IDs of users with registered faces

getFacesOfUser

@WorkerThread
public IRecognizable[] getFacesOfUser(java.lang.String userId)
                               throws VerIDCoreException

Description copied from interface: IUserManagement

Get faces associated with user.

Specified by:

getFacesOfUser in interface IUserManagement

Parameters:

userId - ID of the user whose faces to get

Returns:

Array of faces

Throws:

VerIDCoreException - if the operation fails

getFaces

public IRecognizable[] getFaces()
                         throws VerIDCoreException

Description copied from interface: IUserManagement

Get all registered faces.

Specified by:

getFaces in interface IUserManagement

Returns:

Array of faces

Throws:

VerIDCoreException - if the operation fails

deleteUsers

public void deleteUsers(java.lang.String[] userIds)

Description copied from interface: IUserManagement

Delete users and their registered faces.

Specified by:

deleteUsers in interface IUserManagement

Parameters:

userIds - IDs of the users to delete

getUserInFace

@NonNull
@WorkerThread
public java.lang.String getUserInFace(IRecognizable face)
                               throws VerIDCoreException

Specified by:

getUserInFace in interface IUserManagement

Throws:

VerIDCoreException

countFacesWithVersion

public int countFacesWithVersion(VerIDFaceTemplateVersion version)

Specified by:

countFacesWithVersion in interface IUserManagement

close

public void close()

Description copied from interface: IUserManagement

Indicate that the instance will no longer be used and can free its resources.

Specified by:

close in interface IUserManagement

isAutomaticFaceTemplateMigrationEnabled

public boolean isAutomaticFaceTemplateMigrationEnabled()

getUsers

public java.lang.String[] getUsers(VerIDFaceTemplateVersion faceTemplateVersion)

Specified by:

getUsers in interface IUserManagement

getFaces

public IRecognizable[] getFaces(VerIDFaceTemplateVersion faceTemplateVersion)
                         throws VerIDCoreException

Specified by:

getFaces in interface IUserManagement

Throws:

VerIDCoreException

getFacesOfUser

public IRecognizable[] getFacesOfUser(java.lang.String userId,
                                      VerIDFaceTemplateVersion faceTemplateVersion)
                               throws VerIDCoreException

Specified by:

getFacesOfUser in interface IUserManagement

Throws:

VerIDCoreException