io.realm

Enum ErrorCode

java.lang.Object

java.lang.Enum<ErrorCode>

io.realm.ErrorCode

All Implemented Interfaces:

Serializable, Comparable<ErrorCode>

public enum ErrorCode
extends Enum<ErrorCode>

This class enumerate all potential errors related to using the Object Server or synchronizing data.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ErrorCode.Category
static class	ErrorCode.Type

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACCESS_DENIED
AMBIGUOUS_PERMISSION_OFFER_TOKEN
BAD_AUTHENTICATION
BAD_CHANGESET
BAD_CHANGESET_HEADER_SYNTAX
BAD_CHANGESET_SIZE
BAD_CHANGESETS
BAD_CLIENT_FILE_IDENT
BAD_CLIENT_VERSION
BAD_CLIENT_VERSION_DOWNLOAD
BAD_COMPRESSION
BAD_DECOMPRESSION
BAD_ERROR_CODE
BAD_GATEWAY
BAD_MESSAGE_ORDER
BAD_ORIGIN_FILE_IDENT
BAD_REQUEST
BAD_REQUEST_IDENT
BAD_SERVER_FILE_IDENT
BAD_SERVER_VERSION
BAD_SESSION_IDENT
BAD_SYNTAX
BOUND_IN_OTHER_SESSION
CLIENT_BAD_CHANGESET
CLIENT_BAD_CHANGESET_HEADER_SYNTAX
CLIENT_BAD_CHANGESET_SIZE
CLIENT_BAD_CLIENT_FILE_IDENT
CLIENT_BAD_CLIENT_FILE_IDENT_SALT
CLIENT_BAD_MESSAGE_ORDER
CLIENT_BAD_ORIGIN_FILE_IDENT
CLIENT_BAD_PROGRESS
CLIENT_BAD_SERVER_VERSION
CLIENT_BAD_SESSION_IDENT
CLIENT_BAD_TIMESTAMP
CLIENT_CONNECT_TIMEOUT
CLIENT_CONNECTION_CLOSED
CLIENT_FILE_IDENT
CLIENT_LIMITS_EXCEEDED
CLIENT_RESET
CLIENT_UNKNOWN_MESSAGE
CONFLICT
CONNECTION_ADDRESS_IN_USE
CONNECTION_CLOSED
CONNECTION_CONNECTION_ABORTED
CONNECTION_REFUSED
CONNECTION_RESET_BY_PEER
CONNECTION_SOCKET_SHUTDOWN
DISABLED_SESSION
DIVERGING_HISTORIES
EXISTING_ACCOUNT
EXPECTATION_FAILED
EXPIRED_PERMISSION_OFFER
EXPIRED_REFRESH_TOKEN
FAILED_DEPENDENCY
FILE_MAY_NOT_BE_SHARED
FORBIDDEN
FOUND
GATEWAY_TIMEOUT
GONE
HTTP_VERSION_NOT_SUPPORTED
ILLEGAL_REALM_PATH
INSUFFICIENT_STORAGE
INTERNAL_SERVER_ERROR
INVALID_CREDENTIALS
INVALID_HOST
INVALID_PARAMETERS
IO_EXCEPTION
JSON_EXCEPTION
LENGTH_REQUIRED
LIMITS_EXCEEDED
LOCKED
LOOP_DETECTED
METHOD_NOT_ALLOWED
MISC_DELIMITER_NOT_FOUND
MISC_END_OF_INPUT
MISC_PREMATURE_END_OF_INPUT
MISDIRECTED_REQUEST
MISSING_PARAMETERS
MOVED_PERMANENTLY
MULTIPLE_CHOICES
NETWORK_AUTHENTICATION_REQUIRED
NO_SUCH_PATH
NOT_ACCEPTABLE
NOT_EXTENDED
NOT_FOUND
NOT_IMPLEMENTED
NOT_MODIFIED
OTHER_ERROR
OTHER_SESSION_ERROR
PARTIAL_SYNC_DISABLED
PAYLOAD_TOO_LARGE
PAYMENT_REQUIRED
PERMANENT_REDIRECT
PERMISSION_DENIED
PONG_TIMEOUT
PRECONDITION_FAILED
PRECONDITION_REQUIRED
PROXY_AUTHENTICATION_REQUIRED
RANGE_NOT_SATISFIABLE
REALM_NOT_FOUND
REQUEST_HEADER_FIELDS_TOO_LARGE
REQUEST_TIMEOUT
REUSE_OF_SESSION_IDENT
SEE_OTHER
SERVER_MISCONFIGURATION
SERVICE_UNAVAILABLE
SESSION_CLOSED
SSL_SERVER_CERT_REJECTED
TEMPORARY_REDIRECT
TOKEN_EXPIRED
TOO_MANY_REQUESTS
UNAUTHORIZED
UNAVAILABLE_FOR_LEGAL_REASONS
UNKNOWN
UNKNOWN_ACCOUNT
UNKNOWN_MESSAGE
UNKNOWN_USER
UNPROCESSABLE_ENTITY
UNSUPPORTED_MEDIA_TYPE
UNSUPPORTED_SESSION_FEATURE
UPGRADE_REQUIRED
URI_TOO_LONG
USE_PROXY
VARIANT_ALSO_NEGOTIATES
WRONG_PROTOCOL_VERSION
WRONG_REALM_TYPE

