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.IntegerQueryHelper; 32 import com.android.queryable.queries.IntentQueryHelper; 33 import com.android.queryable.queries.LongQueryHelper; 34 import com.android.queryable.util.SerializableParcelWrapper; 35 36 /** 37 * Event logged when {@link DeviceAdminReceiver#onNetworkLogsAvailable(Context, Intent, long, int)} 38 * is called. 39 */ 40 public final class DeviceAdminNetworkLogsAvailableEvent extends Event { 41 42 private static final long serialVersionUID = 1; 43 44 /** Begins a query for {@link DeviceAdminNetworkLogsAvailableEvent} events. */ queryPackage(String packageName)45 public static DeviceAdminNetworkLogsAvailableEventQuery queryPackage(String packageName) { 46 return new DeviceAdminNetworkLogsAvailableEventQuery(packageName); 47 } 48 49 /** {@link EventLogsQuery} for {@link DeviceAdminNetworkLogsAvailableEvent}. */ 50 public static final class DeviceAdminNetworkLogsAvailableEventQuery 51 extends EventLogsQuery<DeviceAdminNetworkLogsAvailableEvent, 52 DeviceAdminNetworkLogsAvailableEventQuery> { 53 54 private static final long serialVersionUID = 1; 55 56 DeviceAdminReceiverQueryHelper<DeviceAdminNetworkLogsAvailableEventQuery> mDeviceAdminReceiver = 57 new DeviceAdminReceiverQueryHelper<>(this); 58 IntentQueryHelper<DeviceAdminNetworkLogsAvailableEventQuery> mIntent = 59 new IntentQueryHelper<>(this); 60 LongQueryHelper<DeviceAdminNetworkLogsAvailableEventQuery> mBatchToken = 61 new LongQueryHelper<>(this); 62 IntegerQueryHelper<DeviceAdminNetworkLogsAvailableEventQuery> mNetworkLogsCount = 63 new IntegerQueryHelper<>(this); 64 DeviceAdminNetworkLogsAvailableEventQuery(String packageName)65 private DeviceAdminNetworkLogsAvailableEventQuery(String packageName) { 66 super(DeviceAdminNetworkLogsAvailableEvent.class, packageName); 67 } 68 69 /** 70 * Queries {@link Intent} passed into 71 * {@link DeviceAdminReceiver#onNetworkLogsAvailable(Context, Intent, long, int)}. 72 */ 73 @CheckResult whereIntent()74 public IntentQueryHelper<DeviceAdminNetworkLogsAvailableEventQuery> whereIntent() { 75 return mIntent; 76 } 77 78 /** Queries {@link DeviceAdminReceiver}. */ 79 @CheckResult whereDeviceAdminReceiver()80 public DeviceAdminReceiverQuery<DeviceAdminNetworkLogsAvailableEventQuery> whereDeviceAdminReceiver() { 81 return mDeviceAdminReceiver; 82 } 83 84 /** 85 * Query {@code batchToken} passed into 86 * {@link DeviceAdminReceiver#onNetworkLogsAvailable(Context, Intent, long, int)}. 87 */ 88 @CheckResult whereBatchToken()89 public LongQueryHelper<DeviceAdminNetworkLogsAvailableEventQuery> whereBatchToken() { 90 return mBatchToken; 91 } 92 93 /** 94 * Query {@code networkLogsCount} passed into 95 * {@link DeviceAdminReceiver#onNetworkLogsAvailable(Context, Intent, long, int)}. 96 */ 97 @CheckResult whereNetworkLogsCount()98 public IntegerQueryHelper<DeviceAdminNetworkLogsAvailableEventQuery> whereNetworkLogsCount() { 99 return mNetworkLogsCount; 100 } 101 102 @Override filter(DeviceAdminNetworkLogsAvailableEvent event)103 protected boolean filter(DeviceAdminNetworkLogsAvailableEvent event) { 104 if (!mIntent.matches(event.mIntent)) { 105 return false; 106 } 107 if (!mDeviceAdminReceiver.matches(event.mDeviceAdminReceiver)) { 108 return false; 109 } 110 if (!mBatchToken.matches(event.mBatchToken)) { 111 return false; 112 } 113 if (!mNetworkLogsCount.matches(event.mNetworkLogsCount)) { 114 return false; 115 } 116 return true; 117 } 118 119 @Override describeQuery(String fieldName)120 public String describeQuery(String fieldName) { 121 return toStringBuilder(DeviceAdminNetworkLogsAvailableEvent.class, this) 122 .field("intent", mIntent) 123 .field("deviceAdminReceiver", mDeviceAdminReceiver) 124 .field("batchToken", mBatchToken) 125 .field("networkLogsCount", mNetworkLogsCount) 126 .toString(); 127 } 128 } 129 130 /** Begins logging a {@link DeviceAdminNetworkLogsAvailableEvent}. */ logger( DeviceAdminReceiver deviceAdminReceiver, Context context, Intent intent, long batchToken, int networkLogsCount)131 public static DeviceAdminNetworkLogsAvailableEventLogger logger( 132 DeviceAdminReceiver deviceAdminReceiver, Context context, Intent intent, 133 long batchToken, int networkLogsCount) { 134 return new DeviceAdminNetworkLogsAvailableEventLogger( 135 deviceAdminReceiver, context, intent, batchToken, networkLogsCount); 136 } 137 138 /** {@link EventLogger} for {@link DeviceAdminNetworkLogsAvailableEvent}. */ 139 public static final class DeviceAdminNetworkLogsAvailableEventLogger 140 extends EventLogger<DeviceAdminNetworkLogsAvailableEvent> { DeviceAdminNetworkLogsAvailableEventLogger( DeviceAdminReceiver deviceAdminReceiver, Context context, Intent intent, long batchToken, int networkLogsCount)141 private DeviceAdminNetworkLogsAvailableEventLogger( 142 DeviceAdminReceiver deviceAdminReceiver, Context context, Intent intent, 143 long batchToken, int networkLogsCount) { 144 super(context, new DeviceAdminNetworkLogsAvailableEvent()); 145 mEvent.mIntent = new SerializableParcelWrapper<>(intent); 146 mEvent.mBatchToken = batchToken; 147 mEvent.mNetworkLogsCount = networkLogsCount; 148 setDeviceAdminReceiver(deviceAdminReceiver); 149 } 150 151 /** Sets the {@link DeviceAdminReceiver} which received this event. */ setDeviceAdminReceiver( DeviceAdminReceiver deviceAdminReceiver)152 public DeviceAdminNetworkLogsAvailableEventLogger setDeviceAdminReceiver( 153 DeviceAdminReceiver deviceAdminReceiver) { 154 mEvent.mDeviceAdminReceiver = new DeviceAdminReceiverInfo(deviceAdminReceiver); 155 return this; 156 } 157 158 /** Sets the {@link DeviceAdminReceiver} which received this event. */ setDeviceAdminReceiver( Class<? extends DeviceAdminReceiver> deviceAdminReceiverClass)159 public DeviceAdminNetworkLogsAvailableEventLogger setDeviceAdminReceiver( 160 Class<? extends DeviceAdminReceiver> deviceAdminReceiverClass) { 161 mEvent.mDeviceAdminReceiver = new DeviceAdminReceiverInfo(deviceAdminReceiverClass); 162 return this; 163 } 164 165 /** Sets the {@link DeviceAdminReceiver} which received this event. */ setDeviceAdminReceiver( String deviceAdminReceiverClassName)166 public DeviceAdminNetworkLogsAvailableEventLogger setDeviceAdminReceiver( 167 String deviceAdminReceiverClassName) { 168 mEvent.mDeviceAdminReceiver = new DeviceAdminReceiverInfo(deviceAdminReceiverClassName); 169 return this; 170 } 171 172 /** Sets the {@link Intent} which was received. */ setIntent(Intent intent)173 public DeviceAdminNetworkLogsAvailableEventLogger setIntent(Intent intent) { 174 mEvent.mIntent = new SerializableParcelWrapper<>(intent); 175 return this; 176 } 177 178 /** Sets the {@code batchToken} which was received. */ setBatchToken(long batchToken)179 public DeviceAdminNetworkLogsAvailableEventLogger setBatchToken(long batchToken) { 180 mEvent.mBatchToken = batchToken; 181 return this; 182 } 183 184 /** Sets the {@code networkLogsCount} which was received. */ setNetworkLogsCount(int networkLogsCount)185 public DeviceAdminNetworkLogsAvailableEventLogger setNetworkLogsCount(int networkLogsCount) { 186 mEvent.mNetworkLogsCount = networkLogsCount; 187 return this; 188 } 189 } 190 191 protected SerializableParcelWrapper<Intent> mIntent; 192 protected DeviceAdminReceiverInfo mDeviceAdminReceiver; 193 protected long mBatchToken; 194 protected int mNetworkLogsCount; 195 196 /** 197 * The {@link Intent} passed into 198 * {@link DeviceAdminReceiver#onNetworkLogsAvailable(Context, Intent, long, int)}. 199 */ intent()200 public Intent intent() { 201 if (mIntent == null) { 202 return null; 203 } 204 return mIntent.get(); 205 } 206 207 /** Information about the {@link DeviceAdminReceiver} which received the intent. */ deviceAdminReceiver()208 public DeviceAdminReceiverInfo deviceAdminReceiver() { 209 return mDeviceAdminReceiver; 210 } 211 212 /** 213 * The {@code batchToken} passed into 214 * {@link DeviceAdminReceiver#onNetworkLogsAvailable(Context, Intent, long, int)}. 215 */ batchToken()216 public long batchToken() { 217 return mBatchToken; 218 } 219 220 /** 221 * The {@code networkLogsCount} passed into 222 * {@link DeviceAdminReceiver#onNetworkLogsAvailable(Context, Intent, long, int)}. 223 */ networkLogsCount()224 public int networkLogsCount() { 225 return mNetworkLogsCount; 226 } 227 228 @Override toString()229 public String toString() { 230 return "DeviceAdminNetworkLogsAvailableEvent{" 231 + " intent=" + intent() 232 + ", batchToken=" + mBatchToken 233 + ", networkLogsCount=" + mNetworkLogsCount 234 + ", deviceAdminReceiver=" + mDeviceAdminReceiver 235 + ", packageName='" + mPackageName + "'" 236 + ", timestamp=" + mTimestamp 237 + "}"; 238 } 239 } 240