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