add support for broadcast intents

Change-Id: I25e74a2c8858932c0c3a033abab713a028448cf9
Reviewed-on: http://review.couchbase.org/9919
Reviewed-by: Marty Schoch <[email protected]>
Tested-by: Chris Anderson <[email protected]>
Reviewed-by: Chris Anderson <[email protected]>

Author: mschoch

README.markdown

@@ -79,7 +79,47 @@ Now that your project supports Couchbase, starting Cocuhbase is accomplished by
 
         startCouchbase();
     }
-</pre>    
+</pre>
+
+## Broadcast Intents
+
+A Broadcast Receiver registered to listen for the right events can now be used instead of a delegate.
+
+1.  Optionally, use the CouchbaseMobile constructor without the delegate parameter
+
+<pre>
+    CouchbaseMobile couch = new CouchbaseMobile(getBaseContext());
+</pre>
+
+2.  Declare a Broadcast Receiver
+
+<pre>
+    private final BroadcastReceiver mReceiver = new BroadcastReceiver() {
+
+        @Override
+        public void onReceive(Context context, Intent intent) {
+            if(CouchbaseStarted.ACTION.equals(intent.getAction())) {
+
+            }
+            else if(CouchbaseError.ACTION.equals(intent.getAction())) {
+
+            }
+        }
+    };
+</pre>
+
+3.  Register the receiver to listen for the appropriate events
+
+<pre>
+    public void onCreate(Bundle savedInstanceState) {
+        super.onCreate(savedInstanceState);
+
+        ...
+
+        registerReceiver(mReceiver, new IntentFilter(CouchbaseStarted.ACTION));
+        registerReceiver(mReceiver, new IntentFilter(CouchbaseError.ACTION));
+    }
+</pre>
 
 ## Examples
 

doc/README.txt

@@ -47,6 +47,40 @@ Now that your project supports Couchbase, starting Cocuhbase is accomplished by
         startCouchbase();
     }
 
+## Broadcast Intents
+
+A Broadcast Receiver registered to listen for the right events can now be used instead of a delegate.
+
+1.  Optionally, use the CouchbaseMobile constructor without the delegate parameter
+
+    CouchbaseMobile couch = new CouchbaseMobile(getBaseContext());
+
+2.  Declare a Broadcast Receiver
+
+    private final BroadcastReceiver mReceiver = new BroadcastReceiver() {
+
+        @Override
+        public void onReceive(Context context, Intent intent) {
+            if(CouchbaseStarted.ACTION.equals(intent.getAction())) {
+
+            }
+            else if(CouchbaseError.ACTION.equals(intent.getAction())) {
+
+            }
+        }
+    };
+
+3.  Register the receiver to listen for the appropriate events
+
+    public void onCreate(Bundle savedInstanceState) {
+        super.onCreate(savedInstanceState);
+
+        ...
+
+        registerReceiver(mReceiver, new IntentFilter(CouchbaseStarted.ACTION));
+        registerReceiver(mReceiver, new IntentFilter(CouchbaseError.ACTION));
+    }
+
 ## Examples
 
 For examples please look at:

src/com/couchbase/android/CouchbaseMobile.java

