1/*
2 * Copyright (C) 2007 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
17package android.content.pm;
18
19import android.os.Parcel;
20import android.os.Parcelable;
21import android.util.Printer;
22
23/**
24 * Information you can retrieve about a particular application
25 * service. This corresponds to information collected from the
26 * AndroidManifest.xml's <service> tags.
27 */
28public class ServiceInfo extends ComponentInfo
29        implements Parcelable {
30    /**
31     * Optional name of a permission required to be able to access this
32     * Service.  From the "permission" attribute.
33     */
34    public String permission;
35
36    /**
37     * Bit in {@link #flags}: If set, the service will automatically be
38     * stopped by the system if the user removes a task that is rooted
39     * in one of the application's activities.  Set from the
40     * {@link android.R.attr#stopWithTask} attribute.
41     */
42    public static final int FLAG_STOP_WITH_TASK = 0x0001;
43
44    /**
45     * Bit in {@link #flags}: If set, the service will run in its own
46     * isolated process.  Set from the
47     * {@link android.R.attr#isolatedProcess} attribute.
48     */
49    public static final int FLAG_ISOLATED_PROCESS = 0x0002;
50
51    /**
52     * Bit in {@link #flags}: If set, the service can be bound and run in the
53     * calling application's package, rather than the package in which it is
54     * declared.  Set from {@link android.R.attr#externalService} attribute.
55     */
56    public static final int FLAG_EXTERNAL_SERVICE = 0x0004;
57
58    /**
59     * Bit in {@link #flags} indicating if the service is visible to ephemeral applications.
60     * @hide
61     */
62    public static final int FLAG_VISIBLE_TO_INSTANT_APP = 0x100000;
63
64    /**
65     * Bit in {@link #flags}: If set, a single instance of the service will
66     * run for all users on the device.  Set from the
67     * {@link android.R.attr#singleUser} attribute.
68     */
69    public static final int FLAG_SINGLE_USER = 0x40000000;
70
71    /**
72     * Options that have been set in the service declaration in the
73     * manifest.
74     * These include:
75     * {@link #FLAG_STOP_WITH_TASK}, {@link #FLAG_ISOLATED_PROCESS},
76     * {@link #FLAG_SINGLE_USER}.
77     */
78    public int flags;
79
80    public ServiceInfo() {
81    }
82
83    public ServiceInfo(ServiceInfo orig) {
84        super(orig);
85        permission = orig.permission;
86        flags = orig.flags;
87    }
88
89    public void dump(Printer pw, String prefix) {
90        dump(pw, prefix, DUMP_FLAG_ALL);
91    }
92
93    /** @hide */
94    void dump(Printer pw, String prefix, int flags) {
95        super.dumpFront(pw, prefix);
96        pw.println(prefix + "permission=" + permission);
97        pw.println(prefix + "flags=0x" + Integer.toHexString(flags));
98        super.dumpBack(pw, prefix, flags);
99    }
100
101    public String toString() {
102        return "ServiceInfo{"
103            + Integer.toHexString(System.identityHashCode(this))
104            + " " + name + "}";
105    }
106
107    public int describeContents() {
108        return 0;
109    }
110
111    public void writeToParcel(Parcel dest, int parcelableFlags) {
112        super.writeToParcel(dest, parcelableFlags);
113        dest.writeString(permission);
114        dest.writeInt(flags);
115    }
116
117    public static final Creator<ServiceInfo> CREATOR =
118        new Creator<ServiceInfo>() {
119        public ServiceInfo createFromParcel(Parcel source) {
120            return new ServiceInfo(source);
121        }
122        public ServiceInfo[] newArray(int size) {
123            return new ServiceInfo[size];
124        }
125    };
126
127    private ServiceInfo(Parcel source) {
128        super(source);
129        permission = source.readString();
130        flags = source.readInt();
131    }
132}
133