com.gemalto.idp.mobile.oob

Class OobResultCode

java.lang.Object

com.gemalto.idp.mobile.oob.OobResultCode

public class OobResultCode
extends java.lang.Object

The definition of the OOB result codes.

It gathers the codes for OOB module, having one big list of potential problems.

Since:

4.0

Field Summary

Fields

Modifier and Type	Field and Description
static int	OOB_AUTHENTICATION_FAILED Invalid authentication token
static int	OOB_ERROR_ACCESS_POINT Access point error
static int	OOB_ERROR_DECODING_RESPONSE Error decoding the response
static int	OOB_ERROR_IN_PARSING_JSON Json parser error
static int	OOB_ERROR_INVALID_CALLBACK Invalid callback
static int	OOB_ERROR_READING_RESPONSE Unable to resolve HTTP response.
static int	OOB_ERROR_REQUEST Request failed
static int	OOB_ERROR_SERVER Server error
static int	OOB_ERROR_STORE_CREDENTIAL Error reading/storing credentials in storage
static int	OOB_GENERIC_EXCEPTION OOB reported error.
static int	OOB_INVALID_APPLICATION_ID Specified application id is invalid
static int	OOB_INVALID_CLIENT_ID Client id that send to the server is invalid or has not yet been registered.
static int	OOB_INVALID_CLIENT_MESSAGE_STATE Error during sending or fetching data, client message state does not allow requested change to message object.
static int	OOB_INVALID_DOMAIN Specified domain name is invalid
static int	OOB_INVALID_MESSAGE_ID Specified message id is invalid
static int	OOB_INVALID_MESSAGE_STATE Error during sending or fetching data, message state does not allow requested change to message object.
static int	OOB_INVALID_PUBLIC_KEY Invalid public key that can be cause by invalid encoding, wrong length, wrong key usage, etc.
static int	OOB_NATIVE_FAILURE
static int	OOB_NETWORK_CONNECTION_PROBLEMS Error during connection with the server, probably network is broken in the middle of communication or there's no network.
static int	OOB_SERVER_COMMUNICATION_ERROR_NETWORK_OFF OOB reported error due to the unavailability of the device on network.
static int	OOB_SERVER_MALFORMED_PROTOCOL_MESSAGE The message that server received cannot be parse because it malformed or now well formated.
static int	OOB_SERVER_MANDATORY_ELEMENT_NOT_FOUND JSON message doesn't contain mandatory element.
static int	OOB_SERVER_REGISTRATION_FAILED_EXPIRED Registration to the OOB server failed: The registration process expired.
static int	OOB_SERVER_REGISTRATION_FAILED_INVALID_CODE Registration to the OOB server failed: The registration code is not valid for the user ID.
static int	OOB_SERVER_UNKNOWN_USER_ID OOB server does not know the specified user.
static int	OOB_SERVER_UNSUPPORTED_PARAMETER Parameter that been sended to the server is not supported.
static int	OOB_TRANSPORT_LAYER_EXCEPTION The exception occurred in the transport layer.

Constructor Summary

Constructors

Constructor and Description
OobResultCode()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

OOB_GENERIC_EXCEPTION

public static final int OOB_GENERIC_EXCEPTION

OOB reported error.

This is the generic error code. It happen during internal process in OOB, probably means some system/low level error which requires an attention of the technical support.

Client application actions:

• Display error message.
• Instruct end user to try again later and if the problem persists then contact his/her customer care.
• To get more details (for technical support and/or customer care):
• Collect more details about the problem from IdpResult.getUserInfo(String).
• Collect stack trace from the IdpResult.getException().

See Also:

Constant Field Values

OOB_SERVER_UNKNOWN_USER_ID

public static final int OOB_SERVER_UNKNOWN_USER_ID

OOB server does not know the specified user.

Client application actions:

• Display error message.
• Instruct end user to check his/her user ID and try again.
• Instruct end user, if the problem persists, to contact his/her customer care to check the validity of his/her user ID.

See Also:

Constant Field Values

OOB_SERVER_REGISTRATION_FAILED_INVALID_CODE

public static final int OOB_SERVER_REGISTRATION_FAILED_INVALID_CODE

Registration to the OOB server failed: The registration code is not valid for the user ID.

Client application actions:

• Display error message.
• Instruct end user to check his/her registration code and try again (note there may be limited number of attempts).
• Instruct end user, if the problem persists, to contact his/her customer care to check the validity of his/her registration code.

See Also:

Constant Field Values

OOB_SERVER_REGISTRATION_FAILED_EXPIRED

public static final int OOB_SERVER_REGISTRATION_FAILED_EXPIRED

Registration to the OOB server failed: The registration process expired.

Client application actions:

• Display error message.
• Instruct end user to contact his/her customer care to re-initialize the registration process.

