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
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
|
/*
* Copyright (C) 2013 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.printservice;
import android.os.RemoteException;
import android.print.PrinterCapabilitiesInfo;
import android.print.PrinterId;
import android.print.PrinterInfo;
import android.util.ArrayMap;
import android.util.Log;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
/**
* This class encapsulates the interaction between a print service and the
* system during printer discovery. During printer discovery you are responsible
* for adding discovered printers, removing already added printers that
* disappeared, and updating already added printers.
* <p>
* During the lifetime of this session you may be asked to start and stop
* performing printer discovery multiple times. You will receive a call to {@link
* PrinterDiscoverySession#onStartPrinterDiscovery(List)} to start printer
* discovery and a call to {@link PrinterDiscoverySession#onStopPrinterDiscovery()}
* to stop printer discovery. When the system is no longer interested in printers
* discovered by this session you will receive a call to {@link #onDestroy()} at
* which point the system will no longer call into the session and all the session
* methods will do nothing.
* </p>
* <p>
* Discovered printers are added by invoking {@link
* PrinterDiscoverySession#addPrinters(List)}. Added printers that disappeared are
* removed by invoking {@link PrinterDiscoverySession#removePrinters(List)}. Added
* printers whose properties or capabilities changed are updated through a call to
* {@link PrinterDiscoverySession#updatePrinters(List)}. The printers added in this
* session can be acquired via {@link #getPrinters()} where the returned printers
* will be an up-to-date snapshot of the printers that you reported during the
* session. Printers are <strong>not</strong> persisted across sessions.
* </p>
* <p>
* The system will make a call to {@link #onValidatePrinters(List)} if you
* need to update some printers. It is possible that you add a printer without
* specifying its capabilities. This enables you to avoid querying all discovered
* printers for their capabilities, rather querying the capabilities of a printer
* only if necessary. For example, the system will request that you update a printer
* if it gets selected by the user. When validating printers you do not need to
* provide the printers' capabilities but may do so.
* </p>
* <p>
* If the system is interested in being constantly updated for the state of a
* printer you will receive a call to {@link #onStartPrinterStateTracking(PrinterId)}
* after which you will have to do a best effort to keep the system updated for
* changes in the printer state and capabilities. You also <strong>must</strong>
* update the printer capabilities if you did not provide them when adding it, or
* the printer will be ignored. When the system is no longer interested in getting
* updates for a printer you will receive a call to {@link #onStopPrinterStateTracking(
* PrinterId)}.
* </p>
* <p>
* <strong>Note: </strong> All callbacks in this class are executed on the main
* application thread. You also have to invoke any method of this class on the main
* application thread.
* </p>
*/
public abstract class PrinterDiscoverySession {
private static final String LOG_TAG = "PrinterDiscoverySession";
private static final int MAX_ITEMS_PER_CALLBACK = 100;
private static int sIdCounter = 0;
private final int mId;
private final ArrayMap<PrinterId, PrinterInfo> mPrinters =
new ArrayMap<PrinterId, PrinterInfo>();
private ArrayMap<PrinterId, PrinterInfo> mLastSentPrinters;
private IPrintServiceClient mObserver;
private boolean mIsDestroyed;
private boolean mIsDiscoveryStarted;
/**
* Constructor.
*/
public PrinterDiscoverySession() {
mId = sIdCounter++;
}
void setObserver(IPrintServiceClient observer) {
mObserver = observer;
// If some printers were added in the method that
// created the session, send them over.
if (!mPrinters.isEmpty()) {
sendAddedPrinters(mObserver, getPrinters());
}
}
int getId() {
return mId;
}
/**
* Gets the printers reported in this session. For example, if you add two
* printers and remove one of them, the returned list will contain only
* the printer that was added but not removed.
* <p>
* <strong>Note: </strong> Calls to this method after the session is
* destroyed, that is after the {@link #onDestroy()} callback, will be ignored.
* </p>
*
* @return The printers.
*
* @see #addPrinters(List)
* @see #removePrinters(List)
* @see #updatePrinters(List)
* @see #isDestroyed()
*/
public final List<PrinterInfo> getPrinters() {
PrintService.throwIfNotCalledOnMainThread();
if (mIsDestroyed) {
return Collections.emptyList();
}
return new ArrayList<PrinterInfo>(mPrinters.values());
}
/**
* Adds discovered printers. Adding an already added printer has no effect.
* Removed printers can be added again. You can call this method multiple
* times during the life of this session. Duplicates will be ignored.
* <p>
* <strong>Note: </strong> Calls to this method after the session is
* destroyed, that is after the {@link #onDestroy()} callback, will be ignored.
* </p>
*
* @param printers The printers to add.
*
* @see #removePrinters(List)
* @see #updatePrinters(List)
* @see #getPrinters()
* @see #isDestroyed()
*/
public final void addPrinters(List<PrinterInfo> printers) {
PrintService.throwIfNotCalledOnMainThread();
// If the session is destroyed - nothing do to.
if (mIsDestroyed) {
Log.w(LOG_TAG, "Not adding printers - session destroyed.");
return;
}
if (mIsDiscoveryStarted) {
// If during discovery, add the new printers and send them.
List<PrinterInfo> addedPrinters = new ArrayList<PrinterInfo>();
final int addedPrinterCount = printers.size();
for (int i = 0; i < addedPrinterCount; i++) {
PrinterInfo addedPrinter = printers.get(i);
if (mPrinters.get(addedPrinter.getId()) == null) {
mPrinters.put(addedPrinter.getId(), addedPrinter);
addedPrinters.add(addedPrinter);
}
}
// Send the added printers, if such.
if (!addedPrinters.isEmpty()) {
sendAddedPrinters(mObserver, addedPrinters);
}
} else {
// Remember the last sent printers if needed.
if (mLastSentPrinters == null) {
mLastSentPrinters = new ArrayMap<PrinterId, PrinterInfo>(mPrinters);
}
// Update the printers.
final int addedPrinterCount = printers.size();
for (int i = 0; i < addedPrinterCount; i++) {
PrinterInfo addedPrinter = printers.get(i);
if (mPrinters.get(addedPrinter.getId()) == null) {
mPrinters.put(addedPrinter.getId(), addedPrinter);
}
}
}
}
private static void sendAddedPrinters(IPrintServiceClient observer,
List<PrinterInfo> printers) {
try {
final int printerCount = printers.size();
if (printerCount <= MAX_ITEMS_PER_CALLBACK) {
observer.onPrintersAdded(printers);
} else {
// Send the added printers in chunks avoiding the binder transaction limit.
final int transactionCount = (printerCount / MAX_ITEMS_PER_CALLBACK) + 1;
for (int i = 0; i < transactionCount; i++) {
final int start = i * MAX_ITEMS_PER_CALLBACK;
final int end = Math.min(start + MAX_ITEMS_PER_CALLBACK, printerCount);
List<PrinterInfo> subPrinters = printers.subList(start, end);
observer.onPrintersAdded(subPrinters);
}
}
} catch (RemoteException re) {
Log.e(LOG_TAG, "Error sending added printers", re);
}
}
/**
* Removes added printers. Removing an already removed or never added
* printer has no effect. Removed printers can be added again. You can
* call this method multiple times during the lifetime of this session.
* <p>
* <strong>Note: </strong> Calls to this method after the session is
* destroyed, that is after the {@link #onDestroy()} callback, will be ignored.
* </p>
*
* @param printerIds The ids of the removed printers.
*
* @see #addPrinters(List)
* @see #updatePrinters(List)
* @see #getPrinters()
* @see #isDestroyed()
*/
public final void removePrinters(List<PrinterId> printerIds) {
PrintService.throwIfNotCalledOnMainThread();
// If the session is destroyed - nothing do to.
if (mIsDestroyed) {
Log.w(LOG_TAG, "Not removing printers - session destroyed.");
return;
}
if (mIsDiscoveryStarted) {
// If during discovery, remove existing printers and send them.
List<PrinterId> removedPrinterIds = new ArrayList<PrinterId>();
final int removedPrinterIdCount = printerIds.size();
for (int i = 0; i < removedPrinterIdCount; i++) {
PrinterId removedPrinterId = printerIds.get(i);
if (mPrinters.remove(removedPrinterId) != null) {
removedPrinterIds.add(removedPrinterId);
}
}
// Send the removed printers, if such.
if (!removedPrinterIds.isEmpty()) {
sendRemovedPrinters(mObserver, removedPrinterIds);
}
} else {
// Remember the last sent printers if needed.
if (mLastSentPrinters == null) {
mLastSentPrinters = new ArrayMap<PrinterId, PrinterInfo>(mPrinters);
}
// Update the printers.
final int removedPrinterIdCount = printerIds.size();
for (int i = 0; i < removedPrinterIdCount; i++) {
PrinterId removedPrinterId = printerIds.get(i);
mPrinters.remove(removedPrinterId);
}
}
}
private static void sendRemovedPrinters(IPrintServiceClient observer,
List<PrinterId> printerIds) {
try {
final int printerIdCount = printerIds.size();
if (printerIdCount <= MAX_ITEMS_PER_CALLBACK) {
observer.onPrintersRemoved(printerIds);
} else {
final int transactionCount = (printerIdCount / MAX_ITEMS_PER_CALLBACK) + 1;
for (int i = 0; i < transactionCount; i++) {
final int start = i * MAX_ITEMS_PER_CALLBACK;
final int end = Math.min(start + MAX_ITEMS_PER_CALLBACK, printerIdCount);
List<PrinterId> subPrinterIds = printerIds.subList(start, end);
observer.onPrintersRemoved(subPrinterIds);
}
}
} catch (RemoteException re) {
Log.e(LOG_TAG, "Error sending removed printers", re);
}
}
/**
* Updates added printers. Updating a printer that was not added or that
* was removed has no effect. You can call this method multiple times
* during the lifetime of this session.
* <p>
* <strong>Note: </strong> Calls to this method after the session is
* destroyed, that is after the {@link #onDestroy()} callback, will be ignored.
* </p>
*
* @param printers The printers to update.
*
* @see #addPrinters(List)
* @see #removePrinters(List)
* @see #getPrinters()
* @see #isDestroyed()
*/
public final void updatePrinters(List<PrinterInfo> printers) {
PrintService.throwIfNotCalledOnMainThread();
// If the session is destroyed - nothing do to.
if (mIsDestroyed) {
Log.w(LOG_TAG, "Not updating printers - session destroyed.");
return;
}
if (mIsDiscoveryStarted) {
// If during discovery, update existing printers and send them.
List<PrinterInfo> updatedPrinters = new ArrayList<PrinterInfo>();
final int updatedPrinterCount = printers.size();
for (int i = 0; i < updatedPrinterCount; i++) {
PrinterInfo updatedPrinter = printers.get(i);
PrinterInfo oldPrinter = mPrinters.get(updatedPrinter.getId());
if (oldPrinter != null && !oldPrinter.equals(updatedPrinter)) {
mPrinters.put(updatedPrinter.getId(), updatedPrinter);
updatedPrinters.add(updatedPrinter);
}
}
// Send the updated printers, if such.
if (!updatedPrinters.isEmpty()) {
sendUpdatedPrinters(mObserver, updatedPrinters);
}
} else {
// Remember the last sent printers if needed.
if (mLastSentPrinters == null) {
mLastSentPrinters = new ArrayMap<PrinterId, PrinterInfo>(mPrinters);
}
// Update the printers.
final int updatedPrinterCount = printers.size();
for (int i = 0; i < updatedPrinterCount; i++) {
PrinterInfo updatedPrinter = printers.get(i);
PrinterInfo oldPrinter = mPrinters.get(updatedPrinter.getId());
if (oldPrinter != null && !oldPrinter.equals(updatedPrinter)) {
mPrinters.put(updatedPrinter.getId(), updatedPrinter);
}
}
}
}
private static void sendUpdatedPrinters(IPrintServiceClient observer,
List<PrinterInfo> printers) {
try {
final int printerCount = printers.size();
if (printerCount <= MAX_ITEMS_PER_CALLBACK) {
observer.onPrintersUpdated(printers);
} else {
final int transactionCount = (printerCount / MAX_ITEMS_PER_CALLBACK) + 1;
for (int i = 0; i < transactionCount; i++) {
final int start = i * MAX_ITEMS_PER_CALLBACK;
final int end = Math.min(start + MAX_ITEMS_PER_CALLBACK, printerCount);
List<PrinterInfo> subPrinters = printers.subList(start, end);
observer.onPrintersUpdated(subPrinters);
}
}
} catch (RemoteException re) {
Log.e(LOG_TAG, "Error sending updated printers", re);
}
}
private void sendOutOfDiscoveryPeriodPrinterChanges() {
// Noting changed since the last discovery period - nothing to do.
if (mLastSentPrinters == null || mLastSentPrinters.isEmpty()) {
mLastSentPrinters = null;
return;
}
List<PrinterInfo> addedPrinters = null;
List<PrinterInfo> updatedPrinters = null;
List<PrinterId> removedPrinterIds = null;
// Determine the added and updated printers.
for (PrinterInfo printer : mPrinters.values()) {
PrinterInfo sentPrinter = mLastSentPrinters.get(printer.getId());
if (sentPrinter != null) {
if (!sentPrinter.equals(printer)) {
if (updatedPrinters == null) {
updatedPrinters = new ArrayList<PrinterInfo>();
}
updatedPrinters.add(printer);
}
} else {
if (addedPrinters == null) {
addedPrinters = new ArrayList<PrinterInfo>();
}
addedPrinters.add(printer);
}
}
// Send the added printers, if such.
if (addedPrinters != null) {
sendAddedPrinters(mObserver, addedPrinters);
}
// Send the updated printers, if such.
if (updatedPrinters != null) {
sendUpdatedPrinters(mObserver, updatedPrinters);
}
// Determine the removed printers.
for (PrinterInfo sentPrinter : mLastSentPrinters.values()) {
if (!mPrinters.containsKey(sentPrinter.getId())) {
if (removedPrinterIds == null) {
removedPrinterIds = new ArrayList<PrinterId>();
}
removedPrinterIds.add(sentPrinter.getId());
}
}
// Send the removed printers, if such.
if (removedPrinterIds != null) {
sendRemovedPrinters(mObserver, removedPrinterIds);
}
mLastSentPrinters = null;
}
/**
* Callback asking you to start printer discovery. Discovered printers should be
* added via calling {@link #addPrinters(List)}. Added printers that disappeared
* should be removed via calling {@link #removePrinters(List)}. Added printers
* whose properties or capabilities changed should be updated via calling {@link
* #updatePrinters(List)}. You will receive a call to call to {@link
* #onStopPrinterDiscovery()} when you should stop printer discovery.
* <p>
* During the lifetime of this session all printers that are known to your print
* service have to be added. The system does not retain any printers across sessions.
* However, if you were asked to start and then stop performing printer discovery
* in this session, then a subsequent discovering should not re-discover already
* discovered printers.
* </p>
* <p>
* <strong>Note: </strong>You are also given a list of printers whose availability
* has to be checked first. For example, these printers could be the user's favorite
* ones, therefore they have to be verified first. You do <strong>not need</strong>
* to provide the capabilities of the printers, rather verify whether they exist
* similarly to {@link #onValidatePrinters(List)}.
* </p>
*
* @param priorityList The list of printers to validate first. Never null.
*
* @see #onStopPrinterDiscovery()
* @see #addPrinters(List)
* @see #removePrinters(List)
* @see #updatePrinters(List)
* @see #isPrinterDiscoveryStarted()
*/
public abstract void onStartPrinterDiscovery(List<PrinterId> priorityList);
/**
* Callback notifying you that you should stop printer discovery.
*
* @see #onStartPrinterDiscovery(List)
* @see #isPrinterDiscoveryStarted()
*/
public abstract void onStopPrinterDiscovery();
/**
* Callback asking you to validate that the given printers are valid, that
* is they exist. You are responsible for checking whether these printers
* exist and for the ones that do exist notify the system via calling
* {@link #updatePrinters(List)}.
* <p>
* <strong>Note: </strong> You are <strong>not required</strong> to provide
* the printer capabilities when updating the printers that do exist.
* <p>
*
* @param printerIds The printers to validate.
*
* @see #updatePrinters(List)
* @see PrinterInfo.Builder#setCapabilities(PrinterCapabilitiesInfo)
* PrinterInfo.Builder.setCapabilities(PrinterCapabilitiesInfo)
*/
public abstract void onValidatePrinters(List<PrinterId> printerIds);
/**
* Callback asking you to start tracking the state of a printer. Tracking
* the state means that you should do a best effort to observe the state
* of this printer and notify the system if that state changes via calling
* {@link #updatePrinters(List)}.
* <p>
* <strong>Note: </strong> A printer can be initially added without its
* capabilities to avoid polling printers that the user will not select.
* However, after this method is called you are expected to update the
* printer <strong>including</strong> its capabilities. Otherwise, the
* printer will be ignored.
* <p>
* <p>
* A scenario when you may be requested to track a printer's state is if
* the user selects that printer and the system has to present print
* options UI based on the printer's capabilities. In this case the user
* should be promptly informed if, for example, the printer becomes
* unavailable.
* </p>
*
* @param printerId The printer to start tracking.
*
* @see #onStopPrinterStateTracking(PrinterId)
* @see #updatePrinters(List)
* @see PrinterInfo.Builder#setCapabilities(PrinterCapabilitiesInfo)
* PrinterInfo.Builder.setCapabilities(PrinterCapabilitiesInfo)
*/
public abstract void onStartPrinterStateTracking(PrinterId printerId);
/**
* Callback asking you to stop tracking the state of a printer. The passed
* in printer id is the one for which you received a call to {@link
* #onStartPrinterStateTracking(PrinterId)}.
*
* @param printerId The printer to stop tracking.
*
* @see #onStartPrinterStateTracking(PrinterId)
*/
public abstract void onStopPrinterStateTracking(PrinterId printerId);
/**
* Notifies you that the session is destroyed. After this callback is invoked
* any calls to the methods of this class will be ignored, {@link #isDestroyed()}
* will return true and you will also no longer receive callbacks.
*
* @see #isDestroyed()
*/
public abstract void onDestroy();
/**
* Gets whether the session is destroyed.
*
* @return Whether the session is destroyed.
*
* @see #onDestroy()
*/
public final boolean isDestroyed() {
PrintService.throwIfNotCalledOnMainThread();
return mIsDestroyed;
}
/**
* Gets whether printer discovery is started.
*
* @return Whether printer discovery is destroyed.
*
* @see #onStartPrinterDiscovery(List)
* @see #onStopPrinterDiscovery()
*/
public final boolean isPrinterDiscoveryStarted() {
PrintService.throwIfNotCalledOnMainThread();
return mIsDiscoveryStarted;
}
void startPrinterDiscovery(List<PrinterId> priorityList) {
if (!mIsDestroyed) {
mIsDiscoveryStarted = true;
sendOutOfDiscoveryPeriodPrinterChanges();
if (priorityList == null) {
priorityList = Collections.emptyList();
}
onStartPrinterDiscovery(priorityList);
}
}
void stopPrinterDiscovery() {
if (!mIsDestroyed) {
mIsDiscoveryStarted = false;
onStopPrinterDiscovery();
}
}
void validatePrinters(List<PrinterId> printerIds) {
if (!mIsDestroyed && mObserver != null) {
onValidatePrinters(printerIds);
}
}
void startPrinterStateTracking(PrinterId printerId) {
if (!mIsDestroyed && mObserver != null) {
onStartPrinterStateTracking(printerId);
}
}
void stopPrinterStateTracking(PrinterId printerId) {
if (!mIsDestroyed && mObserver != null) {
onStopPrinterStateTracking(printerId);
}
}
void destroy() {
if (!mIsDestroyed) {
mIsDestroyed = true;
mIsDiscoveryStarted = false;
mPrinters.clear();
mLastSentPrinters = null;
mObserver = null;
onDestroy();
}
}
}
|