adservices/service-core/java/com/android/adservices/data/adselection/AdSelectionDatabase.java


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64

/*
 * Copyright (C) 2022 The Android Open Source Project
 *
 * 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 com.android.adservices.data.adselection;

import android.content.Context;

import androidx.annotation.NonNull;
import androidx.room.Database;
import androidx.room.Room;
import androidx.room.RoomDatabase;
import androidx.room.TypeConverters;

import com.android.adservices.data.common.FledgeRoomConverters;
import com.android.internal.annotations.GuardedBy;

import java.util.Objects;

/** Room based database for Ad Selection. */
@Database(
        exportSchema = false,
        entities = {DBAdSelection.class, DBBuyerDecisionLogic.class, DBAdSelectionOverride.class},
        version = 1)
@TypeConverters({FledgeRoomConverters.class})
public abstract class AdSelectionDatabase extends RoomDatabase {
    private static final Object SINGLETON_LOCK = new Object();

    // TODO(b/230653780): Should we separate the DB.
    public static final String DATABASE_NAME = "adselection.db";

    @GuardedBy("SINGLETON_LOCK")
    private static AdSelectionDatabase sSingleton = null;

    /** Returns an instance of the AdSelectionDatabase given a context. */
    public static AdSelectionDatabase getInstance(@NonNull Context context) {
        Objects.requireNonNull(context);
        synchronized (SINGLETON_LOCK) {
            if (Objects.isNull(sSingleton)) {
                sSingleton =
                        Room.databaseBuilder(context, AdSelectionDatabase.class, DATABASE_NAME)
                                .build();
            }
            return sSingleton;
        }
    }

    /**
     * @return a Dao to access entities in AdSelection database.
     */
    public abstract AdSelectionEntryDao adSelectionEntryDao();
}