de.greenrobot.dao.database.EncryptedDatabaseOpenHelper Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of greendao-encryption Show documentation
greenDAO is a light and fast ORM for Android
There is a newer version: 3.0.0-beta3
/*
 * Copyright (C) 2011-2016 Markus Junginger, greenrobot (http://greenrobot.org)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package de.greenrobot.dao.database;

import android.content.Context;

import net.sqlcipher.database.SQLiteDatabase;
import net.sqlcipher.database.SQLiteDatabase.CursorFactory;
import net.sqlcipher.database.SQLiteOpenHelper;

/**
 * Like android.database.sqlite.SQLiteOpenHelper, but uses greenDAO's {@link Database} abstraction to create and update
 * an encrypted database.
 */
public abstract class EncryptedDatabaseOpenHelper extends AbstractDatabaseOpenHelper {
    private SQLiteOpenHelper delegate;

    public EncryptedDatabaseOpenHelper(Context context, String name, int version) {
        this(context, name, null, version, true);
    }

    /**
     * @param cursorFactory Must be null or of type net.sqlcipher.database.SQLiteDatabase.CursorFactory
     *                      (using Object here to prevent DaoMaster referencing any SQLCipher classes, which is nicer
     *                      for plain Java unit tests)
     * @param loadNativeLibs if true, {@link SQLiteDatabase#loadLibs(Context)} will be called.
     */
    public EncryptedDatabaseOpenHelper(Context context, String name, Object cursorFactory, int version, boolean loadNativeLibs) {
        if (loadNativeLibs) {
            SQLiteDatabase.loadLibs(context);
        }
        delegate = new Adapter(context, name, (CursorFactory) cursorFactory, version);
    }

    public Database getWritableDatabase(String password) {
        return wrap(delegate.getWritableDatabase(password));
    }

    public Database getWritableDatabase(char[] password) {
        return wrap(delegate.getWritableDatabase(password));
    }

    public Database getReadableDatabase(String password) {
        return wrap(delegate.getReadableDatabase(password));
    }

    public Database getReadableDatabase(char[] password) {
        return wrap(delegate.getReadableDatabase(password));
    }

    public void close() {
        delegate.close();
    }

    protected Database wrap(SQLiteDatabase sqLiteDatabase) {
        return new EncryptedDatabase(sqLiteDatabase);
    }

    private class Adapter extends SQLiteOpenHelper {
        public Adapter(Context context, String name, CursorFactory factory, int version) {
            super(context, name, factory, version);
        }

        @Override
        public void onCreate(SQLiteDatabase db) {
            EncryptedDatabaseOpenHelper.this.onCreate(wrap(db));
        }

        @Override
        public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) {
            EncryptedDatabaseOpenHelper.this.onUpgrade(wrap(db), oldVersion, newVersion);
        }

        @Override
        public void onOpen(SQLiteDatabase db) {
            EncryptedDatabaseOpenHelper.this.onOpen(wrap(db));
        }
    }

}