summaryrefslogtreecommitdiff
path: root/telephony/java/android/telephony/CellBroadcastService.java
blob: cb342c6df9ae010f922213cc0a07a7c6974e40e4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
/*
 * Copyright (C) 2019 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.telephony;

import android.annotation.CallSuper;
import android.annotation.NonNull;
import android.annotation.Nullable;
import android.annotation.SystemApi;
import android.app.Service;
import android.content.Intent;
import android.os.IBinder;
import android.telephony.cdma.CdmaSmsCbProgramData;

/**
 * A service which exposes the cell broadcast handling module to the system.
 * <p>
 * To extend this class, you must declare the service in your manifest file to require the
 * {@link android.Manifest.permission#BIND_CELL_BROADCAST_SERVICE} permission and include an intent
 * filter with the {@link #CELL_BROADCAST_SERVICE_INTERFACE}.
 * Implementations of this service should run in the phone process and with its UID.
 * <p>
 * For example:
 * <pre>{@code
 * <manifest xmlns:android="http://schemas.android.com/apk/res/android"
 *       android:sharedUserId="android.uid.phone">
 *   <service android:name=".MyCellBroadcastService"
 *         android:label="@string/service_name"
 *         android:process="com.android.phone"
 *         android:exported="true"
 *         android:permission="android.permission.BIND_CELL_BROADCAST_SERVICE">
 *     <intent-filter>
 *           <action android:name="android.telephony.CellBroadcastService" />
 *     </intent-filter>
 *   </service>
 * </manifest>
 * }</pre>
 * @hide
 */
@SystemApi
public abstract class CellBroadcastService extends Service {

    public static final String CELL_BROADCAST_SERVICE_INTERFACE =
            "android.telephony.CellBroadcastService";

    private final ICellBroadcastService.Stub mStubWrapper;

    public CellBroadcastService() {
        mStubWrapper = new ICellBroadcastServiceWrapper();
    }

    /**
     * Handle a GSM cell broadcast SMS message forwarded from the system.
     * @param slotIndex the index of the slot which received the message
     * @param message the SMS PDU
     */
    public abstract void onGsmCellBroadcastSms(int slotIndex, @NonNull byte[] message);

    /**
     * Handle a CDMA cell broadcast SMS message forwarded from the system.
     * @param slotIndex the index of the slot which received the message
     * @param bearerData the CDMA SMS bearer data
     * @param serviceCategory the CDMA SCPT service category
     */
    public abstract void onCdmaCellBroadcastSms(int slotIndex, @NonNull byte[] bearerData,
            @CdmaSmsCbProgramData.Category int serviceCategory);

    /**
     * If overriding this method, call through to the super method for any unknown actions.
     * {@inheritDoc}
     */
    @Override
    @CallSuper
    @NonNull
    public IBinder onBind(@Nullable Intent intent) {
        return mStubWrapper;
    }

    /**
     * A wrapper around ICellBroadcastService that forwards calls to implementations of
     * {@link CellBroadcastService}.
     * @hide
     */
    public class ICellBroadcastServiceWrapper extends ICellBroadcastService.Stub {
        /**
         * Handle a GSM cell broadcast SMS.
         * @param slotIndex the index of the slot which received the broadcast
         * @param message the SMS message PDU
         */
        @Override
        public void handleGsmCellBroadcastSms(int slotIndex, byte[] message) {
            CellBroadcastService.this.onGsmCellBroadcastSms(slotIndex, message);
        }

        /**
         * Handle a CDMA cell broadcast SMS.
         * @param slotIndex the index of the slot which received the broadcast
         * @param bearerData the CDMA SMS bearer data
         * @param serviceCategory the CDMA SCPT service category
         */
        @Override
        public void handleCdmaCellBroadcastSms(int slotIndex, byte[] bearerData,
                int serviceCategory) {
            CellBroadcastService.this.onCdmaCellBroadcastSms(slotIndex, bearerData,
                    serviceCategory);
        }
    }
}