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