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#onPasswordExpiring(Context, Intent)} or 39 * {@link DeviceAdminReceiver#onPasswordExpiring(Context, Intent, UserHandle)} is called. 40 */ 41 public final class DeviceAdminPasswordExpiringEvent extends Event { 42 43 private static final long serialVersionUID = 1; 44 45 /** Begins a query for {@link DeviceAdminPasswordExpiringEvent} events. */ queryPackage(String packageName)46 public static DeviceAdminPasswordExpiringEventQuery queryPackage(String packageName) { 47 return new DeviceAdminPasswordExpiringEventQuery(packageName); 48 } 49 50 /** {@link EventLogsQuery} for {@link DeviceAdminPasswordExpiringEvent}. */ 51 public static final class DeviceAdminPasswordExpiringEventQuery 52 extends EventLogsQuery<DeviceAdminPasswordExpiringEvent, 53 DeviceAdminPasswordExpiringEventQuery> { 54 55 private static final long serialVersionUID = 1; 56 57 DeviceAdminReceiverQueryHelper<DeviceAdminPasswordExpiringEventQuery> mDeviceAdminReceiver = 58 new DeviceAdminReceiverQueryHelper<>(this); 59 IntentQueryHelper<DeviceAdminPasswordExpiringEventQuery> mIntent = 60 new IntentQueryHelper<>(this); 61 UserHandleQueryHelper<DeviceAdminPasswordExpiringEventQuery> mUser = 62 new UserHandleQueryHelper<>(this); 63 DeviceAdminPasswordExpiringEventQuery(String packageName)64 private DeviceAdminPasswordExpiringEventQuery(String packageName) { 65 super(DeviceAdminPasswordExpiringEvent.class, packageName); 66 } 67 68 /** 69 * Queries {@link Intent} passed into 70 * {@link DeviceAdminReceiver#onPasswordExpiring(Context, Intent)}. 71 */ 72 @CheckResult whereIntent()73 public IntentQueryHelper<DeviceAdminPasswordExpiringEventQuery> whereIntent() { 74 return mIntent; 75 } 76 77 /** Queries {@link DeviceAdminReceiver}. */ 78 @CheckResult whereDeviceAdminReceiver()79 public DeviceAdminReceiverQuery<DeviceAdminPasswordExpiringEventQuery> whereDeviceAdminReceiver() { 80 return mDeviceAdminReceiver; 81 } 82 83 /** Queries {@link UserHandle} passed into 84 * {@link DeviceAdminReceiver#onPasswordExpiring(Context, Intent, UserHandle)}. 85 */ 86 @CheckResult whereUser()87 public UserHandleQuery<DeviceAdminPasswordExpiringEventQuery> whereUser() { 88 return mUser; 89 } 90 91 @Override filter(DeviceAdminPasswordExpiringEvent event)92 protected boolean filter(DeviceAdminPasswordExpiringEvent event) { 93 if (!mIntent.matches(event.mIntent)) { 94 return false; 95 } 96 if (!mDeviceAdminReceiver.matches(event.mDeviceAdminReceiver)) { 97 return false; 98 } 99 if (!mUser.matches(event.mUser)) { 100 return false; 101 } 102 return true; 103 } 104 105 @Override describeQuery(String fieldName)106 public String describeQuery(String fieldName) { 107 return toStringBuilder(DeviceAdminPasswordExpiringEvent.class, this) 108 .field("intent", mIntent) 109 .field("deviceAdminReceiver", mDeviceAdminReceiver) 110 .field("user", mUser) 111 .toString(); 112 } 113 } 114 115 /** Begins logging a {@link DeviceAdminPasswordExpiringEvent}. */ logger( DeviceAdminReceiver deviceAdminReceiver, Context context, Intent intent)116 public static DeviceAdminPasswordExpiringEventLogger logger( 117 DeviceAdminReceiver deviceAdminReceiver, Context context, Intent intent) { 118 return new DeviceAdminPasswordExpiringEventLogger(deviceAdminReceiver, context, intent); 119 } 120 121 /** {@link EventLogger} for {@link DeviceAdminPasswordExpiringEvent}. */ 122 public static final class DeviceAdminPasswordExpiringEventLogger 123 extends EventLogger<DeviceAdminPasswordExpiringEvent> { DeviceAdminPasswordExpiringEventLogger( DeviceAdminReceiver deviceAdminReceiver, Context context, Intent intent)124 private DeviceAdminPasswordExpiringEventLogger( 125 DeviceAdminReceiver deviceAdminReceiver, Context context, Intent intent) { 126 super(context, new DeviceAdminPasswordExpiringEvent()); 127 mEvent.mIntent = new SerializableParcelWrapper<>(intent); 128 setDeviceAdminReceiver(deviceAdminReceiver); 129 } 130 131 /** Sets the {@link DeviceAdminReceiver} which received this event. */ setDeviceAdminReceiver( DeviceAdminReceiver deviceAdminReceiver)132 public DeviceAdminPasswordExpiringEventLogger 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 DeviceAdminPasswordExpiringEventLogger 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 DeviceAdminPasswordExpiringEventLogger 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 DeviceAdminPasswordExpiringEventLogger setIntent(Intent intent) { 154 mEvent.mIntent = new SerializableParcelWrapper<>(intent); 155 return this; 156 } 157 158 /** Sets the {@link UserHandle}. */ setUserHandle(UserHandle userHandle)159 public DeviceAdminPasswordExpiringEventLogger setUserHandle(UserHandle userHandle) { 160 mEvent.mUser = new SerializableParcelWrapper<>(userHandle); 161 return this; 162 } 163 } 164 165 protected SerializableParcelWrapper<Intent> mIntent; 166 protected SerializableParcelWrapper<UserHandle> mUser; 167 protected DeviceAdminReceiverInfo mDeviceAdminReceiver; 168 169 /** 170 * The {@link Intent} passed into 171 * {@link DeviceAdminReceiver#onPasswordExpiring(Context, Intent)}. 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#onPasswordExpiring(Context, Intent, UserHandle)}. 183 */ user()184 public UserHandle user() { 185 if (mUser == null) { 186 return null; 187 } 188 return mUser.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 "DeviceAdminPasswordExpiringEvent{" 199 + " intent=" + intent() 200 + ", user=" + user() 201 + ", deviceAdminReceiver=" + mDeviceAdminReceiver 202 + ", packageName='" + mPackageName + "'" 203 + ", timestamp=" + mTimestamp 204 + "}"; 205 } 206 } 207