2008 Summer Project Week:XNATandXCEDE - Revision history

Blezek: /* REST interface */

2008-06-24T14:30:07Z

REST interface

2008-06-24T13:39:32Z

Detailed Project Goals

2008-06-24T13:33:42Z

Detailed Project Goals

2008-06-24T13:22:46Z

References

2008-06-23T16:49:36Z

References

2008-06-23T14:16:15Z

2008-06-19T16:47:20Z

Key Investigators

2008-06-19T16:45:15Z

← Older revision		Revision as of 14:30, 24 June 2008
Line 58:		Line 58:

	=== REST interface ===		=== REST interface ===
		+	[http://en.wikipedia.org/wiki/Representational_State_Transfer REST] is a simple idea: expose all your resources as URI's. The URI's are nouns, with 4 basic verbs that act on them.
		+
		+	{\| border="1" cellpadding="5"
		+	\|-style="background:#ebeced; color:black" align="left"
		+	! HTTP Method
		+	! CRUD concept
		+	! Usage
		+	\|-
		+	\| PUT
		+	\| Create
		+	\| Create a new instances of a resource. In some cases, the user can choose the URI, e.g. http://www.example.org/XCEDE/project/MyFancyProject, in other cases, the REST service chooses the URI, e.g. http://www.example.org/XCEDE/project which will create http://www.example.org/XCEDE/project/1 (then /2, /3, etc).
		+	\|-
		+	\| GET
		+	\| Read
		+	\| Fetch a representation of the resource. This will be XCEDE by default, generic [http://xstream.codehaus.org/ XStream] XML, and JSON provided as debug information.
		+	\|-
		+	\| POST
		+	\| Update
		+	\| POST can be thought of as '''append'''. If POST'ing to an existing URI, update the representation with the POST'ed data, returning the new representation.
		+	\|-
		+	\| DELETE
		+	\| Delete
		+	\| Obviously deletes a resource, if the user has privileges.
		+	\|}

	===References===		===References===

@@ Line 53: / Line 53: @@
 ** "curl" or "wget" will be sufficient.
 ** Most languages have some form of HTTP libraries, making them suitable client platforms.
+* Deployment
 === REST interface ===

← Older revision		Revision as of 13:33, 24 June 2008
Line 47:		Line 47:

	===Detailed Project Goals===		===Detailed Project Goals===
		+	* The XCEDE REST service shall implement the full XCEDE capabilities as a stand-alone application
		+	** When connected to a data service such as XNAT, it's functionality will replace the stand-alone app's, e.g. XCEDE will pass data query requests through to XNAT or perhaps to a DICOM QR provider.
		+	* Users, Roles and Permissions will be incorporated through the [http://www.jsecurity.org/ JSecurity] library. While user authentication will not be added in the first release, the scaffolding will be in place and authentication may be added where required.
		+	* Interaction with the REST interface will not require a sophisticated client.
		+	** "curl" or "wget" will be sufficient.
		+	** Most languages have some form of HTTP libraries, making them suitable client platforms.

		+
		+	=== REST interface ===

	===References===		===References===

← Older revision		Revision as of 16:49, 23 June 2008
Line 52:		Line 52:
	* XCEDE: http://www.xcede.org		* XCEDE: http://www.xcede.org
	* XNAT: http://www.xnat.org		* XNAT: http://www.xnat.org
		+	* [http://slicer.spl.harvard.edu/slicerWiki/index.php/Slicer3:XCEDE_use_cases#XCEDE_REST_Interface XCEDE use cases]

← Older revision		Revision as of 14:16, 23 June 2008
Line 45:		Line 45:

	</div>		</div>
		+
		+	===References===
		+
		+	* Sample grails-based excee interface: http://boggs.bwh.harvard.edu:8080/XCEDE/
		+	* Grails: http://www.grails.org
		+	* XCEDE: http://www.xcede.org
		+	* XNAT: http://www.xnat.org

@@ Line 28: / Line 28: @@
 <h1>Approach, Plan</h1>
 * Evaluate use cases for Slicer3
 * Work on design of XCEDE web services API to support these.
@@ Line 37: / Line 38: @@
 <h1>Progress</h1>
 A straw man REST interface to XCEDE has been implemented using Grails (Groovy on Rails). Grails is a rapid application development environment patterned after Rails (Ruby on Rails). Grails, however, is completely Java-based utilizing industry standard components (Spring, Hibernate, Groovy). In addition, Grails supports many of the common AJAX frameworks and can be compiled and deployed as a .war file.
 </div>

@@ Line 8: / Line 8: @@
 ===Key Investigators===
+* Dan M.
 <div style="margin: 20px;">