1 /* 2 * Copyright (C) 2018 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17 package com.android.role.controller.model; 18 19 import android.content.Context; 20 import android.os.UserHandle; 21 22 import androidx.annotation.NonNull; 23 import androidx.annotation.Nullable; 24 25 import java.util.Collections; 26 import java.util.List; 27 28 /** 29 * Interface for behavior of a role. 30 */ 31 public interface RoleBehavior { 32 33 /** 34 * @see Role#onRoleAdded(Context) 35 */ onRoleAdded(@onNull Role role, @NonNull Context context)36 default void onRoleAdded(@NonNull Role role, @NonNull Context context) {} 37 38 /** 39 * @see Role#isAvailableAsUser(UserHandle, Context) 40 */ isAvailableAsUser(@onNull Role role, @NonNull UserHandle user, @NonNull Context context)41 default boolean isAvailableAsUser(@NonNull Role role, @NonNull UserHandle user, 42 @NonNull Context context) { 43 return true; 44 } 45 46 /** 47 * @see Role#getDefaultHolders(Context) 48 */ 49 @NonNull getDefaultHolders(@onNull Role role, @NonNull Context context)50 default List<String> getDefaultHolders(@NonNull Role role, @NonNull Context context) { 51 return Collections.emptyList(); 52 } 53 54 /** 55 * @see Role#getFallbackHolder(Context) 56 */ 57 @Nullable getFallbackHolder(@onNull Role role, @NonNull Context context)58 default String getFallbackHolder(@NonNull Role role, @NonNull Context context) { 59 return null; 60 } 61 62 /** 63 * @see Role#shouldAllowBypassingQualification(Context) 64 */ 65 @Nullable shouldAllowBypassingQualification(@onNull Role role, @NonNull Context context)66 default Boolean shouldAllowBypassingQualification(@NonNull Role role, 67 @NonNull Context context) { 68 return null; 69 } 70 71 /** 72 * @see Role#isPackageQualified(String, Context) 73 */ 74 @Nullable isPackageQualified(@onNull Role role, @NonNull String packageName, @NonNull Context context)75 default Boolean isPackageQualified(@NonNull Role role, @NonNull String packageName, 76 @NonNull Context context) { 77 return null; 78 } 79 80 /** 81 * @see Role#getQualifyingPackagesAsUser(UserHandle, Context) 82 */ 83 @Nullable getQualifyingPackagesAsUser(@onNull Role role, @NonNull UserHandle user, @NonNull Context context)84 default List<String> getQualifyingPackagesAsUser(@NonNull Role role, @NonNull UserHandle user, 85 @NonNull Context context) { 86 return null; 87 } 88 89 /** 90 * @see Role#grant(String, boolean, boolean, boolean, Context) 91 */ grant(@onNull Role role, @NonNull String packageName, @NonNull Context context)92 default void grant(@NonNull Role role, @NonNull String packageName, @NonNull Context context) {} 93 94 /** 95 * @see Role#revoke(String, boolean, boolean, Context) 96 */ revoke(@onNull Role role, @NonNull String packageName, @NonNull Context context)97 default void revoke(@NonNull Role role, @NonNull String packageName, 98 @NonNull Context context) {} 99 100 /** 101 * @see Role#onHolderSelectedAsUser(String, UserHandle, Context) 102 */ onHolderSelectedAsUser(@onNull Role role, @NonNull String packageName, @NonNull UserHandle user, @NonNull Context context)103 default void onHolderSelectedAsUser(@NonNull Role role, @NonNull String packageName, 104 @NonNull UserHandle user, @NonNull Context context) {} 105 106 /** 107 * @see Role#onHolderChangedAsUser(String, UserHandle, Context) 108 */ onHolderChangedAsUser(@onNull Role role, @NonNull UserHandle user, @NonNull Context context)109 default void onHolderChangedAsUser(@NonNull Role role, @NonNull UserHandle user, 110 @NonNull Context context) {} 111 } 112