com.spacecode.sdk.user

Class User

java.lang.Object

com.spacecode.sdk.user.User

public class User
extends java.lang.Object

Class representing a User, allowing access management (if required) and user's actions tracking.

Constructor Summary

Constructors

Constructor and Description
User(java.lang.String username, GrantType grantType) Minimalist constructor, create a user with empty fingerprint templates and empty badge number.
User(java.lang.String username, GrantType grantType, java.lang.String badgeNumber) Create a user without fingerprint templates.
User(java.lang.String username, GrantType grantType, java.lang.String badgeNumber, java.util.Map<FingerIndex,java.lang.String> fingerprintTemplates) Construct a user with all optional parameters: badge number, fingerprint templates.

Method Summary

Methods

Modifier and Type	Method and Description
static User	deserialize(java.lang.String serializedUser) Get a User from a serialized one.
java.lang.String	getBadgeNumber() Provide the user's badge number.
java.util.List<FingerIndex>	getEnrolledFingersIndexes()
java.lang.String	getFingerprintTemplate(FingerIndex fingerIndex) Provide a (String) fingerprint template, for a given finger index.
GrantType	getPermission() Get the user's permission.
java.lang.String	getUsername() Provide a unique identifier for the User.
java.lang.String	serialize() Format the user's data in an XML string and encode it with base64.

Methods inherited from class java.lang.Object

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

Constructor Detail

User

public User(java.lang.String username,
    GrantType grantType)

Minimalist constructor, create a user with empty fingerprint templates and empty badge number.

Parameters:

username - Unique identifier allowing user authentication.

grantType - User's grants. See GrantType enumeration.

User

public User(java.lang.String username,
    GrantType grantType,
    java.lang.String badgeNumber)

Create a user without fingerprint templates.

Parameters:

username - Unique identifier allowing user authentication.

grantType - User's grants. See GrantType enumeration.

badgeNumber - SpaceCode Badge Number.

User

public User(java.lang.String username,
    GrantType grantType,
    java.lang.String badgeNumber,
    java.util.Map<FingerIndex,java.lang.String> fingerprintTemplates)

Construct a user with all optional parameters: badge number, fingerprint templates. Given values could come from a database.

Parameters:

username - Unique identifier allowing user authentication.

grantType - User's grants. See GrantType enumeration.

badgeNumber - SpaceCode Badge Number.

fingerprintTemplates - Map of FingerIndex and corresponding Fingerprint templates.

Method Detail

getUsername

public final java.lang.String getUsername()

Provide a unique identifier for the User.

Returns:

String value (unique), allowing user authentication.

getFingerprintTemplate

public final java.lang.String getFingerprintTemplate(FingerIndex fingerIndex)

Provide a (String) fingerprint template, for a given finger index. Finger indexes :

• 0: Left Pinky
• 1: Left Ring
• 2: Left Middle
• 3: Left Index
• 4: Left Thumb
• 5: Right Thumb
• 6: Right Index
• 7: Right Middle
• 8: Right Ring
• 9: Right Pinky

Parameters:

fingerIndex - Given finger index, value between 0 and 9 (included).

Returns:

Base64-encoded template corresponding to the finger, or null if no value is available.

getEnrolledFingersIndexes

public final java.util.List<FingerIndex> getEnrolledFingersIndexes()

Returns:

List of FingerIndex attached to a fingerprint template, for this user.

getBadgeNumber

public final java.lang.String getBadgeNumber()

Provide the user's badge number.

Returns:

Badge unique identifier (as String).

getPermission

public final GrantType getPermission()

Get the user's permission.

Returns:

A value of GrantType.

serialize

public final java.lang.String serialize()

Format the user's data in an XML string and encode it with base64.

Returns:

The base64 encoded marked text-format Inventory (or an empty string if it failed using UTF-8 for String encoding).

deserialize

public static User deserialize(java.lang.String serializedUser)

Get a User from a serialized one.

Parameters:

serializedUser - Serialized User.

Returns:

User instance. Or null if the serialized data is invalid.