summaryrefslogtreecommitdiff
path: root/bts/java/com/google/android/setupcompat/bts/AbstractSetupBtsReceiver.java
blob: 9e15e304e170c20883775853ea79307f8ae612d0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
/*
 * Copyright (C) 2022 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.google.android.setupcompat.bts;

import android.content.BroadcastReceiver;
import android.content.Context;
import android.content.Intent;
import android.os.Binder;
import androidx.annotation.NonNull;
import com.google.android.setupcompat.internal.Preconditions;
import com.google.android.setupcompat.util.Logger;
import java.util.concurrent.Executor;

/** Class to receive broadcast intent from SUW, and execute the client's task in the executor. */
public abstract class AbstractSetupBtsReceiver extends BroadcastReceiver {
  private static final Logger LOG = new Logger(AbstractSetupBtsReceiver.class);

  @Override
  public void onReceive(Context context, Intent intent) {
    if (intent != null && getIntentAction().equals(intent.getAction())) {
      Executor executor = getExecutor();
      String simpleClassName = this.getClass().getSimpleName();
      if (executor != null) {
        executor.execute(
            () -> {
              Preconditions.ensureNotOnMainThread(simpleClassName + "::onStartTask");
              onStartTask();
            });
      }
    } else {
      LOG.w(
          "["
              + this.getClass().getSimpleName()
              + "] Unauthorized binder uid="
              + Binder.getCallingUid()
              + ", intentAction="
              + (intent == null ? "(null)" : intent.getAction()));
    }
  }

  /**
   * Gets the intent action that expected to execute the task. Use to avoid the receiver launch
   * unexpectedly.
   */
  @NonNull
  protected abstract String getIntentAction();

  /** Returns the executor used to execute the task. */
  @NonNull
  protected abstract Executor getExecutor();

  /** Tasks can be done before activity launched, in order to remove the loading before activity. */
  protected abstract void onStartTask();
}