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