1 /* 2 * Copyright (C) 2021 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.eventlib.events.deviceadminreceivers; 18 19 import android.app.admin.DeviceAdminReceiver; 20 import android.content.Context; 21 import android.content.Intent; 22 import android.os.UserHandle; 23 24 import androidx.annotation.CheckResult; 25 26 import com.android.eventlib.Event; 27 import com.android.eventlib.EventLogger; 28 import com.android.eventlib.EventLogsQuery; 29 import com.android.queryable.info.DeviceAdminReceiverInfo; 30 import com.android.queryable.queries.DeviceAdminReceiverQuery; 31 import com.android.queryable.queries.DeviceAdminReceiverQueryHelper; 32 import com.android.queryable.queries.IntentQueryHelper; 33 import com.android.queryable.queries.UserHandleQuery; 34 import com.android.queryable.queries.UserHandleQueryHelper; 35 import com.android.queryable.util.SerializableParcelWrapper; 36 37 /** 38 * Event logged when {@link DeviceAdminReceiver#onUserAdded(Context, Intent, UserHandle)} is called. 39 */ 40 public final class DeviceAdminUserAddedEvent extends Event { 41 42 private static final long serialVersionUID = 1; 43 44 /** Begins a query for {@link DeviceAdminUserAddedEvent} events. */ queryPackage(String packageName)45 public static DeviceAdminUserAddedEventQuery queryPackage(String packageName) { 46 return new DeviceAdminUserAddedEventQuery(packageName); 47 } 48 49 /** {@link EventLogsQuery} for {@link DeviceAdminUserAddedEvent}. */ 50 public static final class DeviceAdminUserAddedEventQuery 51 extends EventLogsQuery<DeviceAdminUserAddedEvent, 52 DeviceAdminUserAddedEventQuery> { 53 54 private static final long serialVersionUID = 1; 55 56 DeviceAdminReceiverQueryHelper<DeviceAdminUserAddedEventQuery> mDeviceAdminReceiver = 57 new DeviceAdminReceiverQueryHelper<>(this); 58 IntentQueryHelper<DeviceAdminUserAddedEventQuery> mIntent = 59 new IntentQueryHelper<>(this); 60 UserHandleQueryHelper<DeviceAdminUserAddedEventQuery> mAddedUser = 61 new UserHandleQueryHelper<>(this); 62 DeviceAdminUserAddedEventQuery(String packageName)63 private DeviceAdminUserAddedEventQuery(String packageName) { 64 super(DeviceAdminUserAddedEvent.class, packageName); 65 } 66 67 /** 68 * Queries {@link Intent} passed into 69 * {@link DeviceAdminReceiver#onUserAdded(Context, Intent, UserHandle)}. 70 */ 71 @CheckResult whereIntent()72 public IntentQueryHelper<DeviceAdminUserAddedEventQuery> whereIntent() { 73 return mIntent; 74 } 75 76 /** Queries {@link DeviceAdminReceiver}. */ 77 @CheckResult whereDeviceAdminReceiver()78 public DeviceAdminReceiverQuery<DeviceAdminUserAddedEventQuery> whereDeviceAdminReceiver() { 79 return mDeviceAdminReceiver; 80 } 81 82 /** Queries {@link UserHandle} passed into 83 * {@link DeviceAdminReceiver#onUserAdded(Context, Intent, UserHandle)}. 84 */ 85 @CheckResult whereAddedUser()86 public UserHandleQuery<DeviceAdminUserAddedEventQuery> whereAddedUser() { 87 return mAddedUser; 88 } 89 90 @Override filter(DeviceAdminUserAddedEvent event)91 protected boolean filter(DeviceAdminUserAddedEvent event) { 92 if (!mIntent.matches(event.mIntent)) { 93 return false; 94 } 95 if (!mDeviceAdminReceiver.matches(event.mDeviceAdminReceiver)) { 96 return false; 97 } 98 if (!mAddedUser.matches(event.mAddedUser)) { 99 return false; 100 } 101 return true; 102 } 103 104 @Override describeQuery(String fieldName)105 public String describeQuery(String fieldName) { 106 return toStringBuilder(DeviceAdminUserAddedEvent.class, this) 107 .field("intent", mIntent) 108 .field("deviceAdminReceiver", mDeviceAdminReceiver) 109 .field("addedUser", mAddedUser) 110 .toString(); 111 } 112 } 113 114 /** Begins logging a {@link DeviceAdminUserAddedEvent}. */ logger( DeviceAdminReceiver deviceAdminReceiver, Context context, Intent intent, UserHandle addedUser)115 public static DeviceAdminUserAddedEventLogger logger( 116 DeviceAdminReceiver deviceAdminReceiver, Context context, 117 Intent intent, UserHandle addedUser) { 118 return new DeviceAdminUserAddedEventLogger(deviceAdminReceiver, context, intent, addedUser); 119 } 120 121 /** {@link EventLogger} for {@link DeviceAdminUserAddedEvent}. */ 122 public static final class DeviceAdminUserAddedEventLogger 123 extends EventLogger<DeviceAdminUserAddedEvent> { DeviceAdminUserAddedEventLogger( DeviceAdminReceiver deviceAdminReceiver, Context context, Intent intent, UserHandle addedUser)124 private DeviceAdminUserAddedEventLogger( 125 DeviceAdminReceiver deviceAdminReceiver, Context context, 126 Intent intent, UserHandle addedUser) { 127 super(context, new DeviceAdminUserAddedEvent()); 128 mEvent.mIntent = new SerializableParcelWrapper<>(intent); 129 mEvent.mAddedUser = new SerializableParcelWrapper<>(addedUser); 130 setDeviceAdminReceiver(deviceAdminReceiver); 131 } 132 133 /** Sets the {@link DeviceAdminReceiver} which received this event. */ setDeviceAdminReceiver( DeviceAdminReceiver deviceAdminReceiver)134 public DeviceAdminUserAddedEventLogger setDeviceAdminReceiver( 135 DeviceAdminReceiver deviceAdminReceiver) { 136 mEvent.mDeviceAdminReceiver = new DeviceAdminReceiverInfo(deviceAdminReceiver); 137 return this; 138 } 139 140 /** Sets the {@link DeviceAdminReceiver} which received this event. */ setDeviceAdminReceiver( Class<? extends DeviceAdminReceiver> deviceAdminReceiverClass)141 public DeviceAdminUserAddedEventLogger setDeviceAdminReceiver( 142 Class<? extends DeviceAdminReceiver> deviceAdminReceiverClass) { 143 mEvent.mDeviceAdminReceiver = new DeviceAdminReceiverInfo(deviceAdminReceiverClass); 144 return this; 145 } 146 147 /** Sets the {@link DeviceAdminReceiver} which received this event. */ setDeviceAdminReceiver( String deviceAdminReceiverClassName)148 public DeviceAdminUserAddedEventLogger setDeviceAdminReceiver( 149 String deviceAdminReceiverClassName) { 150 mEvent.mDeviceAdminReceiver = new DeviceAdminReceiverInfo(deviceAdminReceiverClassName); 151 return this; 152 } 153 154 /** Sets the {@link Intent} which was received. */ setIntent(Intent intent)155 public DeviceAdminUserAddedEventLogger setIntent(Intent intent) { 156 mEvent.mIntent = new SerializableParcelWrapper<>(intent); 157 return this; 158 } 159 160 /** Sets the {@link UserHandle}. */ setAddedUser(UserHandle addedUser)161 public DeviceAdminUserAddedEventLogger setAddedUser(UserHandle addedUser) { 162 mEvent.mAddedUser = new SerializableParcelWrapper<>(addedUser); 163 return this; 164 } 165 } 166 167 protected SerializableParcelWrapper<Intent> mIntent; 168 protected SerializableParcelWrapper<UserHandle> mAddedUser; 169 protected DeviceAdminReceiverInfo mDeviceAdminReceiver; 170 171 /** 172 * The {@link Intent} passed into 173 * {@link DeviceAdminReceiver#onUserAdded(Context, Intent, UserHandle)}. 174 */ intent()175 public Intent intent() { 176 if (mIntent == null) { 177 return null; 178 } 179 return mIntent.get(); 180 } 181 182 /** 183 * The {@link UserHandle} passed into 184 * {@link DeviceAdminReceiver#onUserAdded(Context, Intent, UserHandle)}. 185 */ addedUser()186 public UserHandle addedUser() { 187 if (mAddedUser == null) { 188 return null; 189 } 190 return mAddedUser.get(); 191 } 192 193 /** Information about the {@link DeviceAdminReceiver} which received the intent. */ deviceAdminReceiver()194 public DeviceAdminReceiverInfo deviceAdminReceiver() { 195 return mDeviceAdminReceiver; 196 } 197 198 @Override toString()199 public String toString() { 200 return "DeviceAdminUserAddedEvent{" 201 + " intent=" + intent() 202 + ", addedUser=" + addedUser() 203 + ", deviceAdminReceiver=" + mDeviceAdminReceiver 204 + ", packageName='" + mPackageName + "'" 205 + ", timestamp=" + mTimestamp 206 + "}"; 207 } 208 } 209