Method Summary

Modifier and Type	Method and Description
static ErrorCode	fromException(Exception exception) Helper method for mapping between Exception and ErrorCode.
static ErrorCode	fromInt(int errorCode) Deprecated.
static ErrorCode	fromNativeError(String type, int errorCode) Converts a native error to the appropriate Java equivalent
ErrorCode.Category	getCategory() Returns the getCategory of the error.
String	getType() Returns the type of error.
int	intValue() Returns the numerical value for this error code.
String	toString()
static ErrorCode	valueOf(String name) Returns the enum constant of this type with the specified name.
static ErrorCode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

UNKNOWN

public static final ErrorCode UNKNOWN

IO_EXCEPTION

public static final ErrorCode IO_EXCEPTION

JSON_EXCEPTION

public static final ErrorCode JSON_EXCEPTION

CLIENT_RESET

public static final ErrorCode CLIENT_RESET

CONNECTION_CLOSED

public static final ErrorCode CONNECTION_CLOSED

OTHER_ERROR

public static final ErrorCode OTHER_ERROR

UNKNOWN_MESSAGE

public static final ErrorCode UNKNOWN_MESSAGE

BAD_SYNTAX

public static final ErrorCode BAD_SYNTAX

LIMITS_EXCEEDED

public static final ErrorCode LIMITS_EXCEEDED

WRONG_PROTOCOL_VERSION

public static final ErrorCode WRONG_PROTOCOL_VERSION

BAD_SESSION_IDENT

public static final ErrorCode BAD_SESSION_IDENT

REUSE_OF_SESSION_IDENT

public static final ErrorCode REUSE_OF_SESSION_IDENT

BOUND_IN_OTHER_SESSION

public static final ErrorCode BOUND_IN_OTHER_SESSION

BAD_MESSAGE_ORDER

public static final ErrorCode BAD_MESSAGE_ORDER

BAD_DECOMPRESSION

public static final ErrorCode BAD_DECOMPRESSION

BAD_CHANGESET_HEADER_SYNTAX

public static final ErrorCode BAD_CHANGESET_HEADER_SYNTAX

BAD_CHANGESET_SIZE

public static final ErrorCode BAD_CHANGESET_SIZE

BAD_CHANGESETS

public static final ErrorCode BAD_CHANGESETS

SESSION_CLOSED

public static final ErrorCode SESSION_CLOSED

OTHER_SESSION_ERROR

public static final ErrorCode OTHER_SESSION_ERROR

TOKEN_EXPIRED

public static final ErrorCode TOKEN_EXPIRED

BAD_AUTHENTICATION

public static final ErrorCode BAD_AUTHENTICATION

ILLEGAL_REALM_PATH

public static final ErrorCode ILLEGAL_REALM_PATH

NO_SUCH_PATH

