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.bedstead.accounts.annotations;
18 
19 import static com.android.bedstead.accounts.annotations.EnsureHasNoAccounts.ENSURE_HAS_NO_ACCOUNTS_PRIORITY;
20 import static com.android.bedstead.harrier.UserType.INSTRUMENTED_USER;
21 import static com.android.bedstead.nene.userrestrictions.CommonUserRestrictions.DISALLOW_MODIFY_ACCOUNTS;
22 
23 import com.android.bedstead.enterprise.annotations.EnsureDoesNotHaveUserRestriction;
24 import com.android.bedstead.harrier.UserType;
25 import com.android.bedstead.harrier.annotations.AnnotationPriorityRunPrecedence;
26 import com.android.bedstead.harrier.annotations.UsesAnnotationExecutor;
27 
28 import java.lang.annotation.ElementType;
29 import java.lang.annotation.Retention;
30 import java.lang.annotation.RetentionPolicy;
31 import java.lang.annotation.Target;
32 
33 /**
34  * Ensure that an account exists.
35  */
36 @Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE, ElementType.TYPE})
37 @Retention(RetentionPolicy.RUNTIME)
38 @EnsureDoesNotHaveUserRestriction(DISALLOW_MODIFY_ACCOUNTS)
39 @UsesAnnotationExecutor(UsesAnnotationExecutor.ACCOUNTS)
40 // TODO(263353411): Make this take a query argument the same as remotedpc - instead of individual parameters
41 public @interface EnsureHasAccount {
42 
43     String DEFAULT_ACCOUNT_KEY = "account";
44 
45     /** Key used to refer to the account. */
key()46     String key() default DEFAULT_ACCOUNT_KEY;
47 
48     /** Which user type the account must be added on. */
onUser()49     UserType onUser() default INSTRUMENTED_USER;
50 
51     /**
52      * Features which the account must have.
53      *
54      * <p>Lack of a feature here indicates the account should not have this feature
55      */
features()56     String[] features() default {};
57 
58      /**
59      * Priority sets the order that annotations will be resolved.
60      *
61      * <p>Annotations with a lower priority will be resolved before annotations with a higher
62      * priority.
63      *
64      * <p>If there is an order requirement between annotations, ensure that the priority of the
65      * annotation which must be resolved first is lower than the one which must be resolved later.
66      *
67      * <p>Priority can be set to a {@link AnnotationPriorityRunPrecedence} constant, or to any {@link int}.
68      */
priority()69     int priority() default ENSURE_HAS_NO_ACCOUNTS_PRIORITY + 1;
70 }
71