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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
|
/*
* Copyright (C) 2011 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 com.android.nfc_extras;
import android.annotation.SdkConstant;
import android.annotation.SdkConstant.SdkConstantType;
import android.nfc.ApduList;
import android.nfc.INfcAdapterExtras;
import android.nfc.NfcAdapter;
import android.os.RemoteException;
import android.util.Log;
/**
* Provides additional methods on an {@link NfcAdapter} for Card Emulation
* and management of {@link NfcExecutionEnvironment}'s.
*
* There is a 1-1 relationship between an {@link NfcAdapterExtras} object and
* a {@link NfcAdapter} object.
*/
public final class NfcAdapterExtras {
private static final String TAG = "NfcAdapterExtras";
/**
* Broadcast Action: an RF field ON has been detected.
*
* <p class="note">This is an unreliable signal, and will be removed.
* <p class="note">
* Requires the {@link android.Manifest.permission#WRITE_SECURE_SETTINGS} permission
* to receive.
*/
public static final String ACTION_RF_FIELD_ON_DETECTED =
"com.android.nfc_extras.action.RF_FIELD_ON_DETECTED";
/**
* Broadcast Action: an RF field OFF has been detected.
*
* <p class="note">This is an unreliable signal, and will be removed.
* <p class="note">
* Requires the {@link android.Manifest.permission#WRITE_SECURE_SETTINGS} permission
* to receive.
*/
public static final String ACTION_RF_FIELD_OFF_DETECTED =
"com.android.nfc_extras.action.RF_FIELD_OFF_DETECTED";
// protected by NfcAdapterExtras.class, and final after first construction,
// except for attemptDeadServiceRecovery() when NFC crashes - we accept a
// best effort recovery
private static NfcAdapter sAdapter;
private static INfcAdapterExtras sService;
private static NfcAdapterExtras sSingleton;
private static NfcExecutionEnvironment sEmbeddedEe;
private static CardEmulationRoute sRouteOff;
private static CardEmulationRoute sRouteOnWhenScreenOn;
/** get service handles */
private static void initService() {
sService = sAdapter.getNfcAdapterExtrasInterface();
}
/**
* Get the {@link NfcAdapterExtras} for the given {@link NfcAdapter}.
*
* <p class="note">
* Requires the {@link android.Manifest.permission#WRITE_SECURE_SETTINGS} permission.
*
* @param adapter a {@link NfcAdapter}, must not be null
* @return the {@link NfcAdapterExtras} object for the given {@link NfcAdapter}
*/
public static NfcAdapterExtras get(NfcAdapter adapter) {
synchronized(NfcAdapterExtras.class) {
if (sSingleton == null) {
try {
sAdapter = adapter;
sRouteOff = new CardEmulationRoute(CardEmulationRoute.ROUTE_OFF, null);
sSingleton = new NfcAdapterExtras();
sEmbeddedEe = new NfcExecutionEnvironment(sSingleton);
sRouteOnWhenScreenOn = new CardEmulationRoute(
CardEmulationRoute.ROUTE_ON_WHEN_SCREEN_ON, sEmbeddedEe);
initService();
} finally {
if (sSingleton == null) {
sService = null;
sEmbeddedEe = null;
sRouteOff = null;
sRouteOnWhenScreenOn = null;
}
}
}
return sSingleton;
}
}
private NfcAdapterExtras() {}
/**
* Immutable data class that describes a card emulation route.
*/
public final static class CardEmulationRoute {
/**
* Card Emulation is turned off on this NfcAdapter.
* <p>This is the default routing state after boot.
*/
public static final int ROUTE_OFF = 1;
/**
* Card Emulation is routed to {@link #nfcEe} only when the screen is on,
* otherwise it is turned off.
*/
public static final int ROUTE_ON_WHEN_SCREEN_ON = 2;
/**
* A route such as {@link #ROUTE_OFF} or {@link #ROUTE_ON_WHEN_SCREEN_ON}.
*/
public final int route;
/**
* The {@link NFcExecutionEnvironment} that is Card Emulation is routed to.
* <p>null if {@link #route} is {@link #ROUTE_OFF}, otherwise not null.
*/
public final NfcExecutionEnvironment nfcEe;
public CardEmulationRoute(int route, NfcExecutionEnvironment nfcEe) {
if (route == ROUTE_OFF && nfcEe != null) {
throw new IllegalArgumentException("must not specifiy a NFC-EE with ROUTE_OFF");
} else if (route != ROUTE_OFF && nfcEe == null) {
throw new IllegalArgumentException("must specifiy a NFC-EE for this route");
}
this.route = route;
this.nfcEe = nfcEe;
}
}
/**
* NFC service dead - attempt best effort recovery
*/
void attemptDeadServiceRecovery(Exception e) {
Log.e(TAG, "NFC Adapter Extras dead - attempting to recover");
sAdapter.attemptDeadServiceRecovery(e);
initService();
}
INfcAdapterExtras getService() {
return sService;
}
/**
* Get the routing state of this NFC EE.
*
* <p class="note">
* Requires the {@link android.Manifest.permission#WRITE_SECURE_SETTINGS} permission.
*
* @return
*/
public CardEmulationRoute getCardEmulationRoute() {
try {
int route = sService.getCardEmulationRoute();
return route == CardEmulationRoute.ROUTE_OFF ?
sRouteOff :
sRouteOnWhenScreenOn;
} catch (RemoteException e) {
attemptDeadServiceRecovery(e);
return sRouteOff;
}
}
/**
* Set the routing state of this NFC EE.
*
* <p>This routing state is not persisted across reboot.
*
* <p class="note">
* Requires the {@link android.Manifest.permission#WRITE_SECURE_SETTINGS} permission.
*
* @param route a {@link #CardEmulationRoute}
*/
public void setCardEmulationRoute(CardEmulationRoute route) {
try {
sService.setCardEmulationRoute(route.route);
} catch (RemoteException e) {
attemptDeadServiceRecovery(e);
}
}
/**
* Get the {@link NfcExecutionEnvironment} that is embedded with the
* {@link NFcAdapter}.
*
* <p class="note">
* Requires the {@link android.Manifest.permission#WRITE_SECURE_SETTINGS} permission.
*
* @return a {@link NfcExecutionEnvironment}, or null if there is no embedded NFC-EE
*/
public NfcExecutionEnvironment getEmbeddedExecutionEnvironment() {
return sEmbeddedEe;
}
public void registerTearDownApdus(String packageName, ApduList apdus) {
try {
sService.registerTearDownApdus(packageName, apdus);
} catch (RemoteException e) {
attemptDeadServiceRecovery(e);
}
}
public void unregisterTearDownApdus(String packageName) {
try {
sService.unregisterTearDownApdus(packageName);
} catch (RemoteException e) {
attemptDeadServiceRecovery(e);
}
}
}
|