public static final ErrorCode NO_SUCH_PATH

PERMISSION_DENIED

public static final ErrorCode PERMISSION_DENIED

BAD_SERVER_FILE_IDENT

public static final ErrorCode BAD_SERVER_FILE_IDENT

BAD_CLIENT_FILE_IDENT

public static final ErrorCode BAD_CLIENT_FILE_IDENT

BAD_SERVER_VERSION

public static final ErrorCode BAD_SERVER_VERSION

BAD_CLIENT_VERSION

public static final ErrorCode BAD_CLIENT_VERSION

DIVERGING_HISTORIES

public static final ErrorCode DIVERGING_HISTORIES

BAD_CHANGESET

public static final ErrorCode BAD_CHANGESET

DISABLED_SESSION

public static final ErrorCode DISABLED_SESSION

PARTIAL_SYNC_DISABLED

public static final ErrorCode PARTIAL_SYNC_DISABLED

UNSUPPORTED_SESSION_FEATURE

public static final ErrorCode UNSUPPORTED_SESSION_FEATURE

BAD_ORIGIN_FILE_IDENT

public static final ErrorCode BAD_ORIGIN_FILE_IDENT

CLIENT_CONNECTION_CLOSED

public static final ErrorCode CLIENT_CONNECTION_CLOSED

CLIENT_UNKNOWN_MESSAGE

public static final ErrorCode CLIENT_UNKNOWN_MESSAGE

CLIENT_LIMITS_EXCEEDED

public static final ErrorCode CLIENT_LIMITS_EXCEEDED

CLIENT_BAD_SESSION_IDENT

public static final ErrorCode CLIENT_BAD_SESSION_IDENT

CLIENT_BAD_MESSAGE_ORDER

public static final ErrorCode CLIENT_BAD_MESSAGE_ORDER

CLIENT_BAD_CLIENT_FILE_IDENT

public static final ErrorCode CLIENT_BAD_CLIENT_FILE_IDENT

CLIENT_BAD_PROGRESS

public static final ErrorCode CLIENT_BAD_PROGRESS

CLIENT_BAD_CHANGESET_HEADER_SYNTAX

public static final ErrorCode CLIENT_BAD_CHANGESET_HEADER_SYNTAX

CLIENT_BAD_CHANGESET_SIZE

public static final ErrorCode CLIENT_BAD_CHANGESET_SIZE

CLIENT_BAD_ORIGIN_FILE_IDENT

public static final ErrorCode CLIENT_BAD_ORIGIN_FILE_IDENT

CLIENT_BAD_SERVER_VERSION

public static final ErrorCode CLIENT_BAD_SERVER_VERSION

CLIENT_BAD_CHANGESET

public static final ErrorCode CLIENT_BAD_CHANGESET

BAD_REQUEST_IDENT

public static final ErrorCode BAD_REQUEST_IDENT

BAD_ERROR_CODE

public static final ErrorCode BAD_ERROR_CODE

BAD_COMPRESSION

public static final ErrorCode BAD_COMPRESSION

BAD_CLIENT_VERSION_DOWNLOAD

public static final ErrorCode BAD_CLIENT_VERSION_DOWNLOAD

SSL_SERVER_CERT_REJECTED

public static final ErrorCode SSL_SERVER_CERT_REJECTED

PONG_TIMEOUT

public static final ErrorCode PONG_TIMEOUT

CLIENT_BAD_CLIENT_FILE_IDENT_SALT

public static final ErrorCode CLIENT_BAD_CLIENT_FILE_IDENT_SALT

CLIENT_FILE_IDENT

public static final ErrorCode CLIENT_FILE_IDENT

CLIENT_CONNECT_TIMEOUT

public static final ErrorCode CLIENT_CONNECT_TIMEOUT

CLIENT_BAD_TIMESTAMP

public static final ErrorCode CLIENT_BAD_TIMESTAMP

MULTIPLE_CHOICES

public static final ErrorCode MULTIPLE_CHOICES

MOVED_PERMANENTLY

public static final ErrorCode MOVED_PERMANENTLY

FOUND

