InkTools
Class CicReturn

java.lang.Object
  |
  +--InkTools.CicReturn

public class CicReturn

extends java.lang.Object

Defines the CIC InkTools return and error codes. These error codes can be directly displayed in a string, since to every error code a description is assigned.

Version:

1.0

Author:

CIC

Field Summary

static CicReturn	ARRAY_ERROR An array passed in has less element as expected.
static CicReturn	ENC_KEY_LENGTH The encryption key has to be exact 8 byte long, for TRIPLE_DES exact 24 bytes long.
static CicReturn	ENROLL_TOO_DIFFERENT To cerate a template, the signatures must be consistend, meaning the user can't use 2 or 3 different signatures for enrollment.
static CicReturn	ENROLL_TOO_SIMPLE To create a template it is neccessary to provide signatures with a certain complexity.
static CicReturn	ENROLLMENT_ERROR For a unknown reason, the signatures couldn't get enrolled.
static CicReturn	FILE_ERROR File error.
static CicReturn	INVALID_ENC_ALG A none valid encryption algorithm number was passed in.
static CicReturn	INVALID_SAMPLECOUNT The enrollment failed because less than 3 signatures where passed into the enrollment function.
static CicReturn	INVALID_THRESHOLD Only threshold values from 0 to 5 are valid.
static CicReturn	NO_INK The CicDoodle object has no ink.
static CicReturn	NO_SIGNATURE A signature was requested which is not available.
static CicReturn	NO_TEMPLATE The function failed because there was no valid user template loaded into the CicSigCheck class.
static CicReturn	OK The function succeded.
static CicReturn	SIG_AMBIGUOUS According to the current verification threshold, this signature was verified as ambiguous.
static CicReturn	SIG_FORGERY The signature could not get verified.
static CicReturn	TEMP_CORRUPT The loading of the template failed because it couldn't get decrypted correctly or there was no valid data in the template.
static CicReturn	TEMP_UNREADABLE The encrypted template could get correctly decrypted.

Method Summary

java.lang.String

toString() Return the error message as a string.

Methods inherited from class java.lang.Object

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

Field Detail

OK

public static final CicReturn OK

The function succeded. Message is: "No error"

NO_INK

public static final CicReturn NO_INK

The CicDoodle object has no ink. The function failed because ink data was needed for it. Error message is: "This signature has no ink"

NO_TEMPLATE

public static final CicReturn NO_TEMPLATE

The function failed because there was no valid user template loaded into the CicSigCheck class. Error message is: "No template was loaded"

TEMP_UNREADABLE

public static final CicReturn TEMP_UNREADABLE

The encrypted template could get correctly decrypted. Make sure that the correct encryption key was set before the verification. Error message is: "Unable to read template"

TEMP_CORRUPT

public static final CicReturn TEMP_CORRUPT

The loading of the template failed because it couldn't get decrypted correctly or there was no valid data in the template. Make sure to set the right encryption key and that the template to get loaded is a correct template file. Error message is: "The template is corrupted"

INVALID_SAMPLECOUNT

public static final CicReturn INVALID_SAMPLECOUNT

The enrollment failed because less than 3 signatures where passed into the enrollment function. Make sure to have at least 3 signatures for the enrollment. error message is: "The number of signatures for Enrollment is less than 3"

ENROLLMENT_ERROR

public static final CicReturn ENROLLMENT_ERROR

For a unknown reason, the signatures couldn't get enrolled. The enrollment procedure should be retried. Error message is: "Cannot enroll signatures"

ENC_KEY_LENGTH

public static final CicReturn ENC_KEY_LENGTH

The encryption key has to be exact 8 byte long, for TRIPLE_DES exact 24 bytes long. Error message is: "The encryption key has an invalid length"

INVALID_ENC_ALG

public static final CicReturn INVALID_ENC_ALG

A none valid encryption algorithm number was passed in. Error message is: "The encryption algorithm is invalid"

INVALID_THRESHOLD

public static final CicReturn INVALID_THRESHOLD

Only threshold values from 0 to 5 are valid. Please make sure a correct value is used. Error message is: "The verification threshold is invalid"

SIG_AMBIGUOUS

public static final CicReturn SIG_AMBIGUOUS

According to the current verification threshold, this signature was verified as ambiguous. This means the verification score is arround the threshold value. Its up to the developer to get this verification pass or not. Error message is: "This signature is ambiguous"

SIG_FORGERY

public static final CicReturn SIG_FORGERY

The signature could not get verified. Error message is: "This signature is a forgery"

FILE_ERROR

public static final CicReturn FILE_ERROR

File error. Error message is: "The specified file does not exist or cannot be accessed"

ENROLL_TOO_SIMPLE

public static final CicReturn ENROLL_TOO_SIMPLE

To create a template it is neccessary to provide signatures with a certain complexity. In general, single characters or single geometric shapes are rejected. The user has to input a more complex signature. Error message: "This signature is too simple. Please use a more complex signature."

ENROLL_TOO_DIFFERENT

public static final CicReturn ENROLL_TOO_DIFFERENT

To cerate a template, the signatures must be consistend, meaning the user can't use 2 or 3 different signatures for enrollment. Error message is: "The signature sample is not consistent with the previous signature. Please enroll with a consistent signature."

NO_SIGNATURE

public static final CicReturn NO_SIGNATURE

A signature was requested which is not available. This error is returned from the 'extractSignature' function if the signature with the specified index from a template is not available. Error message text: "The signature with this index number is not available."

ARRAY_ERROR

public static final CicReturn ARRAY_ERROR

An array passed in has less element as expected. Please make the array large enough.

Method Detail

toString

public java.lang.String toString()

Return the error message as a string.

Overrides:

toString in class java.lang.Object

Returns:

the error string