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