public static final ErrorCode FOUND

SEE_OTHER

public static final ErrorCode SEE_OTHER

NOT_MODIFIED

public static final ErrorCode NOT_MODIFIED

USE_PROXY

public static final ErrorCode USE_PROXY

TEMPORARY_REDIRECT

public static final ErrorCode TEMPORARY_REDIRECT

PERMANENT_REDIRECT

public static final ErrorCode PERMANENT_REDIRECT

BAD_REQUEST

public static final ErrorCode BAD_REQUEST

UNAUTHORIZED

public static final ErrorCode UNAUTHORIZED

PAYMENT_REQUIRED

public static final ErrorCode PAYMENT_REQUIRED

FORBIDDEN

public static final ErrorCode FORBIDDEN

NOT_FOUND

public static final ErrorCode NOT_FOUND

METHOD_NOT_ALLOWED

public static final ErrorCode METHOD_NOT_ALLOWED

NOT_ACCEPTABLE

public static final ErrorCode NOT_ACCEPTABLE

PROXY_AUTHENTICATION_REQUIRED

public static final ErrorCode PROXY_AUTHENTICATION_REQUIRED

REQUEST_TIMEOUT

public static final ErrorCode REQUEST_TIMEOUT

CONFLICT

public static final ErrorCode CONFLICT

GONE

public static final ErrorCode GONE

LENGTH_REQUIRED

public static final ErrorCode LENGTH_REQUIRED

PRECONDITION_FAILED

public static final ErrorCode PRECONDITION_FAILED

PAYLOAD_TOO_LARGE

public static final ErrorCode PAYLOAD_TOO_LARGE

URI_TOO_LONG

public static final ErrorCode URI_TOO_LONG

UNSUPPORTED_MEDIA_TYPE

public static final ErrorCode UNSUPPORTED_MEDIA_TYPE

RANGE_NOT_SATISFIABLE

public static final ErrorCode RANGE_NOT_SATISFIABLE

EXPECTATION_FAILED

public static final ErrorCode EXPECTATION_FAILED

MISDIRECTED_REQUEST

public static final ErrorCode MISDIRECTED_REQUEST

UNPROCESSABLE_ENTITY

public static final ErrorCode UNPROCESSABLE_ENTITY

LOCKED

public static final ErrorCode LOCKED

FAILED_DEPENDENCY

public static final ErrorCode FAILED_DEPENDENCY

UPGRADE_REQUIRED

public static final ErrorCode UPGRADE_REQUIRED

PRECONDITION_REQUIRED

public static final ErrorCode PRECONDITION_REQUIRED

TOO_MANY_REQUESTS

public static final ErrorCode TOO_MANY_REQUESTS

REQUEST_HEADER_FIELDS_TOO_LARGE

public static final ErrorCode REQUEST_HEADER_FIELDS_TOO_LARGE

UNAVAILABLE_FOR_LEGAL_REASONS

public static final ErrorCode UNAVAILABLE_FOR_LEGAL_REASONS

INTERNAL_SERVER_ERROR

public static final ErrorCode INTERNAL_SERVER_ERROR

NOT_IMPLEMENTED

public static final ErrorCode NOT_IMPLEMENTED

BAD_GATEWAY

public static final ErrorCode BAD_GATEWAY

SERVICE_UNAVAILABLE

public static final ErrorCode SERVICE_UNAVAILABLE

GATEWAY_TIMEOUT

public static final ErrorCode GATEWAY_TIMEOUT

HTTP_VERSION_NOT_SUPPORTED

public static final ErrorCode HTTP_VERSION_NOT_SUPPORTED

VARIANT_ALSO_NEGOTIATES

public static final ErrorCode VARIANT_ALSO_NEGOTIATES

INSUFFICIENT_STORAGE

public static final ErrorCode INSUFFICIENT_STORAGE

LOOP_DETECTED

public static final ErrorCode LOOP_DETECTED

NOT_EXTENDED

public static final ErrorCode NOT_EXTENDED

NETWORK_AUTHENTICATION_REQUIRED

public static final ErrorCode NETWORK_AUTHENTICATION_REQUIRED

