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.ondevicepersonalization.libraries.plugin;
18 
19 import android.os.Bundle;
20 import android.os.RemoteException;
21 
22 /** A handle for a client to use that allows them to load, unload, and execute the plugin. */
23 public interface PluginController {
24     /**
25      * Loads the plugin. Calls the {@link PluginCallback} to indicate success or failure for loading
26      * the plugin. Throws RemoteException if the callback fails to run.
27      */
load(PluginCallback callback)28     void load(PluginCallback callback) throws RemoteException;
29 
30     /**
31      * Unloads the loaded plugin. Calls the {@link PluginCallback} to indicate success or failure
32      * for unloading the plugin. Throws RemoteException if the callback fails to run.
33      */
unload(PluginCallback callback)34     void unload(PluginCallback callback) throws RemoteException;
35 
36     /**
37      * Runs the plugin with input bundle. Calls the {@link PluginCallback} to indicate success or
38      * failure for running the plugin. Throws RemoteException if the callback fails to run.
39      */
execute(Bundle input, PluginCallback callback)40     void execute(Bundle input, PluginCallback callback) throws RemoteException;
41 
42     /**
43      * Checks and asynchronously returns the current state of the plugin, expressed as a {@link
44      * PluginState}.
45      */
checkPluginState(PluginStateCallback callback)46     void checkPluginState(PluginStateCallback callback);
47 
48     /** Returns the taskName of the Plugin inside the PluginController. */
getName()49     String getName();
50 }
51