BluetoothOppBatch.java revision 448de2e7f9e33c099207c80a8135f7a125b995f6 
1/*
2 * Copyright (c) 2008-2009, Motorola, Inc.
3 *
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are met:
8 *
9 * - Redistributions of source code must retain the above copyright notice,
10 * this list of conditions and the following disclaimer.
11 *
12 * - Redistributions in binary form must reproduce the above copyright notice,
13 * this list of conditions and the following disclaimer in the documentation
14 * and/or other materials provided with the distribution.
15 *
16 * - Neither the name of the Motorola, Inc. nor the names of its contributors
17 * may be used to endorse or promote products derived from this software
18 * without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
24 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 * POSSIBILITY OF SUCH DAMAGE.
31 */
32
33package com.android.bluetooth.opp;
34
35import java.io.File;
36import java.util.ArrayList;
37
38import android.bluetooth.BluetoothAdapter;
39import android.bluetooth.BluetoothDevice;
40import android.content.Context;
41import android.util.Log;
42
43import com.google.android.collect.Lists;
44
45/**
46 * This class stores information about a batch of OPP shares that should be
47 * transferred in one session.
48 */
49/*There are a few cases: 1. create a batch for a single file to send
50 * 2. create a batch for multiple files to send
51 * 3. add additional file(s) to existing batch to send
52 * 4. create a batch for receive single file
53 * 5. add additional file to existing batch to receive (this only happens as the server
54 * session notify more files to receive)
55 * 6. Cancel sending a single file
56 * 7. Cancel sending a file from multiple files (implies cancel the transfer, rest of
57 * the unsent files are also canceled)
58 * 8. Cancel receiving a single file
59 * 9. Cancel receiving a file (implies cancel the transfer, no additional files will be received)
60 */
61// test submit patch01
62// test submit patch02
63// test submit patch03
64public class BluetoothOppBatch {
65    private static final String TAG = "BtOppBatch";
66    private static final boolean V = Constants.VERBOSE;
67
68    public int mId;
69    public int mStatus;
70
71    public final long mTimestamp;
72    public final int mDirection;
73    public final BluetoothDevice mDestination;
74
75    private BluetoothOppBatchListener mListener;
76
77    private final ArrayList<BluetoothOppShareInfo> mShares;
78    private final Context mContext;
79
80    /**
81     * An interface for notifying when BluetoothOppTransferBatch is changed
82     */
83    public interface BluetoothOppBatchListener {
84        /**
85         * Called to notify when a share is added into the batch
86         * @param id , BluetoothOppShareInfo.id
87         */
88        public void onShareAdded(int id);
89
90        /**
91         * Called to notify when a share is deleted from the batch
92         * @param id , BluetoothOppShareInfo.id
93         */
94        public void onShareDeleted(int id);
95
96        /**
97         * Called to notify when the batch is canceled
98         */
99        public void onBatchCanceled();
100    }
101
102    /**
103     * A batch is always created with at least one ShareInfo
104     * @param context, Context
105     * @param info, BluetoothOppShareInfo
106     */
107    public BluetoothOppBatch(Context context, BluetoothOppShareInfo info) {
108        BluetoothAdapter adapter = BluetoothAdapter.getDefaultAdapter();
109        mContext = context;
110        mShares = Lists.newArrayList();
111        mTimestamp = info.mTimestamp;
112        mDirection = info.mDirection;
113        mDestination = adapter.getRemoteDevice(info.mDestination);
114        mStatus = Constants.BATCH_STATUS_PENDING;
115        mShares.add(info);
116
117        if (V) Log.v(TAG, "New Batch created for info " + info.mId);
118    }
119
120    /**
121     * Add one share into the batch.
122     */
123    /* There are 2 cases: Service scans the databases and it's multiple send
124     * Service receives database update and know additional file should be received
125     */
126
127    public void addShare(BluetoothOppShareInfo info) {
128        mShares.add(info);
129        if (mListener != null) {
130            mListener.onShareAdded(info.mId);
131        }
132    }
133
134    /**
135     * Delete one share from the batch. Not used now.
136     */
137    /*It should only be called under requirement that cancel one single share, but not to
138     * cancel the whole batch. Currently we assume "cancel" is to cancel whole batch.
139     */
140    public void deleteShare(BluetoothOppShareInfo info) {
141        if (info.mStatus == BluetoothShare.STATUS_RUNNING) {
142            info.mStatus = BluetoothShare.STATUS_CANCELED;
143            if (info.mDirection == BluetoothShare.DIRECTION_INBOUND && info.mFilename != null) {
144                new File(info.mFilename).delete();
145            }
146        }
147
148        if (mListener != null) {
149            mListener.onShareDeleted(info.mId);
150        }
151    }
152
153    /**
154     * Cancel the whole batch.
155     */
156    /* 1) If the batch is running, stop the transfer
157     * 2) Go through mShares list and mark all incomplete share as CANCELED status
158     * 3) update ContentProvider for these canceled transfer
159     */
160    public void cancelBatch() {
161        if (V) Log.v(TAG, "batch " + this.mId + " is canceled");
162
163        if (mListener != null) {
164            mListener.onBatchCanceled();
165        }
166        //TODO investigate if below code is redundant
167        for (int i = mShares.size() - 1; i >= 0; i--) {
168            BluetoothOppShareInfo info = mShares.get(i);
169
170            if (info.mStatus < 200) {
171                if (info.mDirection == BluetoothShare.DIRECTION_INBOUND && info.mFilename != null) {
172                    new File(info.mFilename).delete();
173                }
174                if (V) Log.v(TAG, "Cancel batch for info " + info.mId);
175
176                Constants.updateShareStatus(mContext, info.mId, BluetoothShare.STATUS_CANCELED);
177            }
178        }
179        mShares.clear();
180    }
181
182    /** check if a specific share is in this batch */
183    public boolean hasShare(BluetoothOppShareInfo info) {
184        return mShares.contains(info);
185    }
186
187    /** if this batch is empty */
188    public boolean isEmpty() {
189        return (mShares.size() == 0);
190    }
191
192    /**
193     * Get the running status of the batch
194     * @return
195     */
196
197    /** register a listener for the batch change */
198    public void registerListern(BluetoothOppBatchListener listener) {
199        mListener = listener;
200    }
201
202    /**
203     * Get the first pending ShareInfo of the batch
204     * @return BluetoothOppShareInfo, for the first pending share, or null if
205     *         none exists
206     */
207    public BluetoothOppShareInfo getPendingShare() {
208        for (int i = 0; i < mShares.size(); i++) {
209            BluetoothOppShareInfo share = mShares.get(i);
210            if (share.mStatus == BluetoothShare.STATUS_PENDING) {
211                return share;
212            }
213        }
214        return null;
215    }
216}
217