Changes between Version 1 and Version 2 of RpRepDeployment

Timestamp:

Sep 30, 2010, 9:24:51 PM (14 years ago)

Author:

s.meissner

Comment:

--

RpRepDeployment

@@ +1 @@
+= Resource Endpoint =
+
+=== role of Resource Endpoints ===
 The Resource Endpoint (REP) provides a standardised access to the sensors inside the test bed which are exposed as SENSEI Resources. The Resource Access Interface (RAI) is the standard RESTful interface provided to SENSEI users.
 
@@ -5 +8 @@
 Once a method on a Resource is called, the call will be translated into the proprietary call the sensor island gateway is able to handle. This Gateway inside the test bed will forward the call to the desired sensor. 
 
+== Resource Provider's efforts ==
 
-The REP is basically the adapter to the SENSEI system that needs to be implemented. The Java REP reference implementation provides some helpers to the Resource Providers. The stubs for RPI and RAI methods are given in the example code.
+The REP is basically the **adapter to the SENSEI system that needs to be implemented**. 
+The Java REP reference implementation provides some helpers to the Resource Providers. The stubs for RPI and RAI methods are given in the example code.
 
-RPI methods: 
-•       public List<String> publishResourceDescription(String descriptionString)
-•       public List<String> publishResourceDescription(ResourceDescription desc)
-•       public String updateResourceDescription(String resourceID, ResourceDescription description)
-•       public String deleteResourceDescription(List<String> resourceIDs)
+=== RPI methods: === 
+*       public List<String> publishResourceDescription(String descriptionString)
+*       public List<String> publishResourceDescription(ResourceDescription desc)
+*       public String updateResourceDescription(String resourceID, ResourceDescription description)
+*       public String deleteResourceDescription(List<String> resourceIDs)
 
-The RAI methods are provided by the RAIHandler that is attached to the REP. The RAIHandler is the Resource the REP exposes to the SENSEI Resource Users. In the example project a com.sensinode.sensei.rep.rest.test.SensorType.class is attached to the REP.
+=== Resource Access Interface ===
 
-SensorTypes' GET requests are handled by its method: 
-•       public Representation represent(Variant variant)
+The RAI methods are provided by the **RAIHandler** which is attached to the REP. The **RAIHandler** presents the Resource the REP exposes to the SENSEI Resource Users. In the example project a **com.sensinode.sensei.rep.rest.test.SensorType.class** is attached to the REP.
+
+=== RAI handler SensorType class explained ===
+
+'''GET''' requests are handled by its method: 
+*       public Representation represent(Variant variant)
 This method returns the Observation & Measurement value in XML/RDF format.
 
-POST requests are handled by:
-•       public void acceptRepresentation(Representation entity) 
+'''POST''' requests are handled by:
+*       public void acceptRepresentation(Representation entity) 
 
 The POST request is meant to be used to subscribe to sensor readings. A subscription needs to be sent in the POST body. The subscription handling is not yet standardised.
 
-The describeXXX methods in the SensorType class are used to create a WADL description of the Resource's RAI interface. In the currently used version of the Restlet framework the WADL support is not yet finalised, so that the WADL support cannot be guaranteed.  
+The '''describeXXX''' methods in the SensorType class are used to create a WADL description of the Resource's RAI interface. In the currently used version of the Restlet framework the WADL support is not yet finalised, so that the WADL support cannot be guaranteed.