INVALID_PARAMETERS

public static final ErrorCode INVALID_PARAMETERS

MISSING_PARAMETERS

public static final ErrorCode MISSING_PARAMETERS

INVALID_CREDENTIALS

public static final ErrorCode INVALID_CREDENTIALS

UNKNOWN_ACCOUNT

public static final ErrorCode UNKNOWN_ACCOUNT

EXISTING_ACCOUNT

public static final ErrorCode EXISTING_ACCOUNT

ACCESS_DENIED

public static final ErrorCode ACCESS_DENIED

EXPIRED_REFRESH_TOKEN

public static final ErrorCode EXPIRED_REFRESH_TOKEN

INVALID_HOST

public static final ErrorCode INVALID_HOST

REALM_NOT_FOUND

public static final ErrorCode REALM_NOT_FOUND

UNKNOWN_USER

public static final ErrorCode UNKNOWN_USER

WRONG_REALM_TYPE

public static final ErrorCode WRONG_REALM_TYPE

EXPIRED_PERMISSION_OFFER

public static final ErrorCode EXPIRED_PERMISSION_OFFER

AMBIGUOUS_PERMISSION_OFFER_TOKEN

public static final ErrorCode AMBIGUOUS_PERMISSION_OFFER_TOKEN

FILE_MAY_NOT_BE_SHARED

public static final ErrorCode FILE_MAY_NOT_BE_SHARED

SERVER_MISCONFIGURATION

public static final ErrorCode SERVER_MISCONFIGURATION

CONNECTION_RESET_BY_PEER

public static final ErrorCode CONNECTION_RESET_BY_PEER

CONNECTION_SOCKET_SHUTDOWN

public static final ErrorCode CONNECTION_SOCKET_SHUTDOWN

CONNECTION_REFUSED

public static final ErrorCode CONNECTION_REFUSED

CONNECTION_ADDRESS_IN_USE

public static final ErrorCode CONNECTION_ADDRESS_IN_USE

CONNECTION_CONNECTION_ABORTED

public static final ErrorCode CONNECTION_CONNECTION_ABORTED

MISC_END_OF_INPUT

public static final ErrorCode MISC_END_OF_INPUT

MISC_PREMATURE_END_OF_INPUT

public static final ErrorCode MISC_PREMATURE_END_OF_INPUT

MISC_DELIMITER_NOT_FOUND

public static final ErrorCode MISC_DELIMITER_NOT_FOUND

Method Detail

values

public static ErrorCode[] 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 (ErrorCode c : ErrorCode.values())
    System.out.println(c);

Returns:

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

valueOf

public static ErrorCode 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

toString

public String toString()

Overrides:

toString in class Enum<ErrorCode>

intValue

public int intValue()

Returns the numerical value for this error code. Note that an error is only uniquely identified by the (type:value) pair.

Returns:

the error code as an unique int value.

getCategory

public ErrorCode.Category getCategory()

Returns the getCategory of the error.

Errors come in 2 categories: FATAL, RECOVERABLE

FATAL: The session cannot be recovered and needs to be re-created. A likely cause is that the User does not have access to this Realm. Check that the SyncConfiguration is correct.

RECOVERABLE: Temporary error. The session will automatically try to recover as soon as possible.

Returns:

the severity of the error.

getType

public String getType()

Returns the type of error. Note that an error is only uniquely identified by the (type:value) pair.

Returns:

the type of error.

fromNativeError

public static ErrorCode fromNativeError(String type,
                                        int errorCode)

Converts a native error to the appropriate Java equivalent

Parameters:

type - type of error. This is normally the C++ category.

errorCode - specific code within the type

Returns:

the Java error representing the native error. This method will never throw, so in case a Java error does not exists. UNKNOWN will be returned.

fromInt

@Deprecated
public static ErrorCode fromInt(int errorCode)

Deprecated.

fromException

public static ErrorCode fromException(Exception exception)

Helper method for mapping between Exception and ErrorCode.

Parameters:

exception - to be mapped as an ErrorCode.

Returns:

mapped ErrorCode.