• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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.devicelockcontroller.policy;
18 
19 import androidx.annotation.IntDef;
20 
21 import com.android.devicelockcontroller.policy.DeviceStateController.DeviceState;
22 
23 import com.google.common.util.concurrent.ListenableFuture;
24 
25 import java.lang.annotation.ElementType;
26 import java.lang.annotation.Retention;
27 import java.lang.annotation.RetentionPolicy;
28 import java.lang.annotation.Target;
29 
30 /**
31  * Interface used for setting policies for a given state.
32  */
33 public interface PolicyHandler {
34     /** Result Type for operation */
35     @Target(ElementType.TYPE_USE)
36     @IntDef(value = {SUCCESS, FAILURE})
37     @Retention(RetentionPolicy.SOURCE)
38     @interface ResultType {
39     }
40 
41     int SUCCESS = 0;
42     int FAILURE = 1;
43 
44     /**
45      * Sets the policy state based on the new state. Throws SecurityException when the app is not
46      * privileged.
47      */
48     @ResultType
setPolicyForState(@eviceState int state)49     ListenableFuture<@ResultType Integer> setPolicyForState(@DeviceState int state);
50 }
51