| /* |
| * Copyright (C) 2021 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.android.bedstead.harrier.annotations.enterprise; |
| |
| import static android.content.pm.PackageManager.FEATURE_DEVICE_ADMIN; |
| |
| import static com.android.bedstead.harrier.DeviceState.UserType.CURRENT_USER; |
| import static com.android.bedstead.harrier.annotations.AnnotationRunPrecedence.MIDDLE; |
| |
| import com.android.bedstead.harrier.DeviceState; |
| import com.android.bedstead.harrier.annotations.AnnotationRunPrecedence; |
| import com.android.bedstead.harrier.annotations.RequireFeature; |
| |
| import java.lang.annotation.ElementType; |
| import java.lang.annotation.Retention; |
| import java.lang.annotation.RetentionPolicy; |
| import java.lang.annotation.Target; |
| |
| /** |
| * Mark that a test requires that a profile owner is set. |
| * |
| * <p>You can use {@link DeviceState} to ensure that the device enters |
| * the correct state for the method. If using {@link DeviceState}, you can use |
| * {@link DeviceState#profileOwner()} to interact with the profile owner. |
| */ |
| @Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE, ElementType.TYPE}) |
| @Retention(RetentionPolicy.RUNTIME) |
| @RequireFeature(FEATURE_DEVICE_ADMIN) |
| public @interface EnsureHasProfileOwner { |
| /** Which user type the work profile should be attached to. */ |
| DeviceState.UserType onUser() default CURRENT_USER; |
| |
| /** |
| * Whether this DPC should be returned by calls to {@link DeviceState#dpc()}. |
| * |
| * <p>Only one device policy controller per test should be marked as primary. |
| */ |
| boolean isPrimary() default false; |
| |
| /** |
| * Affiliation ids to be set for the profile owner. |
| */ |
| String[] affiliationIds() default {}; |
| |
| /** |
| * Weight sets the order that annotations will be resolved. |
| * |
| * <p>Annotations with a lower weight will be resolved before annotations with a higher weight. |
| * |
| * <p>If there is an order requirement between annotations, ensure that the weight of the |
| * annotation which must be resolved first is lower than the one which must be resolved later. |
| * |
| * <p>Weight can be set to a {@link AnnotationRunPrecedence} constant, or to any {@link int}. |
| */ |
| int weight() default MIDDLE; |
| } |