rhoconnect 3.0.6 → 3.1.0.beta1

data/doc/deploying.txt

@@ -1,73 +1,4 @@
-Deploying a RhoConnect Application
-===
-
-Since RhoConnect applications are standard ruby [sinatra](http://www.sinatrarb.com/) applications, you have many hosting options.  This section will cover two ways to deploy a RhoConnect application: use the RhoHub service, deploy to an on-premise server.
-
-## Preparing App for Production
-By default your RhoConnect application generates a few files that you should be familiar with and understand the settings.
-
-### `config.ru`
-This rackup file contains runtime configuration for the RhoConnect sinatra application:
-	
-	:::ruby
-	Rhoconnect::Server.disable :run
-	Rhoconnect::Server.disable :clean_trace
-	Rhoconnect::Server.enable  :raise_errors
-	Rhoconnect::Server.set     :secret,      '<changeme>'
-	Rhoconnect::Server.set     :root,        ROOT_PATH
-	Rhoconnect::Server.use     Rack::Static, :urls => ["/data"], :root => Rhoconnect::Server.root
-	
-The important setting here `:secret` you will want to change.  `:secret` should be set to a long random string, it ___should not___ be set to a dictionary word or short string (30 characters or more is sufficient).  This is used for the session storage using a digest algorithm as described [here](http://guides.rubyonrails.org/security.html#session-storage).
-
-If you don't change the `:secret` setting, RhoConnect automatically warns you each time the application starts:
-
- 	[11:34:56 AM 2011-01-12] ************************************************************
-
-	[11:34:56 AM 2011-01-12] WARNING: Change the session secret in config.ru from <changeme> to something secure.
-	[11:34:56 AM 2011-01-12]   i.e. running `rake rhoconnect:secret` in your app will generate a secret you could use.
-
-	[11:34:56 AM 2011-01-12] ************************************************************
-	
-
-As this warning states, a good way to generate a cryptographically secure secret is by running `rake rhoconnect:secret` in your RhoConnect  application.
-
-	:::term
-	$ cd storemanager-server
-	$ rake rhoconnect:secret
-	040a2355475e9d0fb591ef78d5b9ca61a34cbcfd3f11942b18bc1d91f1ca66c27b2e0386333843a7efa29f40fff03624cd908d0883364ffbfa3208ab23fa2664
-	
-Then plug this secret into your `config.ru`:
-
-	:::ruby
-	Rhoconnect::Server.set     :secret, '040a2355475e9d0fb591ef78d5b9ca61a34cbcfd3f11942b18bc1d91f1ca66c27b2e0386333843a7efa29f40fff03624cd908d0883364ffbfa3208ab23fa2664'
-
-To run RhoConnect in production mode, use `RACK_ENV` environment variable set to "production".  This ensures RhoConnect will use the `:production` section of the settings.  For example:
-
-	:::term
-	$ thin start -e production -p 9292
-
-Will start thin in with `RACK_ENV` set to "production".  
-
-NOTE: If you deploy using passenger or on RhoHub, this variable is automatically set to production.
-
-### `settings/settings.yml`
-This file contains all source adapter options and settings like the redis server connection.  Before deploying to production, make sure you have the appropriate production settings:
-
-	:::yaml
-	:sources: 
-	  Product: 
-	    :poll_interval: 300
-
-	:production: 
-	  :redis: myredishost:6379
-	  :licensefile: settings/license.key
-	  :syncserver: http://localhost:9292/application/
-
-### `settings/license.key`
-This contains your RhoConnect license key text.  By default, a RhoConnect application comes with a 10 device license.  Please see the [licensing page](/rhoconnect/licensing) for more details.
-
-## Hosting on RhoHub
-The [RhoHub](/rhohub/introduction) service offers several [production RhoConnect application hosting levels](http://rhohub.com/pricing).  Simply sign up on [rhohub.com](http://rhohub.com/) and go through the [tutorial](/rhohub/tutorial) on deploying your first RhoConnect application with RhoHub.
+# Deploying a RhoConnect Application
 
 ## Deploying On-Premise
 The [sinatra book](http://sinatra-book.gittr.com/) has some great [deployment documentation](http://sinatra-book.gittr.com/#deployment) that you should review before running your RhoConnect application in production.

data/doc/hosting-rhohub.txt

@@ -0,0 +1,3 @@
+# Hosting on RhoHub
+
+The [RhoHub](/rhohub/introduction) service offers several [production RhoConnect application hosting levels](http://rhohub.com/pricing).  Simply sign up on [rhohub.com](http://rhohub.com/) and go through the [tutorial](/rhohub/tutorial) on deploying your first RhoConnect application with RhoHub.

data/doc/install.txt

@@ -1,27 +1,64 @@
-Installing RhoConnect
-===
+# Installing RhoConnect
+
+On Windows and Mac OS, the usual way to install RhoConnect is to install RhoStudio. 
+
+On Linux, you install the Rhodes gem from the command line; you can also do this from Windows or Mac OS.
+
+## Mac OS
+
+If you're running Mac OS, download the latest [RhoStudio for Macintosh](http://rhomobile.com/rhostudio-mac). This contains the [Ruby stack](http://www.ruby-lang.org/en/), [Redis](http://redis.io/), [RhoConnect](/rhoconnect/introduction) and [Rhodes](/rhodes/introduction).
+
+Click on the RhoStudioInstaller for Mac download file to open it. You will get a window similar to this:
+
+<img src="http://rhodocs.s3.amazonaws.com/rhodes-devel/rhostudio-mac-install.png" alt="RhoStudioInstaller Mac" />
+
+Run the install gems script appropriate for you. You can run "Install gems." If you have Ruby Version Manager, you can run "Install gems on rvm." A terminal window will open; wait for the gems install process to complete.
+
+Then drag RhoStudio to the Applications folder.
 
 ## Windows
 
-If you're running Windows, download the latest [RhoStudio for Windows](http://rhomobile.com/rhostudio-windows).  This installs the [Ruby stack](http://www.ruby-lang.org/en/), [Redis](http://redis.io/), [RhoConnect](/rhoconnect/introduction) and [Rhodes](/rhodes/introduction).
+If you're running Windows, download the latest [RhoStudio for Windows](http://rhomobile.com/rhostudio-windows). This installs the [Ruby stack](http://www.ruby-lang.org/en/), [Redis](http://redis.io/), [RhoConnect](/rhoconnect/introduction), and [Rhodes](/rhodes/introduction).
+
+If you are running Windows 64-bit, you need to have 64-bit Eclipse, and then you [install RhoStudio as a plugin for Eclipse](/rhodes/rhostudio-eclipse).
+
+## Java Development Kit (JDK)
 
-You can now skip to the [generating a new application instructions](/rhoconnect/command-line#generate-an-application) in the next section.
+You need to have the Java Development Kit (JDK) installed for RhoStudio. If you are planning to build for Blackberry or Android, make sure you have JDK version 1.6.0_2 or higher installed; the 32-bit Windows version of the JDK is required for Blackberry tools.
 
-## Mac OS / Linux
+### Installing the Java Development Kit
 
-### Prerequisites
+The Sun JDK for Windows or Linux is available [here](http://java.sun.com/javase/downloads/index.jsp). For Windows, install the 32-bit version of the JDK; RhoStudio needs the 32-bit version.
 
-1. [Ruby v1.8.7+](http://www.ruby-lang.org/en/downloads/)
+For Mac OS 10.6 and earlier, the JDK is already installed. For Mac OS 10.7, Java is not automatically installed. Download the Java for Mac Installer from [Apple support](http://support.apple.com/kb/DL1421) and install Java.
 
-2. [RubyGems v1.8.5+](http://rubygems.org/pages/download) 
+### Setting the JDK Path
 
-3. Ruby Web Server - We test with [thin](http://code.macournoyer.com/thin/), and [passenger](http://www.modrails.com/).  WEBrick, the web server that ships with ruby, is known to cause issues with HTTP headers/cookies and is ***not*** recommended.
+On Windows installs for RhoMobile, go to RhoStudio Preferences (Windows -> Preferences) and set the JDK path in the rhobuild.yml file. On Windows 64-bit installations, you must set this path to the 32-bit version of the JDK, such as `C:/Program Files (x86)/Java/jdk1.7.0_01/bin`.
 
-4. [Redis 2.4.x](http://redis.io/) - RhoConnect includes a simple [rake task](/rhoconnect/command-line#rake-tasks) `redis:install` to install redis, covered in the [Rake Tasks section](/rhoconnect/command-line#rake-tasks). Alternatively, you can [install redis directly](http://redis.io/download).
+On Mac OS, the path to the JDK is automatically set once Java is installed.
 
-### Installing RhoConnect Gem
+For non-RhoStudio installations, set the JDK path on the JAVA_HOME variable in your PATH.
 
-To install the RhoConnect gem, run:
+## Rhoconnect Gem for Linux and non-RhoStudio
+
+For Linux installations, and for Windows or Mac OS installations that are not using RhoStudio, you need to install the RhoConnect gem. Download and install:
+
+1. [Ruby v1.8.7+](http://www.ruby-lang.org/en/downloads/) (On Windows, [RubyInstaller](http://rubyinstaller.org) is a convenient way to install Ruby.)
+
+2. [RubyGems v1.8.5+](http://rubygems.org/pages/download) (RubyGems offers a .tgz, a .zip, and a .gem download. You want the .zip.) NOTE: Windows doesn't come with the necessary build tools to install gems ('make', for example). There are various ways to get these tools, but the GnuWin32 project at http://gnuwin32.sourceforge.net/ provides the tools, and can be conveniently installed via the GetGnuWin32 installer at http://sourceforge.net/projects/getgnuwin32/files/.
+
+3. Ruby Web Server - We tested with [thin](http://code.macournoyer.com/thin/), and [passenger](http://www.modrails.com/). WEBrick, the web server that ships with ruby, is known to cause issues with HTTP headers/cookies and is ***not*** recommended.
+
+4. [Redis 2.2.14+](http://redis.io/) - RhoConnect includes a simple [rake task](/rhoconnect/command-line#rake-tasks) `redis:install` to install redis, covered in the [Rake Tasks section](rhoconnect/command-line#rake-tasks). Alternatively, you can [install redis directly](http://redis.io/download).
+
+5. Install the RhoConnect Gem.
+
+Run this command to install.
 
 	:::term
-  	$ [sudo] gem install rhoconnect
+	$ [sudo] gem install rhoconnect
+
+NOTE: If you get any `no such file to load -- something` messages while running the rake tasks or rhodes commands, this can usually be resolved by putting "sudo" in front of the command, as in `sudo gem install something`.
+
+RhoSimulator, which comes with RhoStudio for Mac and Windows, does not work with Linux.

data/doc/java-plugin.txt

@@ -1,39 +1,86 @@
 RhoConnect-Java
 ===
 
-RhoConnect-Java library is designed for the [RhoConnect](http://rhomobile.com/products/rhoconnect/) App Integration Server.
+RhoConnect-Java library is designed for the [RhoConnect](http://rhomobile.com/products/rhoconnect/) Application Integration Server.
 
-Using the RhoConnect-Java plugin, your [Spting 3 MVC](http://www.springsource.org/) application's data will transparently synchronize with a mobile application built on the [Rhodes framework](http://rhomobile.com/products/rhodes), or any of the available [RhoConnect clients](http://rhomobile.com/products/rhoconnect/).
+Using the RhoConnect-Java plugin, your [Spring 3 MVC](http://www.springsource.org/) application's data will transparently synchronize with a mobile application built on the [Rhodes framework](http://rhomobile.com/products/rhodes), or any of the available [RhoConnect clients](http://rhomobile.com/products/rhoconnect/).
+
+## Prerequisites
+
+* Java (1.6)
+* Maven2 (2.2.1)
+* Git
+* [Rhoconncect-java](https://github.com/downloads/rhomobile/rhoconnect-java/rhoconnect-java-1.0-SNAPSHOT.jar) plugin jar file
 
 ## Getting started
 
 We assume that you have a complete java end-to-end application using Spring 3.0 MVC as the front end technology and Hibernate as backend ORM. For this application we will also use Maven2 for build and dependency management and some database to persist the data. The database is accessed by a Data Access (DAO) layer.
 
-For testing and evaluation purposes you can use [RhoconnectJavaSample](https://github.com/shurab/RhoconnectJavaSample) application as a starting point before continuing with the following steps.
+Copy [Rhoconncect-java](https://github.com/downloads/rhomobile/rhoconnect-java/rhoconnect-java-1.0-SNAPSHOT.jar) plugin jar file to your PC.
+You can also create target rhoconnect-java plugin jar from sources by cloning rhoconnect-java repository 
+
+    :::term
+    $ git clone git@github.com:rhomobile/rhoconnect-java.git
+
+and executing in cloned project directory the following commands:
+
+    :::term
+    $ mvn clean
+    $ mvn compile
+    $ mvn jar:jar
+
+The archived rhoconnect-java-x.y.z.jar file will be created in the project target/ directory.
+
+For testing and evaluation purposes you can use [RhoconnectJavaSample](https://github.com/shurab/RhoconnectJavaSample) application as a starting point before continuing with the following steps. 
 
 ### Adding Dependencies to Your Maven 2 Project
 
-Add dependencies to your Apache Maven 2 project object model (POM): apache common beanutils, and Jackson JSON mapper. In the RhoconnectJavaSample application, this code is in the pom.xml file.
+Add dependencies to your Apache Maven 2 project object model (POM): log4j, Apache common beanutils, and Jackson JSON mapper. In the RhoconnectJavaSample application, this code is in the pom.xml file.
 
     :::xml
-    <!-- apache commons beanutils -->  
-    <dependency>  
-        <groupId>commons-beanutils</groupId>  
-    	<artifactId>commons-beanutils</artifactId>  
-        <version>1.8.3</version>  
+    <!-- Log4j -->
+    <dependency>
+        <groupId>log4j</groupId>
+        <artifactId>log4j</artifactId>
+        <version>1.2.9</version>
+        <type>jar</type>
+        <optional>false</optional>
+    </dependency>
+    <!-- Apache Commons Beanutils and Jackson JSON Mapper required by rhoconnect-java plugin -->
+    <dependency>
+        <groupId>commons-beanutils</groupId>
+        <artifactId>commons-beanutils</artifactId>
+        <version>1.8.3</version>
     </dependency>
-    <!-- Jackson JSON Mapper -->  
     <dependency>  
         <groupId>org.codehaus.jackson</groupId>  
         <artifactId>jackson-mapper-asl</artifactId>  
         <version>1.9.0</version>  
         <type>jar</type>  
         <optional>false</optional>  
-    </dependency>  
+    </dependency>
+
+You must also add the rhoconnect-java jar to your Maven 2 project. At this moment rhoconnect-plugin jar is not available in Maven public repositories and you need install the jar manually into your Maven's local repository.
+Download the `rhoconnect-java-1.0-SNAPSHOT.jar` jar file and put it into your hard drive, and issue the following Maven's command:
+
+    :::term
+	$ mvn install:install-file -Dfile=/path-to-jar/rhoconnect-java-1.0-SNAPSHOT.jar -DgroupId=com.rhomobile.rhoconnect  -DartifactId=rhoconnect-java -Dversion=1.0-SNAPSHOT -Dpackaging=jar
+
+Now, the `rhoconnect-java` jar library is included into your Maven local repository.
+In the RhoconnectJavaSample application, you would add this code to the pom.xml file.
+
+    :::xml
+    <!-- Rhoconnect-java plugin -->
+	<dependency>
+    	<groupId>com.rhomobile.rhoconnect</groupId>
+    	<artifactId>rhoconnect-java</artifactId>
+    	<version>1.0-SNAPSHOT</version>
+    	<type>jar</type>
+	</dependency>
 
 ### Updating Your Servlet XML Configuration File
 
-Update your servlet xml configuration file to include rhoconnect-java metadata: the packages, converters, and beans. In the RhoconnectJavaSample, this code is in comments in the src/main/webapp/WEB-INF/spring-servlet.xml file.
+Update your servlet xml configuration file to include rhoconnect-java metadata: the packages, converters, and beans. In the RhoconnectJavaSample, the following code is added to src/main/webapp/WEB-INF/spring-servlet.xml file.
 
     :::xml
     <!-- rhoconnect-java plugin packages -->
@@ -49,14 +96,11 @@ Update your servlet xml configuration file to include rhoconnect-java metadata:
          	</list>
      	</property>
     </bean>
-
     <bean id="jsonConverter" class="org.springframework.http.converter.json.MappingJacksonHttpMessageConverter">
      	<property name="supportedMediaTypes" value="application/json" />
     </bean>
-
     <bean id="stringHttpMessageConverter" class="org.springframework.http.converter.StringHttpMessageConverter">
     </bean>
-    
     <bean id="restTemplate" class="org.springframework.web.client.RestTemplate">
      	<property name="messageConverters">
          	<list>
@@ -67,14 +111,16 @@ Update your servlet xml configuration file to include rhoconnect-java metadata:
     </bean>    
 
     <!-- rhoconnect-java plugin beans -->
-    <bean id="rhoconnect" class = "com.rhomobile.rhoconnect.RhoconnectImpl" />
-    
+    <bean id="dispatcher" class = "com.rhomobile.rhoconnect.RhoconnectDispatcher"></bean>
     <bean id="rhoconnectClient" class = "com.rhomobile.rhoconnect.RhoconnectClient" init-method="setAppEndpoint" >
      	<property name="restTemplate"><ref bean="restTemplate"/></property>
      	<property name="endpointUrl" value="your_rhoconnect_server_url" />
      	<property name="appEndpoint" value="your_spring_app_url" />
      	<property name="apiToken" value="rhoconnect_api_token" />
     </bean>
+    
+    <!--The following bean handles the application's authentication routine and should be implemented by you -->
+    <bean id="authenticate" class = "com.rhomobile.contact.ContactAuthenticate" />
 
 The `setAppEndpoint` method in the `rhoconnectClient` bean in the above code sample is a main point in establishing the communication 
 link between the `Rhoconnect` server and the Spring 3 MVC application. It has the following properties that you need to configure.
@@ -82,208 +128,202 @@ link between the `Rhoconnect` server and the Spring 3 MVC application. It has th
 <table border="1">
   <tr>
 	<td><code>endpointUrl</code></td>
-	<td>rhoconnect server's url, for example <code>http://localhost:9292</code>.</td>
+	<td>rhoconnect server's url, for example <code>http://localhost:9292</code></td>
   </tr>
   <tr>
 	<td><code>appEndpoint</code></td>
-	<td>your Spring 3 MVC app url, for example <code>http://localhost:8080/contacts</code>.</td>
+	<td>your Spring 3 MVC app url, for example <code>http://localhost:8080/contacts</code></td>
   </tr>
   <tr>
 	<td><code>apiToken</code></td>
-	<td>rhoconnect server's api_token, for example <code>sometokenforme</code>.</td>
+	<td>rhoconnect server's api_token, for example <code>sometokenforme</code></td>
   </tr>
 </table>
 
-
-### Adding rhoconnect-java to the Build Path
-
-You must add the rhoconnect-java jar to your apache maven 2 build classpath. In the RhoconnectJavaSample application, you would add this code to the pom.xml file, putting in the path to your rhoconnect-java jar into the systemPath.
-
-    :::xml
-    <dependency>
-        <groupId>rhoconnect-java</groupId>
-        <artifactId>rhoconnect-java</artifactId>
-        <version>0.0.1</version>
-        <scope>system</scope>
-        <!-- Set absolute path to your rhoconnect-java jar -->
-        <systemPath>/path-to-jar-directory/rhoconnect-java-0.0.1.jar</systemPath> 
-    </dependency>
-
-
-### Establishing communication from the RhoConnect server to java back-end application
-
-You need to establish communication from the RhoConnect instance to your java back-end application by implementing Rhoconnect interface.
+The `authenticate` bean will be called by rhoconnect server to authenticate users, and has to implement `Rhoconnect` interface provided by rhoconnect-java plugin: 
 
     :::java
     package com.rhomobile.rhoconnect;
     import java.util.Map;
 
     public interface Rhoconnect {
-        boolean authenticate(String login, String password, Map<String, Object> attribures);
-        
-        Map<String, Object> query_objects(String resource, String partition);
-        Integer create(String resource, String partition, Map<String, Object> attributes);
-        Integer update(String resource, String partition, Map<String, Object> attributes);
-        Integer delete(String resource, String partition, Map<String, Object> attributes);
+        boolean authenticate(String login, String password, Map<String, Object> attributes);    
     }
 
-For example, `RhoconnectJavaSample` application implementation is based on `contactService` API:
+For example:
 
     :::java
-    /**
-    * RhoconnectImpl.java 
-    */
-    package com.rhomobile.rhoconnect;
+    package com.rhomobile.contact;
 
-    import java.util.HashMap;
-    import java.util.Iterator;
-    import java.util.List;
     import java.util.Map;
+    import org.apache.log4j.Logger;
+    import com.rhomobile.rhoconnect.Rhoconnect;
 
-    import org.apache.commons.beanutils.BeanUtils;
-    import org.springframework.beans.factory.annotation.Autowired;
-
-    import com.rhomobile.contact.form.Contact;
-    import com.rhomobile.contact.service.ContactService;
-
-    public class RhoconnectImpl implements Rhoconnect {
-
-        @Autowired
-        private ContactService contactService;	
+    public class ContactAuthenticate implements Rhoconnect {
+        private static final Logger logger = Logger.getLogger(ContactAuthenticate.class);
 
         @Override
-        public boolean authenticate(String login, String password, Map<String, Object> attribures) {
+        public boolean authenticate(String login, String password, Map<String, Object> attributes) {
+            logger.info("ContactAuthenticate#authenticate: implement your authentication code!");
             // TODO: your authentication code goes here ...
             return true;
         }
-	
-        @Override
-        public Map<String, Object> query_objects(String resource, String partition) {
-            Map<String, Object> h = new HashMap<String, Object>();
-            List<Contact> contacts =  contactService.listContact();		
-            Iterator<Contact> it = contacts.iterator( );
-            while(it.hasNext()) {
-                Contact c =(Contact)it.next();
-          	    h.put(c.getId().toString(), c);
-            }
-            return h;
-        }
-
-        @Override
-        public Integer create(String resource, String partition, Map<String, Object> attributes) {
-            Contact contact = new Contact();
-            try {
-                BeanUtils.populate(contact, attributes);
-                int id = contactService.addContact(contact);
-                return id;
-            } catch(Exception e) {
-                e.printStackTrace();
-            }
-            return null;
-        }
-
-        @Override
-        public Integer update(String resource, String partition, Map<String, Object> attributes) {
-            Integer id = Integer.parseInt((String)attributes.get("id"));
-            Contact contact = contactService.getContact(id);
-            try {
-                BeanUtils.populate(contact, attributes);
-    		    contactService.updateContact(contact);
-    		    return id;
-            } catch(Exception e) {
-                e.printStackTrace();
-            }
-            return null;
-        }
-
-        @Override
-        public Integer delete(String resource, String partition, Map<String, Object> attributes) {
-            String objId = (String)attributes.get("id");
-            Integer id = Integer.parseInt(objId);
-            contactService.removeContact(id);		
-            return id;
-        }
     }
 
-### Establishing communication from java back-end application to the RhoConnect server
-
-You also must to establish the communication from your java back-end application to the RhoConnect instance by autowiring your data access (DAO) service layer with RhoconnectClient bean and inserting notifications hooks there.
-
-    :::java
-    package com.rhomobile.rhoconnect;
-    
-    public class RhoconnectClient {
-        // ...
-        public boolean notifyOnCreate(String sourceName, String partition, Object objId, Object object);
-        public boolean notifyOnUpdate(String sourceName, String partition, Object objId, Object object);
-        public boolean notifyOnDelete(String sourceName, String partition, Object objId);
-        // ...
-    }
+### Establishing communication from the RhoConnect server to java back-end application
 
-For example, `RhoconnectJavaSample` application uses the following implementation:
+You need to establish communication from the RhoConnect instance to your java back-end application by mixing RhoconnectResource interface in your data access (DAO) service class:
 
     :::java
-    package com.rhomobile.contact.service;
-    import java.util.List;
-
-    import org.springframework.beans.factory.annotation.Autowired;
-    import org.springframework.stereotype.Service;
-    import org.springframework.transaction.annotation.Transactional;
+	package com.rhomobile.rhoconnect;
 
-    import com.rhomobile.contact.dao.ContactDAO;
-    import com.rhomobile.contact.form.Contact;
+	import java.util.Map;
 
-    import com.rhomobile.rhoconnect.RhoconnectClient;
-    //import org.apache.log4j.Logger;
+	public interface RhoconnectResource {
+		Map<String, Object> rhoconnectQuery(String partition);
+		Integer rhoconnectCreate(String partition, Map<String, Object> attributes);
+		Integer rhoconnectUpdate(String partition, Map<String, Object> attributes);
+		Integer rhoconnetDelete(String partition, Map<String, Object> attributes);
+		String getPartition();
+	}
 
-    @Service
-    public class ContactServiceImpl implements ContactService {
+To help rhoconnect-java plugin correctly do mapping of model name to service bean you should take into account the following conventions:
 
-        @Autowired
-        private ContactDAO contactDAO;
-
-        @Autowired
-        private RhoconnectClient client;
-
-        //private static final Logger logger = Logger.getLogger(ContactServiceImpl.class);
-
-        private static final String sourceName  = "Contact"; // name of DAO model
-        
-        // Data partitioning: i.e. your user name for filtering data on per user basis 
-        private static final String partition  = "your_partition";
-	
-        @Transactional
-        public int addContact(Contact contact) {
-            int id = contactDAO.addContact(contact);
-            client.notifyOnCreate(sourceName, partition, Integer.toString(id), contact);
-            return id;
-        }
+* Name of the DAO service bean (class) should be model name followed by `ServiceImpl` suffix (i. e. `ContactServiceImpl` for model `Contact`)  
+* Service bean should be auto-wired into corresponding controller via @Autowired annotation 
 
-        @Transactional
-        public void updateContact(Contact contact) {
-            contactDAO.updateContact(contact);
-            client.notifyOnUpdate(sourceName, partition, Integer.toString(contact.getId()), contact);		
-        }
+Data partitioning in your code should be based on filtering data for unique user (i.e. your user name) or per application (shared dataset for all users).
+For more information about RhoConnect partitions, please refer to the [RhoConnect docs](http://docs.rhomobile.com/rhosync/source-adapters#data-partitioning).
 
-        @Transactional
-        public void removeContact(Integer id) {
-            contactDAO.removeContact(id);
-            client.notifyOnDelete(sourceName, partition, Integer.toString(id));
-        }
+### Establishing communication from java back-end application to the RhoConnect server
 
-        @Transactional
-        public List<Contact> listContact() {
-            return contactDAO.listContact();
-        }
+You also must to establish the communication from your java back-end application to the RhoConnect instance by auto-wiring `RhoconnectClient` bean into your DAO service class and inserting notifications hooks into data access (create/update/delete) methods. 
+`RhoconnectClient` bean is provided by rhoconnect-java plugin and responds to the following methods you have to call:
 
-        @Transactional
-        public Contact getContact(Integer id) {
-            return contactDAO.getContact(id);
-        }
-     }
+* boolean notifyOnCreate(String sourceName, String partition, Object objId, Object object)
+* boolean notifyOnUpdate(String sourceName, String partition, Object objId, Object object)
+* boolean notifyOnDelete(String sourceName, String partition, Object objId)
 
-For more information about RhoConnect partitions, please refer to the [RhoConnect docs](http://docs.rhomobile.com/rhosync/source-adapters#data-partitioning).
+Example for `RhoconnectJavaSample` application:
 
+    :::java
+	package com.rhomobile.contact.service;
+
+	import java.util.HashMap;
+	import java.util.Iterator;
+	import java.util.List;
+	import java.util.Map;
+
+	import org.apache.commons.beanutils.BeanUtils;
+	import org.springframework.beans.factory.annotation.Autowired;
+	import org.springframework.stereotype.Service;
+	import org.springframework.transaction.annotation.Transactional;
+
+	import com.rhomobile.contact.dao.ContactDAO;
+	import com.rhomobile.contact.form.Contact;
+
+	import com.rhomobile.rhoconnect.RhoconnectClient;
+	import com.rhomobile.rhoconnect.RhoconnectResource;
+
+	@Service
+	public class ContactServiceImpl implements ContactService, RhoconnectResource {
+	    //private static final Logger logger = Logger.getLogger(ContactServiceImpl.class);
+
+	    @Autowired
+	    private ContactDAO contactDAO;
+	    @Autowired
+	    private RhoconnectClient client;
+	    private static final String sourceName  = "Contact"; // name of DAO model
+
+	    @Transactional
+	    public int addContact(Contact contact) {
+	        int id = contactDAO.addContact(contact);
+	        client.notifyOnCreate(sourceName, getPartition(), Integer.toString(id), contact);
+	        return id;
+	    }
+
+	    @Transactional
+	    public void updateContact(Contact contact) {
+	        contactDAO.updateContact(contact);
+	        client.notifyOnUpdate(sourceName, getPartition(), Integer.toString(contact.getId()), contact);       
+	    }
+
+	    @Transactional
+	    public void removeContact(Integer id) {
+	        contactDAO.removeContact(id);
+	        client.notifyOnDelete(sourceName, getPartition(), Integer.toString(id));
+	    }
+
+	    @Transactional
+	    public List<Contact> listContact() {
+	        return contactDAO.listContact();
+	    }
+
+	    @Transactional
+	    public Contact getContact(Integer id) {
+	        return contactDAO.getContact(id);
+	    }
+
+	    @Override
+	    @Transactional
+	    public Map<String, Object> rhoconnectQuery(String partition) {
+	        Map<String, Object> h = new HashMap<String, Object>();
+	        List<Contact> contacts =  listContact();
+
+	        Iterator<Contact> it = contacts.iterator( );
+	        while(it.hasNext()) {
+	            Contact c =(Contact)it.next();
+	            h.put(c.getId().toString(), c);
+	        }
+	        return h;
+	    }
+
+	    @Override
+	    @Transactional
+	    public Integer rhoconnectCreate(String partition, Map<String, Object> attributes) {
+	        Contact contact = new Contact();
+	        try {
+	            BeanUtils.populate(contact, attributes);
+	            int id = addContact(contact);
+	            return id;
+	        } catch(Exception e) {
+	            e.printStackTrace();
+	        }
+	        return null;
+	    }
+
+	    @Override
+	    @Transactional
+		public Integer rhoconnectUpdate(String partition, Map<String, Object> attributes) {
+	        Integer id = Integer.parseInt((String)attributes.get("id"));
+	        Contact contact = getContact(id);
+	        try {
+	            BeanUtils.populate(contact, attributes);
+	            updateContact(contact);
+	            return id;
+	        } catch(Exception e) {
+	            e.printStackTrace();
+	        }
+	        return null;
+	    }
+
+	    @Override
+	    @Transactional
+	    public Integer rhoconnetDelete(String partition, Map<String, Object> attributes) {
+	        String objId = (String)attributes.get("id");
+	        Integer id = Integer.parseInt(objId);
+	        removeContact(id);       
+	        return id;
+	    }
+
+	    @Override
+	    public String getPartition() {
+	        // Data partitioning: i.e. your user name for filtering data on per user basis 
+	        return "alexb";
+	    }
+	 }
+
+Click [here](https://github.com/shurab/RhoconnectJavaPluginDemo) to download full source code of Contact manager application with rhoconnect-java plugin.
 
 ## Meta
 Created and maintained by Alexander Babichev.