See Also:

Constant Field Values

OOB_SERVER_COMMUNICATION_ERROR_NETWORK_OFF

public static final int OOB_SERVER_COMMUNICATION_ERROR_NETWORK_OFF

OOB reported error due to the unavailability of the device on network.

Client application actions:

• Display error message.
• Instruct end user to enable some network connection (WiFi, GSM Data, ...), wait it to become really connected and repeat the operation.
• To get more details (for technical support and/or customer care):
• Collect more details about the problem from IdpResult.getUserInfo(String).
• Collect stack trace from the IdpResult.getException().

See Also:

Constant Field Values

OOB_SERVER_MALFORMED_PROTOCOL_MESSAGE

public static final int OOB_SERVER_MALFORMED_PROTOCOL_MESSAGE

The message that server received cannot be parse because it malformed or now well formated.

See Also:

Constant Field Values

OOB_SERVER_MANDATORY_ELEMENT_NOT_FOUND

public static final int OOB_SERVER_MANDATORY_ELEMENT_NOT_FOUND

JSON message doesn't contain mandatory element.

See Also:

Constant Field Values

OOB_SERVER_UNSUPPORTED_PARAMETER

public static final int OOB_SERVER_UNSUPPORTED_PARAMETER

Parameter that been sended to the server is not supported. Please refer to Programmer's Guide.

See Also:

Constant Field Values

OOB_NETWORK_CONNECTION_PROBLEMS

public static final int OOB_NETWORK_CONNECTION_PROBLEMS

Error during connection with the server, probably network is broken in the middle of communication or there's no network.

See Also:

Constant Field Values

OOB_TRANSPORT_LAYER_EXCEPTION

public static final int OOB_TRANSPORT_LAYER_EXCEPTION

The exception occurred in the transport layer.

See Also:

Constant Field Values

OOB_INVALID_PUBLIC_KEY

public static final int OOB_INVALID_PUBLIC_KEY

Invalid public key that can be cause by invalid encoding, wrong length, wrong key usage, etc.

See Also:

Constant Field Values

OOB_INVALID_CLIENT_ID

public static final int OOB_INVALID_CLIENT_ID

Client id that send to the server is invalid or has not yet been registered.

See Also:

Constant Field Values

OOB_INVALID_DOMAIN

public static final int OOB_INVALID_DOMAIN

Specified domain name is invalid

See Also:

Constant Field Values

OOB_INVALID_APPLICATION_ID

public static final int OOB_INVALID_APPLICATION_ID

Specified application id is invalid

See Also:

Constant Field Values

OOB_INVALID_MESSAGE_ID

public static final int OOB_INVALID_MESSAGE_ID

Specified message id is invalid

See Also:

Constant Field Values

OOB_INVALID_CLIENT_MESSAGE_STATE

public static final int OOB_INVALID_CLIENT_MESSAGE_STATE

Error during sending or fetching data, client message state does not allow requested change to message object.

See Also:

Constant Field Values

OOB_INVALID_MESSAGE_STATE

public static final int OOB_INVALID_MESSAGE_STATE

Error during sending or fetching data, message state does not allow requested change to message object.

See Also:

Constant Field Values

OOB_AUTHENTICATION_FAILED

public static final int OOB_AUTHENTICATION_FAILED

Invalid authentication token

See Also:

Constant Field Values

OOB_ERROR_READING_RESPONSE

public static final int OOB_ERROR_READING_RESPONSE

Unable to resolve HTTP response.

See Also:

Constant Field Values

OOB_ERROR_IN_PARSING_JSON

public static final int OOB_ERROR_IN_PARSING_JSON

Json parser error

See Also:

Constant Field Values

OOB_ERROR_STORE_CREDENTIAL

public static final int OOB_ERROR_STORE_CREDENTIAL

Error reading/storing credentials in storage

See Also:

Constant Field Values

OOB_ERROR_DECODING_RESPONSE

public static final int OOB_ERROR_DECODING_RESPONSE

Error decoding the response

See Also:

Constant Field Values

OOB_ERROR_REQUEST

public static final int OOB_ERROR_REQUEST

Request failed

See Also:

Constant Field Values

OOB_ERROR_INVALID_CALLBACK

public static final int OOB_ERROR_INVALID_CALLBACK

Invalid callback

See Also:

Constant Field Values

OOB_ERROR_SERVER

public static final int OOB_ERROR_SERVER

Server error

See Also:

Constant Field Values

OOB_NATIVE_FAILURE

public static final int OOB_NATIVE_FAILURE

See Also:

Constant Field Values

OOB_ERROR_ACCESS_POINT

public static final int OOB_ERROR_ACCESS_POINT

Access point error

See Also:

Constant Field Values

Constructor Detail

OobResultCode

public OobResultCode()