Wishlist/Extension Framework - Revision history

DolfjeBot1: Wishlist:Extension Framework moved to Wishlist/Extension Framework: Replacing 'Wishlist:' with 'Wishlist/'

2008-08-31T12:21:37Z

Wishlist:Extension Framework moved to Wishlist/Extension Framework: Replacing 'Wishlist:' with 'Wishlist/'

Kempelen: typo

2008-08-30T21:58:25Z

typo

Kempelen: Category changes: -User, -Ideas, +Software Ideas

2008-08-30T21:57:25Z

Category changes: -User, -Ideas, +Software Ideas

DolfjeBot1: Replacing 'OpenMoko' with 'Openmoko'

2008-08-23T09:33:34Z

Replacing 'OpenMoko' with 'Openmoko'

Coolcat at 08:31, 20 March 2008

2008-03-20T08:31:53Z

Coolcat at 04:13, 4 March 2008

2008-03-04T04:13:12Z

Jgm at 19:59, 18 August 2007

2007-08-18T19:59:14Z

Jgm at 00:06, 27 July 2007

2007-07-27T00:06:15Z

Jgm at 11:04, 25 July 2007

2007-07-25T11:04:49Z

Jgm at 10:51, 25 July 2007

2007-07-25T10:51:07Z

← Older revision		Revision as of 21:58, 30 August 2008
Line 82:		Line 82:
	#[[Wish List#Time-based blocking/unblocking of calls\|Time-based blocking/unblocking of calls]]		#[[Wish List#Time-based blocking/unblocking of calls\|Time-based blocking/unblocking of calls]]

−	[[Category:Software ~~Ideas~~]]	+	[[Category:Software ideas]]

@@ Line 81: / Line 81: @@
 #[[Wish List#Outgoing black/white lists|Outgoing black/white lists]]
 #[[Wish List#Time-based blocking/unblocking of calls|Time-based blocking/unblocking of calls]]
-[[Category:User]]
-[[Category:Ideas| ]]
+[[Category:Software Ideas]]

@@ Line 1: / Line 1: @@
 {{Wishlist}}
-The extension framework is an application for handling extensions to the core OpenMoko functionality.  It is designed to allow developers to build extensions that can affect the core functionality of the device without requiring extensive knowledge of, or even access to, the code that exists to carry out core functionality.  It also allows for multiple extensions to affect the same core functionality, handling ordering and chaining of the extensions to ensure consistent results.
+The extension framework is an application for handling extensions to the core Openmoko functionality.  It is designed to allow developers to build extensions that can affect the core functionality of the device without requiring extensive knowledge of, or even access to, the code that exists to carry out core functionality.  It also allows for multiple extensions to affect the same core functionality, handling ordering and chaining of the extensions to ensure consistent results.
 The rationale behind such a framework is to allow developers to create piecemeal functionality rather than having to alter or extend a large existing piece of code.  Taking an outgoing call as an example there are a number of things that may be required around it, such as:
@@ Line 18: / Line 18: @@
 === Scope ===
-The extension framework is initially aimed at providing a way of extending the core functionality of an OpenMoko device, and even more specifically of extending the abilities of the device in the area of making and receiving 'phone calls.  However, there will be nothing in the design that limits it to handling just this area and indeed the design will allow for any type of extension given the correct method calls within the core code.
+The extension framework is initially aimed at providing a way of extending the core functionality of an Openmoko device, and even more specifically of extending the abilities of the device in the area of making and receiving 'phone calls.  However, there will be nothing in the design that limits it to handling just this area and indeed the design will allow for any type of extension given the correct method calls within the core code.
 Note that the extension framework is not designed to manage GUI updating and interaction, although it is possible it could be used for this it is not designed to be a UI event bus and no consideration is given to this type of fucntionality.

← Older revision		Revision as of 08:31, 20 March 2008
Line 83:		Line 83:
	[[Category:User]]		[[Category:User]]
	[[Category:Ideas\| ]]		[[Category:Ideas\| ]]
−	~~[[Category:Software ideas]]~~

← Older revision		Revision as of 04:13, 4 March 2008
Line 81:		Line 81:
	#[[Wish List#Outgoing black/white lists\|Outgoing black/white lists]]		#[[Wish List#Outgoing black/white lists\|Outgoing black/white lists]]
	#[[Wish List#Time-based blocking/unblocking of calls\|Time-based blocking/unblocking of calls]]		#[[Wish List#Time-based blocking/unblocking of calls\|Time-based blocking/unblocking of calls]]
		+	[[Category:User]]
		+	[[Category:Ideas\| ]]
		+	[[Category:Software ideas]]

@@ Line 46: / Line 46: @@
 #* number: a string that contains the new number to dial (which may be the same as the input number to dial)
 #* sendid: whether or not to send caller ID
-#* authorized: if the action of making the call is authorized
+#* status: a numeric result of the extension's work, which may be one of the following generic types:
-#* authreason: if the action of making the call is not authorized then a reason why not
+#** Continue: continue with the existing operation
 # The second relevant extension is contacted and carries out its work.  Note that the parameters sent to this module include the updated number and sendid from the first relevant extension
 # The second relevant extension returns the values as per the first extension