@@ -53,6 +53,14 @@ public class CouchbaseMobile {
 	 */
 	private static Context ctx;
 
+	/**
+	 *
+	 */
+	public CouchbaseMobile(Context appCtx) {
+		ctx = appCtx;
+		appNamespace = ctx.getPackageName();
+	}
+
 	/**
 	 * A few of the utility functions require some of the same context
 	 * that cannot be gotten automatically, so made this a class to

src/com/couchbase/android/CouchbaseService.java

@@ -16,6 +16,9 @@
 import android.os.Message;
 import android.util.Log;
 
+import com.couchbase.android.Intents.CouchbaseError;
+import com.couchbase.android.Intents.CouchbaseStarted;
+
 /**
  * Implementation of the Couchbase service
  *
@@ -76,20 +79,8 @@ public void handleMessage(Message msg) {
 
 			switch (msg.what) {
 			case ERROR:
-				if(msg.obj instanceof Exception) {
-					Exception e = (Exception) msg.obj;
-					StringWriter sw = new StringWriter();
-					e.printStackTrace(new PrintWriter(sw));
-					String stacktrace = sw.toString();
-					if (couchbaseDelegate != null) {
-						couchbaseDelegate.exit(stacktrace);
-					}
-				}
-				else if(msg.obj instanceof String){
-					if (couchbaseDelegate != null) {
-						couchbaseDelegate.exit((String)msg.obj);
-					}
-				}
+				Exception e = (Exception) msg.obj;
+				couchbaseError(e);
 				break;
 			case COMPLETE:
 				couchbaseInstallThread = null;
@@ -148,8 +139,37 @@ public void startCouchbase(ICouchbaseDelegate cb) {
 	 * Nofity the delegate that Couchbase has started
 	 */
 	void couchbaseStarted() {
+
+		if(url != null) {
+			//send broadcast intent
+			Intent intent = new Intent(CouchbaseStarted.ACTION);
+			intent.putExtra(CouchbaseStarted.HOST, url.getHost());
+			intent.putExtra(CouchbaseStarted.PORT, url.getPort());
+			getApplicationContext().sendBroadcast(intent);
+
+			//notify delegate
+			if (couchbaseDelegate != null) {
+				couchbaseDelegate.couchbaseStarted(url.getHost(), url.getPort());
+			}
+		}
+	}
+
+	/**
+	 * Notify the delegate that Couchbase has encountered an error
+	 */
+	void couchbaseError(Exception e) {
+		StringWriter sw = new StringWriter();
+		e.printStackTrace(new PrintWriter(sw));
+		String stacktrace = sw.toString();
+
+		//send broadcast intent
+		Intent intent = new Intent(CouchbaseError.ACTION);
+		intent.putExtra(CouchbaseError.MESSAGE, stacktrace);
+		getApplicationContext().sendBroadcast(intent);
+
+		//notify delegate
 		if (couchbaseDelegate != null) {
-			couchbaseDelegate.couchbaseStarted(url.getHost(), url.getPort());
+			couchbaseDelegate.exit(stacktrace);
 		}
 	}
 

src/com/couchbase/android/Intents.java

@@ -0,0 +1,88 @@
+package com.couchbase.android;
+
+import android.content.Intent;
+
+public class Intents {
+
+	/**
+	 * Do not instantiate this class
+	 */
+	private Intents() {}
+
+	/**
+	 * An intent used to notify that Couchbase has started
+	 */
+	public static final class CouchbaseStarted {
+
+		/**
+		 * Do not instantiate this class
+		 */
+		private CouchbaseStarted() {}
+
+		/**
+		 * The action name
+		 */
+		public final static String ACTION = "com.couchbase.android.COUCHBASE.STARTED";
+
+		/**
+		 * Name used in Intent Extra for storing host
+		 */
+		public final static String HOST = "host";
+
+		/**
+		 * Name used in Intent Extra for storing port
+		 */
+		public final static String PORT = "port";
+
+		/**
+		 * Utility to get the host Couchbase is listening on
+		 * @param intent the intent to parse
+		 * @return the hostname
+		 */
+		public static String getHost(Intent intent) {
+			return intent.getStringExtra(HOST);
+		}
+
+		/**
+		 * Utility to get the port Couchbase is listening on
+		 * @param intent the intent to parse
+		 * @return the port
+		 */
+		public static int getPort(Intent intent) {
+			return intent.getIntExtra(PORT, -1);
+		}
+
+	}
+
+	/**
+	 * An intent used to notify that Couchbase has encountered an error
+	 */
+	public static final class CouchbaseError {
+
+		/**
+		 * Do not instantiate
+		 */
+		private CouchbaseError() {}
+
+		/**
+		 * The action name
+		 */
+		public final static String ACTION = "com.couchbase.android.COUCHBASE.ERROR";
+
+		/**
+		 * Name used in Intent Extra for storing message
+		 */
+		public final static String MESSAGE = "message";
+
+		/**
+		 * Utility to get the message from Couchbase
+		 * @param intent the intent to parse
+		 * @return the message
+		 */
+		public static String getMessage(Intent intent) {
+			return intent.getStringExtra(MESSAGE);
+		}
+
+	}
+
+}