/*
* Copyright (C) 2009 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.email.service;
import com.android.email.mail.MessagingException;
import android.content.ComponentName;
import android.content.Context;
import android.content.Intent;
import android.content.ServiceConnection;
import android.os.Bundle;
import android.os.Debug;
import android.os.IBinder;
import android.os.RemoteException;
import android.util.Log;
/**
* The EmailServiceProxy class provides a simple interface for the UI to call into the various
* EmailService classes (e.g. SyncManager for EAS). It wraps the service connect/disconnect
* process so that the caller need not be concerned with it.
*
* Use the class like this:
* new EmailServiceClass(context, class).loadAttachment(attachmentId, callback)
*
* Methods without a return value return immediately (i.e. are asynchronous); methods with a
* return value wait for a result from the Service (i.e. they should not be called from the UI
* thread) with a default timeout of 30 seconds (settable)
*
* An EmailServiceProxy object cannot be reused (trying to do so generates a RemoteException)
*/
public class EmailServiceProxy implements IEmailService {
private static final boolean DEBUG_PROXY = false; // DO NOT CHECK THIS IN SET TO TRUE
private static final String TAG = "EmailServiceProxy";
public static final String AUTO_DISCOVER_BUNDLE_ERROR_CODE = "autodiscover_error_code";
public static final String AUTO_DISCOVER_BUNDLE_HOST_AUTH = "autodiscover_host_auth";
private final Context mContext;
private final Class<?> mClass;
private final IEmailServiceCallback mCallback;
private Runnable mRunnable;
private ServiceConnection mSyncManagerConnection = new EmailServiceConnection ();
private IEmailService mService = null;
private Object mReturn = null;
// Service call timeout (in seconds)
private int mTimeout = 45;
private boolean mDead = false;
public EmailServiceProxy(Context _context, Class<?> _class) {
this(_context, _class, null);
}
public EmailServiceProxy(Context _context, Class<?> _class, IEmailServiceCallback _callback) {
mContext = _context;
mClass = _class;
mCallback = _callback;
// Proxy calls have a timeout, and this can cause failures while debugging due to the
// far slower execution speed. In particular, validate calls fail regularly with ssl
// connections at the default timeout (30 seconds)
if (Debug.isDebuggerConnected()) {
mTimeout <<= 2;
}
}
class EmailServiceConnection implements ServiceConnection {
public void onServiceConnected(ComponentName name, IBinder binder) {
mService = IEmailService.Stub.asInterface(binder);
if (DEBUG_PROXY) {
Log.v(TAG, "Service " + mClass.getSimpleName() + " connected");
}
// Run our task on a new thread
new Thread(new Runnable() {
public void run() {
runTask();
}}).start();
}
public void onServiceDisconnected(ComponentName name) {
if (DEBUG_PROXY) {
Log.v(TAG, "Service " + mClass.getSimpleName() + " disconnected");
}
}
}
public EmailServiceProxy setTimeout(int secs) {
mTimeout = secs;
return this;
}
private void runTask() {
Thread thread = new Thread(mRunnable);
thread.start();
try {
thread.join();
} catch (InterruptedException e) {
}
try {
mContext.unbindService(mSyncManagerConnection);
} catch (IllegalArgumentException e) {
// This can happen if the user ended the activity that was using the service
// This is harmless, but we've got to catch it
}
mDead = true;
synchronized(mSyncManagerConnection) {
if (DEBUG_PROXY) {
Log.v(TAG, "Service task completed; disconnecting");
}
mSyncManagerConnection.notify();
}
}
private void setTask(Runnable runnable) throws RemoteException {
if (mDead) {
throw new RemoteException();
}
mRunnable = runnable;
if (DEBUG_PROXY) {
Log.v(TAG, "Service " + mClass.getSimpleName() + " bind requested");
}
mContext.bindService(new Intent(mContext, mClass), mSyncManagerConnection,
Context.BIND_AUTO_CREATE);
}
public void waitForCompletion() {
synchronized (mSyncManagerConnection) {
long time = System.currentTimeMillis();
try {
if (DEBUG_PROXY) {
Log.v(TAG, "Waiting for task to complete...");
}
mSyncManagerConnection.wait(mTimeout * 1000L);
} catch (InterruptedException e) {
// Can be ignored safely
}
if (DEBUG_PROXY) {
Log.v(TAG, "Wait finished in " + (System.currentTimeMillis() - time) + "ms");
}
}
}
public void loadAttachment(final long attachmentId, final String destinationFile,
final String contentUriString) throws RemoteException {
setTask(new Runnable () {
public void run() {
try {
if (mCallback != null) mService.setCallback(mCallback);
mService.loadAttachment(attachmentId, destinationFile, contentUriString);
} catch (RemoteException e) {
}
}
});
}
public void startSync(final long mailboxId) throws RemoteException {
setTask(new Runnable () {
public void run() {
try {
if (mCallback != null) mService.setCallback(mCallback);
mService.startSync(mailboxId);
} catch (RemoteException e) {
}
}
});
}
public void stopSync(final long mailboxId) throws RemoteException {
setTask(new Runnable () {
public void run() {
try {
if (mCallback != null) mService.setCallback(mCallback);
mService.stopSync(mailboxId);
} catch (RemoteException e) {
}
}
});
}
public int validate(final String protocol, final String host, final String userName,
final String password, final int port, final boolean ssl,
final boolean trustCertificates) throws RemoteException {
setTask(new Runnable () {
public void run() {
try {
if (mCallback != null) mService.setCallback(mCallback);
mReturn = mService.validate(protocol, host, userName, password, port, ssl,
trustCertificates);
} catch (RemoteException e) {
}
}
});
waitForCompletion();
if (mReturn == null) {
return MessagingException.UNSPECIFIED_EXCEPTION;
} else {
Log.v(TAG, "validate returns " + mReturn);
return (Integer)mReturn;
}
}
public Bundle autoDiscover(final String userName, final String password)
throws RemoteException {
setTask(new Runnable () {
public void run() {
try {
if (mCallback != null) mService.setCallback(mCallback);
mReturn = mService.autoDiscover(userName, password);
} catch (RemoteException e) {
}
}
});
waitForCompletion();
if (mReturn == null) {
return null;
} else {
Bundle bundle = (Bundle) mReturn;
Log.v(TAG, "autoDiscover returns " + bundle.getInt(AUTO_DISCOVER_BUNDLE_ERROR_CODE));
return bundle;
}
}
public void updateFolderList(final long accountId) throws RemoteException {
setTask(new Runnable () {
public void run() {
try {
if (mCallback != null) mService.setCallback(mCallback);
mService.updateFolderList(accountId);
} catch (RemoteException e) {
}
}
});
}
public void setLogging(final int on) throws RemoteException {
setTask(new Runnable () {
public void run() {
try {
if (mCallback != null) mService.setCallback(mCallback);
mService.setLogging(on);
} catch (RemoteException e) {
}
}
});
}
public void setCallback(final IEmailServiceCallback cb) throws RemoteException {
setTask(new Runnable () {
public void run() {
try {
mService.setCallback(cb);
} catch (RemoteException e) {
}
}
});
}
public void hostChanged(final long accountId) throws RemoteException {
setTask(new Runnable () {
public void run() {
try {
mService.hostChanged(accountId);
} catch (RemoteException e) {
}
}
});
}
public void sendMeetingResponse(final long messageId, final int response) throws RemoteException {
setTask(new Runnable () {
public void run() {
try {
if (mCallback != null) mService.setCallback(mCallback);
mService.sendMeetingResponse(messageId, response);
} catch (RemoteException e) {
}
}
});
}
public void loadMore(long messageId) throws RemoteException {
// TODO Auto-generated method stub
}
public boolean createFolder(long accountId, String name) throws RemoteException {
return false;
}
public boolean deleteFolder(long accountId, String name) throws RemoteException {
return false;
}
public boolean renameFolder(long accountId, String oldName, String newName)
throws RemoteException {
return false;
}
public IBinder asBinder() {
return null;
}
}