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