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}: If set, a single instance of the provider will
80      * run for all users on the device.  Set from the
81      * {@link android.R.attr#singleUser} attribute.
82      */
83     public static final int FLAG_SINGLE_USER = 0x40000000;
84 
85     /**
86      * Options that have been set in the provider declaration in the
87      * manifest.
88      * These include: {@link #FLAG_SINGLE_USER}.
89      */
90     public int flags = 0;
91 
92     /**
93      * Whether or not this provider is syncable.
94      * @deprecated This flag is now being ignored. The current way to make a provider
95      * syncable is to provide a SyncAdapter service for a given provider/account type.
96      */
97     @Deprecated
98     public boolean isSyncable = false;
99 
ProviderInfo()100     public ProviderInfo() {
101     }
102 
ProviderInfo(ProviderInfo orig)103     public ProviderInfo(ProviderInfo orig) {
104         super(orig);
105         authority = orig.authority;
106         readPermission = orig.readPermission;
107         writePermission = orig.writePermission;
108         grantUriPermissions = orig.grantUriPermissions;
109         uriPermissionPatterns = orig.uriPermissionPatterns;
110         pathPermissions = orig.pathPermissions;
111         multiprocess = orig.multiprocess;
112         initOrder = orig.initOrder;
113         flags = orig.flags;
114         isSyncable = orig.isSyncable;
115     }
116 
dump(Printer pw, String prefix)117     public void dump(Printer pw, String prefix) {
118         super.dumpFront(pw, prefix);
119         pw.println(prefix + "authority=" + authority);
120         pw.println(prefix + "flags=0x" + Integer.toHexString(flags));
121     }
122 
describeContents()123     public int describeContents() {
124         return 0;
125     }
126 
writeToParcel(Parcel out, int parcelableFlags)127     @Override public void writeToParcel(Parcel out, int parcelableFlags) {
128         super.writeToParcel(out, parcelableFlags);
129         out.writeString(authority);
130         out.writeString(readPermission);
131         out.writeString(writePermission);
132         out.writeInt(grantUriPermissions ? 1 : 0);
133         out.writeTypedArray(uriPermissionPatterns, parcelableFlags);
134         out.writeTypedArray(pathPermissions, parcelableFlags);
135         out.writeInt(multiprocess ? 1 : 0);
136         out.writeInt(initOrder);
137         out.writeInt(flags);
138         out.writeInt(isSyncable ? 1 : 0);
139     }
140 
141     public static final Parcelable.Creator<ProviderInfo> CREATOR
142             = new Parcelable.Creator<ProviderInfo>() {
143         public ProviderInfo createFromParcel(Parcel in) {
144             return new ProviderInfo(in);
145         }
146 
147         public ProviderInfo[] newArray(int size) {
148             return new ProviderInfo[size];
149         }
150     };
151 
toString()152     public String toString() {
153         return "ContentProviderInfo{name=" + authority + " className=" + name + "}";
154     }
155 
ProviderInfo(Parcel in)156     private ProviderInfo(Parcel in) {
157         super(in);
158         authority = in.readString();
159         readPermission = in.readString();
160         writePermission = in.readString();
161         grantUriPermissions = in.readInt() != 0;
162         uriPermissionPatterns = in.createTypedArray(PatternMatcher.CREATOR);
163         pathPermissions = in.createTypedArray(PathPermission.CREATOR);
164         multiprocess = in.readInt() != 0;
165         initOrder = in.readInt();
166         flags = in.readInt();
167         isSyncable = in.readInt() != 0;
168     }
169 }
170