com.spacecode.sdk.device.module

Class AuthenticationModule

java.lang.Object

com.spacecode.sdk.device.module.Module

com.spacecode.sdk.device.module.AuthenticationModule

public abstract class AuthenticationModule
extends Module

Base class for authentication modules.

Method Summary

Methods

Modifier and Type	Method and Description
static int	connectFingerprintReaders(int numberExpected) Initialize the connection with a given number of fingerprint readers.
static AuthenticationModule	deserialize(java.lang.String encodedModule) Create a new instance by deserializing an AuthenticationModule.
AccessType	getAccessType()
abstract java.lang.String	getData() Deprecated. Internal Usage. Should not be used by SDK users. Wait for the module to provide the desired data.
java.lang.String	getLastRecord()
java.lang.String	getSerialNumber()
static int	getTimeout(AccessType accessType) Deprecated. Internal Usage. Should not be used by SDK users. Provide the allowed delay for getting (synchronously) data from the module.
boolean	isMaster()
java.lang.String	serialize() Serialize the current instance as XML and encode it with base64.

Methods inherited from class com.spacecode.sdk.device.module.Module

release

Methods inherited from class java.lang.Object

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

Method Detail

getData

public abstract java.lang.String getData()
                                  throws java.util.concurrent.TimeoutException

Deprecated. Internal Usage. Should not be used by SDK users.
Wait for the module to provide the desired data.

Returns:

A string containing the desired data.

Throws:

java.util.concurrent.TimeoutException

getSerialNumber

public java.lang.String getSerialNumber()

Overrides:

getSerialNumber in class Module

Returns:

Serial number of the module.

isMaster

public boolean isMaster()

Returns:

If true, the module controls the "master" door. Otherwise the "slave" door.

getAccessType

public AccessType getAccessType()

Returns:

Type of access controlled by this module.

getLastRecord

public java.lang.String getLastRecord()

Returns:

Last data recorded (badge number, FingerIndex name...).

getTimeout

public static int getTimeout(AccessType accessType)

Deprecated. Internal Usage. Should not be used by SDK users.
Provide the allowed delay for getting (synchronously) data from the module.

Parameters:

accessType - Type of the authentication module.

Returns:

A delay in milliseconds.

serialize

public java.lang.String serialize()

Serialize the current instance as XML and encode it with base64.

Returns:

The base64 encoded XML AuthenticationModule (or an empty string if any error occurred).

deserialize

public static AuthenticationModule deserialize(java.lang.String encodedModule)

Create a new instance by deserializing an AuthenticationModule.

Parameters:

encodedModule - Serialized/encoded module.

Returns:

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

connectFingerprintReaders

public static int connectFingerprintReaders(int numberExpected)
                                     throws FingerprintReaderException

Initialize the connection with a given number of fingerprint readers.

Parameters:

numberExpected - Number of readers expected (=> to be found when initializing connections).

Returns:

Number of readers found.

Throws:

FingerprintReaderException - If any error occurred during the initialization process.