xref: /frameworks/base/services/devicepolicy/java/com/android/server/devicepolicy/BaseIDevicePolicyManager.java

/*
 * Copyright (C) 2017 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.server.devicepolicy;

import android.annotation.UserIdInt;
import android.app.admin.IDevicePolicyManager;
import android.content.ComponentName;
import android.os.PersistableBundle;
import android.os.UserHandle;
import android.security.keymaster.KeymasterCertificateChain;
import android.security.keystore.ParcelableKeyGenParameterSpec;
import android.telephony.data.ApnSetting;

import com.android.internal.R;
import com.android.server.SystemService;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;

/**
 * Defines the required interface for IDevicePolicyManager implemenation.
 *
 * <p>The interface consists of public parts determined by {@link IDevicePolicyManager} and also
 * several package private methods required by internal infrastructure.
 *
 * <p>Whenever adding an AIDL method to {@link IDevicePolicyManager}, an empty override method
 * should be added here to avoid build breakage in downstream branches.
 */
abstract class BaseIDevicePolicyManager extends IDevicePolicyManager.Stub {
    /**
     * To be called by {@link DevicePolicyManagerService#Lifecycle} during the various boot phases.
     *
     * @see {@link SystemService#onBootPhase}.
     */
    abstract void systemReady(int phase);
    /**
     * To be called by {@link DevicePolicyManagerService#Lifecycle} when a new user starts.
     *
     * @see {@link SystemService#onStartUser}
     */
    abstract void handleStartUser(int userId);
    /**
     * To be called by {@link DevicePolicyManagerService#Lifecycle} when a user is being unlocked.
     *
     * @see {@link SystemService#onUnlockUser}
     */
    abstract void handleUnlockUser(int userId);
    /**
     * To be called by {@link DevicePolicyManagerService#Lifecycle} when a user is being stopped.
     *
     * @see {@link SystemService#onStopUser}
     */
    abstract void handleStopUser(int userId);

    public void setSystemSetting(ComponentName who, String setting, String value){}

    public void transferOwnership(ComponentName admin, ComponentName target, PersistableBundle bundle) {}

    public PersistableBundle getTransferOwnershipBundle() {
        return null;
    }

    public boolean generateKeyPair(ComponentName who, String callerPackage, String algorithm,
            ParcelableKeyGenParameterSpec keySpec, int idAttestationFlags,
            KeymasterCertificateChain attestationChain) {
        return false;
    }

    @Override
    public boolean setPasswordBlacklist(ComponentName who, String name, List<String> blacklist,
            boolean parent) {
        return false;
    }

    @Override
    public String getPasswordBlacklistName(ComponentName who, @UserIdInt int userId,
            boolean parent) {
        return null;
    }

    @Override
    public boolean isPasswordBlacklisted(@UserIdInt int userId, String password) {
        return false;
    }

    public boolean isUsingUnifiedPassword(ComponentName who) {
        return true;
    }

    public boolean setKeyPairCertificate(ComponentName who, String callerPackage, String alias,
            byte[] cert, byte[] chain, boolean isUserSelectable) {
        return false;
    }

    @Override
    public boolean startUserInBackground(ComponentName who, UserHandle userHandle) {
        return false;
    }

    @Override
    public void setStartUserSessionMessage(
            ComponentName admin, CharSequence startUserSessionMessage) {}

    @Override
    public void setEndUserSessionMessage(ComponentName admin, CharSequence endUserSessionMessage) {}

    @Override
    public String getStartUserSessionMessage(ComponentName admin) {
        return null;
    }

    @Override
    public String getEndUserSessionMessage(ComponentName admin) {
        return null;
    }

    @Override
    public void setPrintingEnabled(ComponentName admin, boolean enabled) {
        throw new UnsupportedOperationException();
    }

    @Override
    public boolean isPrintingEnabled() {
        return true;
    }

    @Override
    public CharSequence getPrintingDisabledReason() {
        return null;
    }

    @Override
    public List<String> setMeteredDataDisabled(ComponentName admin, List<String> packageNames) {
        return packageNames;
    }

    @Override
    public List<String> getMeteredDataDisabled(ComponentName admin) {
        return new ArrayList<>();
    }

    @Override
    public int addOverrideApn(ComponentName admin, ApnSetting apnSetting) {
        return -1;
    }

    @Override
    public boolean updateOverrideApn(ComponentName admin, int apnId, ApnSetting apnSetting) {
        return false;
    }

    @Override
    public boolean removeOverrideApn(ComponentName admin, int apnId) {
        return false;
    }

    @Override
    public List<ApnSetting> getOverrideApns(ComponentName admin) {
        return Collections.emptyList();
    }

    @Override
    public void setOverrideApnsEnabled(ComponentName admin, boolean enabled) {}

    @Override
    public boolean isOverrideApnEnabled(ComponentName admin) {
        return false;
    }
}