| /* |
| * Copyright (C) 2018 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 android.view.contentcapture; |
| |
| import android.annotation.NonNull; |
| import android.app.ActivityThread; |
| import android.content.LocusId; |
| import android.os.Parcel; |
| import android.os.Parcelable; |
| import android.util.IntArray; |
| |
| import com.android.internal.util.Preconditions; |
| |
| import java.util.ArrayList; |
| import java.util.List; |
| |
| /** |
| * Class used by apps to request the Content Capture service to remove user-data associated with |
| * some context. |
| */ |
| public final class UserDataRemovalRequest implements Parcelable { |
| |
| private final String mPackageName; |
| |
| private final boolean mForEverything; |
| private ArrayList<LocusIdRequest> mLocusIdRequests; |
| |
| private UserDataRemovalRequest(@NonNull Builder builder) { |
| mPackageName = ActivityThread.currentActivityThread().getApplication().getPackageName(); |
| mForEverything = builder.mForEverything; |
| if (builder.mLocusIds != null) { |
| final int size = builder.mLocusIds.size(); |
| mLocusIdRequests = new ArrayList<>(size); |
| for (int i = 0; i < size; i++) { |
| mLocusIdRequests.add(new LocusIdRequest(builder.mLocusIds.get(i), |
| builder.mRecursive.get(i) == 1)); |
| } |
| } |
| } |
| |
| private UserDataRemovalRequest(@NonNull Parcel parcel) { |
| mPackageName = parcel.readString(); |
| mForEverything = parcel.readBoolean(); |
| if (!mForEverything) { |
| final int size = parcel.readInt(); |
| mLocusIdRequests = new ArrayList<>(size); |
| for (int i = 0; i < size; i++) { |
| mLocusIdRequests.add(new LocusIdRequest((LocusId) parcel.readValue(null), |
| parcel.readBoolean())); |
| } |
| } |
| } |
| |
| /** |
| * Gets the name of the app that's making the request. |
| */ |
| @NonNull |
| public String getPackageName() { |
| return mPackageName; |
| } |
| |
| /** |
| * Checks if app is requesting to remove all user data associated with its package. |
| */ |
| public boolean isForEverything() { |
| return mForEverything; |
| } |
| |
| /** |
| * Gets the list of {@code LousId}s the apps is requesting to remove. |
| */ |
| @NonNull |
| public List<LocusIdRequest> getLocusIdRequests() { |
| return mLocusIdRequests; |
| } |
| |
| /** |
| * Builder for {@link UserDataRemovalRequest} objects. |
| */ |
| public static final class Builder { |
| |
| private boolean mForEverything; |
| private ArrayList<LocusId> mLocusIds; |
| private IntArray mRecursive; |
| |
| private boolean mDestroyed; |
| |
| /** |
| * Requests servive to remove all user data associated with the app's package. |
| * |
| * @return this builder |
| */ |
| @NonNull |
| public Builder forEverything() { |
| throwIfDestroyed(); |
| Preconditions.checkState(mLocusIds == null, "Already added LocusIds"); |
| |
| mForEverything = true; |
| return this; |
| } |
| |
| /** |
| * Request service to remove data associated with a given {@link LocusId}. |
| * |
| * @param locusId the {@link LocusId} being requested to be removed. |
| * @param recursive whether it should remove the data associated with just the |
| * {@code LocusId} or its tree of descendants. |
| * |
| * @return this builder |
| */ |
| public Builder addLocusId(@NonNull LocusId locusId, boolean recursive) { |
| throwIfDestroyed(); |
| Preconditions.checkState(!mForEverything, "Already is for everything"); |
| Preconditions.checkNotNull(locusId); |
| |
| if (mLocusIds == null) { |
| mLocusIds = new ArrayList<>(); |
| mRecursive = new IntArray(); |
| } |
| |
| mLocusIds.add(locusId); |
| mRecursive.add(recursive ? 1 : 0); |
| return this; |
| } |
| |
| /** |
| * Builds the {@link UserDataRemovalRequest}. |
| */ |
| @NonNull |
| public UserDataRemovalRequest build() { |
| throwIfDestroyed(); |
| |
| Preconditions.checkState(mForEverything || mLocusIds != null); |
| |
| mDestroyed = true; |
| return new UserDataRemovalRequest(this); |
| } |
| |
| private void throwIfDestroyed() { |
| Preconditions.checkState(!mDestroyed, "Already destroyed!"); |
| } |
| } |
| |
| @Override |
| public int describeContents() { |
| return 0; |
| } |
| |
| @Override |
| public void writeToParcel(Parcel parcel, int flags) { |
| parcel.writeString(mPackageName); |
| parcel.writeBoolean(mForEverything); |
| if (!mForEverything) { |
| final int size = mLocusIdRequests.size(); |
| parcel.writeInt(size); |
| for (int i = 0; i < size; i++) { |
| final LocusIdRequest request = mLocusIdRequests.get(i); |
| parcel.writeValue(request.getLocusId()); |
| parcel.writeBoolean(request.isRecursive()); |
| } |
| } |
| } |
| |
| public static final Parcelable.Creator<UserDataRemovalRequest> CREATOR = |
| new Parcelable.Creator<UserDataRemovalRequest>() { |
| |
| @Override |
| public UserDataRemovalRequest createFromParcel(Parcel parcel) { |
| return new UserDataRemovalRequest(parcel); |
| } |
| |
| @Override |
| public UserDataRemovalRequest[] newArray(int size) { |
| return new UserDataRemovalRequest[size]; |
| } |
| }; |
| |
| /** |
| * Representation of a request to remove data associated with a {@link LocusId}. |
| */ |
| public final class LocusIdRequest { |
| private final @NonNull LocusId mLocusId; |
| private final boolean mRecursive; |
| |
| private LocusIdRequest(@NonNull LocusId locusId, boolean recursive) { |
| this.mLocusId = locusId; |
| this.mRecursive = recursive; |
| } |
| |
| /** |
| * Gets the {@code LocusId} per se. |
| */ |
| @NonNull |
| public LocusId getLocusId() { |
| return mLocusId; |
| } |
| |
| /** |
| * Checks whether the request is to remove just the data associated with the {@link LocusId} |
| * per se, or also its descendants. |
| */ |
| @NonNull |
| public boolean isRecursive() { |
| return mRecursive; |
| } |
| } |
| } |