1 /* 2 * Copyright (C) 2022 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.server.biometrics.sensors; 18 19 import android.annotation.NonNull; 20 21 /** 22 * Interface that ClientMonitor holders should use to receive callbacks. 23 */ 24 public interface ClientMonitorCallback { 25 /** 26 * Invoked when the ClientMonitor operation has been started (e.g. reached the head of 27 * the queue and becomes the current operation). 28 * 29 * @param clientMonitor Reference of the ClientMonitor that is starting. 30 */ onClientStarted(@onNull BaseClientMonitor clientMonitor)31 default void onClientStarted(@NonNull BaseClientMonitor clientMonitor) {} 32 33 /** 34 * Invoked when a biometric action has occurred. 35 */ onBiometricAction(int action)36 default void onBiometricAction(int action) {} 37 38 /** 39 * Invoked when the ClientMonitor operation is complete. This abstracts away asynchronous 40 * (i.e. Authenticate, Enroll, Enumerate, Remove) and synchronous (i.e. generateChallenge, 41 * revokeChallenge) so that a scheduler can process ClientMonitors regardless of their 42 * implementation. 43 * 44 * @param clientMonitor Reference of the ClientMonitor that finished. 45 * @param success True if the operation completed successfully. 46 */ onClientFinished(@onNull BaseClientMonitor clientMonitor, boolean success)47 default void onClientFinished(@NonNull BaseClientMonitor clientMonitor, boolean success) {} 48 } 49