1 /* 2 * Copyright (C) 2006 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 android.content.pm; 18 19 import android.os.Parcel; 20 import android.os.Parcelable; 21 import android.os.PatternMatcher; 22 import android.util.Printer; 23 24 /** 25 * Holds information about a specific 26 * {@link android.content.ContentProvider content provider}. This is returned by 27 * {@link android.content.pm.PackageManager#resolveContentProvider(java.lang.String, int) 28 * PackageManager.resolveContentProvider()}. 29 */ 30 public final class ProviderInfo extends ComponentInfo 31 implements Parcelable { 32 33 /** The name provider is published under content:// */ 34 public String authority = null; 35 36 /** Optional permission required for read-only access this content 37 * provider. */ 38 public String readPermission = null; 39 40 /** Optional permission required for read/write access this content 41 * provider. */ 42 public String writePermission = null; 43 44 /** If true, additional permissions to specific Uris in this content 45 * provider can be granted, as per the 46 * {@link android.R.styleable#AndroidManifestProvider_grantUriPermissions 47 * grantUriPermissions} attribute. 48 */ 49 public boolean grantUriPermissions = false; 50 51 /** 52 * If non-null, these are the patterns that are allowed for granting URI 53 * permissions. Any URI that does not match one of these patterns will not 54 * allowed to be granted. If null, all URIs are allowed. The 55 * {@link PackageManager#GET_URI_PERMISSION_PATTERNS 56 * PackageManager.GET_URI_PERMISSION_PATTERNS} flag must be specified for 57 * this field to be filled in. 58 */ 59 public PatternMatcher[] uriPermissionPatterns = null; 60 61 /** 62 * If non-null, these are path-specific permissions that are allowed for 63 * accessing the provider. Any permissions listed here will allow a 64 * holding client to access the provider, and the provider will check 65 * the URI it provides when making calls against the patterns here. 66 */ 67 public PathPermission[] pathPermissions = null; 68 69 /** If true, this content provider allows multiple instances of itself 70 * to run in different process. If false, a single instances is always 71 * run in {@link #processName}. */ 72 public boolean multiprocess = false; 73 74 /** Used to control initialization order of single-process providers 75 * running in the same process. Higher goes first. */ 76 public int initOrder = 0; 77 78 /** 79 * Bit in {@link #flags} indicating if the provider is visible to ephemeral applications. 80 * @hide 81 */ 82 public static final int FLAG_VISIBLE_TO_INSTANT_APP = 0x100000; 83 84 /** 85 * Bit in {@link #flags}: If set, a single instance of the provider will 86 * run for all users on the device. Set from the 87 * {@link android.R.attr#singleUser} attribute. 88 */ 89 public static final int FLAG_SINGLE_USER = 0x40000000; 90 91 /** 92 * Options that have been set in the provider declaration in the 93 * manifest. 94 * These include: {@link #FLAG_SINGLE_USER}. 95 */ 96 public int flags = 0; 97 98 /** 99 * Whether or not this provider is syncable. 100 * @deprecated This flag is now being ignored. The current way to make a provider 101 * syncable is to provide a SyncAdapter service for a given provider/account type. 102 */ 103 @Deprecated 104 public boolean isSyncable = false; 105 ProviderInfo()106 public ProviderInfo() { 107 } 108 ProviderInfo(ProviderInfo orig)109 public ProviderInfo(ProviderInfo orig) { 110 super(orig); 111 authority = orig.authority; 112 readPermission = orig.readPermission; 113 writePermission = orig.writePermission; 114 grantUriPermissions = orig.grantUriPermissions; 115 uriPermissionPatterns = orig.uriPermissionPatterns; 116 pathPermissions = orig.pathPermissions; 117 multiprocess = orig.multiprocess; 118 initOrder = orig.initOrder; 119 flags = orig.flags; 120 isSyncable = orig.isSyncable; 121 } 122 dump(Printer pw, String prefix)123 public void dump(Printer pw, String prefix) { 124 dump(pw, prefix, DUMP_FLAG_ALL); 125 } 126 127 /** @hide */ dump(Printer pw, String prefix, int dumpFlags)128 public void dump(Printer pw, String prefix, int dumpFlags) { 129 super.dumpFront(pw, prefix); 130 pw.println(prefix + "authority=" + authority); 131 pw.println(prefix + "flags=0x" + Integer.toHexString(flags)); 132 super.dumpBack(pw, prefix, dumpFlags); 133 } 134 describeContents()135 public int describeContents() { 136 return 0; 137 } 138 writeToParcel(Parcel out, int parcelableFlags)139 @Override public void writeToParcel(Parcel out, int parcelableFlags) { 140 super.writeToParcel(out, parcelableFlags); 141 out.writeString(authority); 142 out.writeString(readPermission); 143 out.writeString(writePermission); 144 out.writeInt(grantUriPermissions ? 1 : 0); 145 out.writeTypedArray(uriPermissionPatterns, parcelableFlags); 146 out.writeTypedArray(pathPermissions, parcelableFlags); 147 out.writeInt(multiprocess ? 1 : 0); 148 out.writeInt(initOrder); 149 out.writeInt(flags); 150 out.writeInt(isSyncable ? 1 : 0); 151 } 152 153 public static final Parcelable.Creator<ProviderInfo> CREATOR 154 = new Parcelable.Creator<ProviderInfo>() { 155 public ProviderInfo createFromParcel(Parcel in) { 156 return new ProviderInfo(in); 157 } 158 159 public ProviderInfo[] newArray(int size) { 160 return new ProviderInfo[size]; 161 } 162 }; 163 toString()164 public String toString() { 165 return "ContentProviderInfo{name=" + authority + " className=" + name + "}"; 166 } 167 ProviderInfo(Parcel in)168 private ProviderInfo(Parcel in) { 169 super(in); 170 authority = in.readString(); 171 readPermission = in.readString(); 172 writePermission = in.readString(); 173 grantUriPermissions = in.readInt() != 0; 174 uriPermissionPatterns = in.createTypedArray(PatternMatcher.CREATOR); 175 pathPermissions = in.createTypedArray(PathPermission.CREATOR); 176 multiprocess = in.readInt() != 0; 177 initOrder = in.readInt(); 178 flags = in.readInt(); 179 isSyncable = in.readInt() != 0; 180 } 181 } 182