summaryrefslogtreecommitdiff
path: root/service/java/com/android/role/persistence/RolesState.java
blob: 26644c358f07417373d3082b1988bc18ef31d7f9 (plain)
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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
/*
 * Copyright (C) 2020 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.role.persistence;

import android.annotation.FlaggedApi;
import android.annotation.NonNull;
import android.annotation.Nullable;
import android.annotation.SystemApi;
import android.annotation.SystemApi.Client;
import android.permission.flags.Flags;
import android.util.ArraySet;

import java.util.Map;
import java.util.Objects;
import java.util.Set;

/**
 * State of all roles.
 *
 * TODO(b/147914847): Remove @hide when it becomes the default.
 * @hide
 */
@SystemApi(client = Client.SYSTEM_SERVER)
public final class RolesState {
    /**
     * The version of the roles.
     */
    private final int mVersion;

    /**
     * The hash of all packages in the system.
     */
    @Nullable
    private final String mPackagesHash;

    /**
     * The roles.
     */
    @NonNull
    private final Map<String, Set<String>> mRoles;

    /**
     * The names of roles with fallback enabled.
     */
    @NonNull
    private final Set<String> mFallbackEnabledRoles;

    /**
     * Create a new instance of this class.
     *
     * @param version the version of the roles
     * @param packagesHash the hash of all packages in the system
     * @param roles the roles
     */
    public RolesState(int version, @Nullable String packagesHash,
            @NonNull Map<String, Set<String>> roles) {
        this(version, packagesHash, roles, new ArraySet<>());
    }

    /**
     * Create a new instance of this class.
     *
     * @param version the version of the roles
     * @param packagesHash the hash of all packages in the system
     * @param roles the roles
     * @param fallbackEnabledRoles the roles with fallback enabled
     */
    @FlaggedApi(Flags.FLAG_SYSTEM_SERVER_ROLE_CONTROLLER_ENABLED)
    public RolesState(int version, @Nullable String packagesHash,
            @NonNull Map<String, Set<String>> roles, @NonNull Set<String> fallbackEnabledRoles) {
        mVersion = version;
        mPackagesHash = packagesHash;
        mRoles = roles;
        mFallbackEnabledRoles = fallbackEnabledRoles;
    }

    /**
     * Get the version of the roles.
     *
     * @return the version of the roles
     */
    public int getVersion() {
        return mVersion;
    }

    /**
     * Get the hash of all packages in the system.
     *
     * @return the hash of all packages in the system
     */
    @Nullable
    public String getPackagesHash() {
        return mPackagesHash;
    }

    /**
     * Get the roles.
     *
     * @return the roles
     */
    @NonNull
    public Map<String, Set<String>> getRoles() {
        return mRoles;
    }

    /**
     * Get the fallback enabled roles.
     *
     * @return fallback enabled roles
     */
    @NonNull
    @FlaggedApi(Flags.FLAG_SYSTEM_SERVER_ROLE_CONTROLLER_ENABLED)
    public Set<String> getFallbackEnabledRoles() {
        return mFallbackEnabledRoles;
    }

    @Override
    public boolean equals(Object object) {
        if (this == object) {
            return true;
        }
        if (object == null || getClass() != object.getClass()) {
            return false;
        }
        RolesState that = (RolesState) object;
        return mVersion == that.mVersion
                && Objects.equals(mPackagesHash, that.mPackagesHash)
                && Objects.equals(mRoles, that.mRoles)
                && Objects.equals(mFallbackEnabledRoles, that.mFallbackEnabledRoles);
    }

    @Override
    public int hashCode() {
        return Objects.hash(mVersion, mPackagesHash, mRoles, mFallbackEnabledRoles);
    }
}