@@ Line 59: / Line 62: @@
 # An extension sends a registration method to the extension manager.  The method contains the following information:
-#* extension.  This is the full name of the method we wish to extend, for example org.openmoko.ExtensionHandler.Gsmd.OutgoingCall
+#* extension.  This is the full name of the method we wish to extend, for example org.openmoko.extension.Gsmd.OutgoingCall
 #* name.  This is the name of the object that is carrying out the extension, for example net.devzero.SampleExtension
 #* path.  This is the path to the object that is carrying out the extension, for example /net/devzero/SampleExtension

@@ Line 24: / Line 24: @@
 === Components ===
-The extension framework will consist of three main components which will manage various aspects of managing and using the extensions.  These components may or may not be separate processes, although there is a reliability advantage to having the handler separate from the other components.  The names and functions of the three components are:
+The extension framework will consist of three main components which will manage various aspects of managing and using the extensions.  These components may or may not be separate processes, although there is a reliability advantage to having the handler separate from the other components it introduces additional complexity.  The names and functions of the three components are:
 * The extension manager handles registration and activation of extensions as well as providing them a clean interface to store preference and configuration information.
@@ Line 34: / Line 34: @@
 === Example of a Method Call with the Framework Handler ===
-For the following advantage we assume that gsmd is enabled for the extension framework.  A pictorial representation of the framework is shown below.
+For the following advantage we assume that gsmd is enabled for the extension framework.  A pictorial representation of the method call is shown below.
 [[Image:Extensionframework_method.png]]
@@ Line 51: / Line 51: @@
 # The second relevant extension returns the values as per the first extension
 # The extension handler returns the final results in the reply to the calling method.  At this stage gsmd should use the parameters returned rather than those it had prior to the call for the purposes of dialing a number and sending/not sending caller ID.  It should also confirm that it is authorized to continue with the operation, and if not abort appropriately
 === Use Cases ===

← Older revision		Revision as of 11:04, 25 July 2007
Line 51:		Line 51:
	# The second relevant extension returns the values as per the first extension		# The second relevant extension returns the values as per the first extension
	# The extension handler returns the final results in the reply to the calling method. At this stage gsmd should use the parameters returned rather than those it had prior to the call for the purposes of dialing a number and sending/not sending caller ID. It should also confirm that it is authorized to continue with the operation, and if not abort appropriately		# The extension handler returns the final results in the reply to the calling method. At this stage gsmd should use the parameters returned rather than those it had prior to the call for the purposes of dialing a number and sending/not sending caller ID. It should also confirm that it is authorized to continue with the operation, and if not abort appropriately
		+
		+	=== Use Cases ===
		+
		+	There are a number of [[Wish List]] entries for which the extension framework could be used, these are as follows:
		+	#[[Wish List#Mask ID based on dialed numbers\|Mask outgoing caller ID based in dialed number]]
		+	#[[Wish List#Use calling cards and similar routing techniques for lower-cost calling\|Use calling cards and similar routing techniques for lower-cost calling]]
		+	#[[Wish List#Outgoing black/white lists\|Outgoing black/white lists]]
		+	#[[Wish List#Time-based blocking/unblocking of calls\|Time-based blocking/unblocking of calls]]

@@ Line 39: / Line 39: @@
 #As gsmd gets ready to make a 'phone call it reaches the stage where it has set up all of its parameters and is about to start the process of making a call.  It is at this point that the method call to the extension framework is made, by calling outgoingcall() with the following parameters:
-#* originalnumber: a string that contains the number that gsmd was planning to dial (populated with the number passed in to the function)
+#* number: a string that contains the number that gsmd was planning to dial (populated with the number passed in to the function)
-#* dialnumber: a string that contains the number that gsmd will dial on return (populated with the number passed in to the function)
+#* sendid: whether or not to send caller ID (as per system or user default)
 #* sendid: whether or not to send caller ID (as per system default)
 # When the extension handler receives this method it carries out a lookup of the extensions that are currently registered and active and puts together a list of which extensions should be contacted in which order.  In this case two extensions are returned as being interested in the information, along with the order in which they should be approached.
-# The first relevant extension is contacted and carries out its work.
+# The first relevant extension is contacted and carries out its work
-# The first relevant extension returns the parameters that it could change (dialnumber and sendid) and also two additional parameters: authorized and authreason.  These two parameters allow for any operation to be blocked by a suitable extension if required.  If the extension handler ever sees a return parameter stating that an operation is not authorized then it will immediately send a suitable reply to the calling method informing it of the lack of authorization along with a text string containing a message suitable to be displayed to an end user explaining why it was not authorized.
+# The first relevant extension returns the following values:
-# The second relevant extension is contacted and carries out its work.  Note that the parameters sent to this module include the updated dialnumber and sendid from the first relevant extension.
+#* number: a string that contains the new number to dial (which may be the same as the input number to dial)
-# The second relevant extension returns the parameters that it could change (dialnumber and sendid) and also the authorization parameters as above.
+#* sendid: whether or not to send caller ID
-# The extension handler returns the final results in the reply to the calling method.  At this stage gsmd should update its parameters and carry on with the process of making the call, possibly with different parameters than when it started.  It should also confirm that it is authorized to continue with the operation, and if not abort appropriately.
+#* authorized: if the action of making the call is authorized