io.realm.exceptions

Class IncompatibleSyncedFileException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

io.realm.exceptions.RealmFileException

io.realm.exceptions.IncompatibleSyncedFileException

All Implemented Interfaces:

Serializable

public class IncompatibleSyncedFileException
extends RealmFileException

An exception thrown when attempting to open an incompatible Synchronized Realm file. This usually happens when the Realm file was created with an older version of the SDK and automatic migration to the current version is not possible. When such an exception occurs, the original file is moved to a backup location and a new file is created instead. If you wish to migrate any data from the backup location, you can use getBackupRealmConfiguration() to obtain a RealmConfiguration that can then be used to open the backup Realm. After that, retry opening the original Realm file (which now should be recreated as an empty file) and copy all data from the backup file to the new one.

 
  SyncConfiguration syncConfig = new SyncConfiguration.Builder(user, serverUri).build();
  try {
      Realm realm = Realm.getInstance(syncConfig);
  } catch (IncompatibleSyncedFileException exception) {
      RealmConfiguration backupConfig = exception.getBackupRealmConfiguration();
      Realm backupRealm = Realm.getInstance(backupConfig);
      realm = Realm.GetInstance(syncConfig);
  }
 
 

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class io.realm.exceptions.RealmFileException

RealmFileException.Kind

Constructor Summary

Constructors

Constructor and Description
IncompatibleSyncedFileException(String message, String recoveryPath)

Method Summary

Modifier and Type	Method and Description
RealmConfiguration	getBackupRealmConfiguration() Gets a RealmConfiguration instance that can be used to open the backup Realm file.
RealmConfiguration	getBackupRealmConfiguration(byte[] encryptionKey) Gets a RealmConfiguration instance that can be used to open the backup Realm file.
RealmConfiguration	getBackupRealmConfiguration(byte[] encryptionKey, Object... modules) Gets a RealmConfiguration instance that can be used to open the backup Realm file.
String	getRecoveryPath()

Methods inherited from class io.realm.exceptions.RealmFileException

getKind, toString

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object

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

Constructor Detail

IncompatibleSyncedFileException

public IncompatibleSyncedFileException(String message,
                                       String recoveryPath)

Method Detail

getBackupRealmConfiguration

public RealmConfiguration getBackupRealmConfiguration()

Gets a RealmConfiguration instance that can be used to open the backup Realm file. Note: This will use the default Realm module (composed of all RealmModel), and assume no encryption should be used as well.

Returns:

A configuration object for the backup Realm.

getBackupRealmConfiguration

public RealmConfiguration getBackupRealmConfiguration(byte[] encryptionKey)

Gets a RealmConfiguration instance that can be used to open the backup Realm file. Note: This will use the default Realm module (composed of all RealmModel).

Parameters:

encryptionKey - Optional encryption key that was used to encrypt the original Realm file.

Returns:

A configuration object for the backup Realm.

getBackupRealmConfiguration

public RealmConfiguration getBackupRealmConfiguration(byte[] encryptionKey,
                                                      Object... modules)

Gets a RealmConfiguration instance that can be used to open the backup Realm file.

Parameters:

encryptionKey - Optional encryption key that was used to encrypt the original Realm file.

modules - restricts Realm schema to the provided module.

Returns:

A configuration object for the backup Realm.

getRecoveryPath

public String getRecoveryPath()

Returns:

Absolute path to the backup Realm file.