com.symbol.emdk.securenfc

Enum MifareSamResults

java.lang.Object

java.lang.Enum<MifareSamResults>

com.symbol.emdk.securenfc.MifareSamResults

All Implemented Interfaces:

Serializable, Comparable<MifareSamResults>

public enum MifareSamResults
extends Enum<MifareSamResults>

Defines all the error codes the MifareSAM APIs returns.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALREADY_CONNECTED The SAM is already connected.
AUTH_COND_NOT_SATISFIED SAM in AV1 mode: Key entry cannot be used for authentication, MIFARE SAM AV2 needs to be unlocked with key entry 00h first or KUC limit reached.
EMDK_NOT_OPENED The EMDK is not opened.
FAILURE Failure
INVALID_HOST_KEY The key specified is not a host key
INVALID_KEY The key type or length is invalid.
INVALID_KEY_ENTRY_OR_KUC Referenced data is invalid for key entry or KUC (Key Usage Counters).
INVALID_VALUE Invalid input parameter
KEY_VER_NOT_FOUND The key version is not found.
MEMORY_FAILURE Memory failure (KUC could not be updated).
NFC_DISABLED NFC is disabled in settings, try enabling the NFC.
NOT_CONNECTED The SAM is not connected.
PARAM_NOT_SUPPORTED The parameter not supported.
SAM_KEY_DISABLED The specified SAM key is disabled.
SAM_NOT_AVAILABLE SAM not present in the device.
SAM_NOT_IN_AV1_MODE The SAM is not in the AV1 mode.
SAM_NOT_IN_AV2_MODE The SAM is not in the AV2 mode.
SUCCESS Success
UNDEFINED Error code not defined.

Method Summary

Methods

Modifier and Type	Method and Description
String	getDescription() Returns the description for the error.
int	getValue() This method provides integer value assigned to the enum.
static MifareSamResults	valueOf(String name) Returns the enum constant of this type with the specified name.
static MifareSamResults[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SUCCESS

public static final MifareSamResults SUCCESS

Success

EMDK_NOT_OPENED

public static final MifareSamResults EMDK_NOT_OPENED

The EMDK is not opened.

NFC_DISABLED

public static final MifareSamResults NFC_DISABLED

NFC is disabled in settings, try enabling the NFC.

SAM_NOT_AVAILABLE

public static final MifareSamResults SAM_NOT_AVAILABLE

SAM not present in the device. Try inserting SAM before using the Secure NFC API.

FAILURE

public static final MifareSamResults FAILURE

Failure

ALREADY_CONNECTED

public static final MifareSamResults ALREADY_CONNECTED

The SAM is already connected.

INVALID_VALUE

public static final MifareSamResults INVALID_VALUE

Invalid input parameter

INVALID_KEY

public static final MifareSamResults INVALID_KEY

The key type or length is invalid.

PARAM_NOT_SUPPORTED

public static final MifareSamResults PARAM_NOT_SUPPORTED

The parameter not supported.

NOT_CONNECTED

public static final MifareSamResults NOT_CONNECTED

The SAM is not connected. Try calling connect before making other calls.

SAM_NOT_IN_AV1_MODE

public static final MifareSamResults SAM_NOT_IN_AV1_MODE

The SAM is not in the AV1 mode.

SAM_NOT_IN_AV2_MODE

public static final MifareSamResults SAM_NOT_IN_AV2_MODE

The SAM is not in the AV2 mode.

SAM_KEY_DISABLED

public static final MifareSamResults SAM_KEY_DISABLED

The specified SAM key is disabled.

INVALID_HOST_KEY

public static final MifareSamResults INVALID_HOST_KEY

The key specified is not a host key

MEMORY_FAILURE

public static final MifareSamResults MEMORY_FAILURE

Memory failure (KUC could not be updated).

KEY_VER_NOT_FOUND

public static final MifareSamResults KEY_VER_NOT_FOUND

The key version is not found.

INVALID_KEY_ENTRY_OR_KUC

public static final MifareSamResults INVALID_KEY_ENTRY_OR_KUC

Referenced data is invalid for key entry or KUC (Key Usage Counters).

AUTH_COND_NOT_SATISFIED

public static final MifareSamResults AUTH_COND_NOT_SATISFIED

SAM in AV1 mode: Key entry cannot be used for authentication, MIFARE SAM AV2 needs to be unlocked with key entry 00h first or KUC limit reached. SAM in AV2 mode: Key entry disabled, no Host Key type, startup host authentication accomplished, no lock/unlock key, not key zero, unlock key number and version mismatch, no AES key type, KUC limit exceeded or Unknown key type.

UNDEFINED

public static final MifareSamResults UNDEFINED

Error code not defined.

Method Detail

values

public static MifareSamResults[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (MifareSamResults c : MifareSamResults.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static MifareSamResults valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getValue

public int getValue()

This method provides integer value assigned to the enum. It is recommended only to get error for the UNDEFINED enums at runtime if required.

Returns:

Integer value associated with the error code.

getDescription

public String getDescription()

Returns the description for the error.

Returns:

Returns error description.