API tools faq
paste
Advertisement
Guest User

Funambol Sync Client ReadMe.txt

a guest
Dec 26th, 2011
722
0
Never
Add comment
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
text 10.23 KB | None | 0 0
raw download clone embed print report
  1. Funambol Sync Client for Android
  2. =================================
  3.  
  4. 1. Overview
  5. 2. Download
  6. 3. Build Requirements
  7. 4. Preparing the Build Environment
  8. 4.1 Windows
  9. 4.2 Linux
  10. 4.3 Mac OSX
  11. 5. Build and Install
  12. 6. Test
  13. 7. Eclipse and Netbeans IDE support
  14. 8. Known Issues
  15.  
  16.  
  17. 1. Overview
  18. -----------
  19.  
  20. Funambol Sync Client for Android is a client to synchronize PIM Data of Android
  21. devices with any SyncML aware server.
  22.  
  23. For the moment, it is an experimental project to explore the possibility of the
  24. new platform.
  25.  
  26. Currently you can synchronize contacts with the internal database of the
  27. Funambol server so you can exchange them with other devices or Thunderbird
  28. adressbook for example.
  29.  
  30. If you want to test without risk try the Android emulator shiped with the
  31. Android SDK.
  32.  
  33. For comments, bugreports or any other help you are very welcome. See
  34. https://android-client.forge.funambol.org/servlets/ProjectProcess?pageID=vSJyYt
  35.  
  36.  
  37. 2. Download
  38. -----------
  39.  
  40. Prebuild binaries and source archives are located here:
  41. https://android-client.forge.funambol.org/servlets/ProjectDocumentList
  42.  
  43. You can obtain the source code from subversion here:
  44. https://android-client.forge.funambol.org/svn/android-client/trunk/android-client
  45.  
  46. To access the subversion repository you need an account. You can create one by
  47. registering on this page:
  48. https://www.forge.funambol.org/servlets/Join
  49.  
  50.  
  51. 3. Build requirements
  52. ---------------------
  53.  
  54. - Sun Java 1.6 JDK
  55. http://java.sun.com/javase/downloads/index.jsp
  56. - Apache Ant
  57. http://ant.apache.org/bindownload.cgi
  58. - Ant-Contrib Tasks: http://ant-contrib.sourceforge.net/ (version 0.6)
  59. - JavaCC 4.0 (note that 4.1 does not work with J2ME)
  60. https://javacc.dev.java.net/files/documents/17/26777/javacc-4.0.zip
  61. - Android SDK r09
  62. http://developer.android.com/sdk
  63. - Subversion client
  64. http://subversion.tigris.org
  65.  
  66.  
  67. 4. Preparing the build environment
  68. ----------------------------------
  69.  
  70. Funambol Sync Client for Android builds on Windows, Linux and Mac OSX with any
  71. Android SDK from r09 or previous.
  72.  
  73. 4.1 Windows
  74. -----------
  75.  
  76. - Download and install Sun Java 1.6 JDK.
  77. Add the bin directory of the JDK to your path and create a new system
  78. variable JAVA_HOME pointing to the base directory of the JDK.
  79. For example:
  80. Add "C:\Program Files\Java\jdk_1.6.0_14\bin" to the path.
  81. Set JAVA_HOME to "C:\Program Files\Java\jdk_1.6.0_14".
  82.  
  83. - Download Apache Ant and unzip it to a directory of your choice.
  84. Add Ant's bin directory to your path and create a new system variable
  85. ANT_HOME.
  86. For example:
  87. Add "C:\Apps\ant\bin" to your path.
  88. Set ANT_HOME to "C:\Apps\ant".
  89.  
  90. You can now check your installation by opening a comand prompt and typing
  91. ant in any directory. You should get a message like:
  92. C:\> ant
  93. Buildfile: build.xml does not exist!
  94. Build failed
  95. Now check for the java compiler
  96. C:\> javac -version
  97. javac 1.6.0_14
  98. If you got anything else, check your path!
  99.  
  100. - Download and install version 0.6 of Ant-Contrib Tasks:
  101. http://ant-contrib.sourceforge.net/
  102. Copy your ant-contrib-0.6.jar to your $ANT_HOME/lib
  103.  
  104. - Download JavaCC 4.0 and unzip it to a directory of your choice.
  105. For example:
  106. c:\src\lib\javacc-4.0
  107.  
  108. - Download Android SDK and unzip it to a directory of your choice.
  109. For example:
  110. C:\src\lib\android-sdk-windows
  111.  
  112. - Start "Android SDK and AVD Manager" application, located under
  113. (installdir)/tools/android.bat and install, at least, "Android SDK
  114. Platform-tools" and "SDK Platform Android, 2.0" or above.
  115. You can add the platform-tools directory of the SDK to your path. This
  116. is not necessary for the build but it's easier to play with the emulator
  117. and related stuff.
  118. For example:
  119. Add "C:\src\lib\android-sdk-windows\platform-tools" to your path.
  120.  
  121. - If you want to compile a zipped source archive, you don't need subversion
  122. but you certainly want the newest stuff so...
  123. Download CollabNet Subversion Command-Line Client v1.6.2 from
  124. http://www.collab.net/downloads/subversion/
  125. If you don't like to sign in at CollabNet you can take the Silk SVN build from
  126. http://www.sliksvn.com/en/download
  127. Just run setup and your are done.
  128. If you like an Explorer integration you can additionally install
  129. TortuiseSVN from http://tortoisesvn.net/downloads
  130. Among other things it provides a command to apply patches from the context
  131. menu.
  132.  
  133. - Open a commandprompt and change to the directory where you want to store
  134. the sources and unzip the source archive or do a checkout from the
  135. repository.
  136. For example:
  137. C:\src>svn co https://android-client.forge.funambol.org/svn/android-client/trunk/android-client
  138. Change to the new directory, copy the build.properties.example to
  139. build.properties and edit the file to match your installation.
  140. For example:
  141. Change the line which contains sdk-folder to
  142. sdk-folder=C:/src/lib/android-sdk-windows-1.5_r2
  143.  
  144. Now you are ready to build.
  145.  
  146. 4.2 Linux
  147. ---------
  148.  
  149. Most Linux distributios provide a Java JDK, Subersion and Ant via it's own
  150. setup and software repository.
  151. On Ubuntu just type
  152. # apt-get install sun-java6-jdk ant ant-optional javacc subversion unzip
  153. to get the basic things.
  154.  
  155. - Download Android SDK and unzip it to a directory of your choice. If you
  156. have root access you can use /opt if not put it elsewhere in your homedir.
  157. You may want to add the tools directory to your path.
  158. For example:
  159. Add the following line to your .bashrc:
  160. export PATH=$PATH:/opt/android-sdk-linux_x86/platform-tools
  161.  
  162. - Start "Android SDK and AVD Manager" application, located under
  163. (installdir)/tools/android and install, at least, "Android SDK
  164. Platform-tools" and "SDK Platform Android, 2.0" or above.
  165.  
  166. - Open a terminal and change to the directory where you want to store
  167. the sources and unzip the source archive or do a checkout from the
  168. repository.
  169. For example:
  170. myhost:~/src/$ svn co https://android-client.forge.funambol.org/svn/android-client/trunk/android-client
  171. Change to the new directory and copy the build.properties.example to
  172. build.properties and edit the file to match your installation.
  173. For example:
  174. Change the line which contains sdk-folder to
  175. sdk-folder=/opt/android-sdk-linux_x86-1.5_r2
  176.  
  177. Now you are ready to build.
  178.  
  179. 4.3 Mac OSX
  180. -----------
  181.  
  182. Mac OSX Leopard ships with Java already installed It also has Ant
  183. and Subversion if you have XCode installed. If you miss subversion
  184. and don't like to install the big XCode Package, you can obtain
  185. subversion from
  186. http://www.open.collab.net/downloads/apple/download.html
  187. or install it via http://www.macports.org/ or
  188. http://finkproject.org/.
  189. This also applies to Ant.
  190.  
  191. - Download JavaCC 4.0 and unzip it to a directory of your choice.
  192. For example:
  193. ~\lib\javacc-4.0
  194.  
  195. The rest of the installation is the same as for Linux. Just press
  196. COMMAND-SPACE to start Spotlight and type Terminal to get a console.
  197. If you want root access type
  198. # sudo -i
  199. it's just unix...
  200.  
  201.  
  202. 5. Build and install
  203. --------------------
  204.  
  205. To build the software change to the source directory you checked out
  206. before. Then type:
  207. ant
  208. It runs the default target which is the same as typing
  209. ant debug
  210. It will build the Android application signed whith a debug key into
  211. bin/funambol-sync-client.apk
  212.  
  213. For an overview of availible targets type
  214. ant -p
  215.  
  216. You can build and upload to a running emulator or usb connected device with
  217. one command:
  218. ant install
  219.  
  220. If you have already installed the application before use
  221. ant reinstall
  222.  
  223. If you want to build from an IDE you have to take into account that there are
  224. two libraries the project depends on. The source is located under funambol_sdk
  225. and the compiled libraries are located in the external-libs directory. They can
  226. also build separately whith:
  227. ant funambol-sdk
  228.  
  229. To get logs from your connected device while running the software use the adb
  230. command from the tools directory of the sdk:
  231. adb logcat debug
  232.  
  233. Have Fun!
  234.  
  235.  
  236.  
  237.  
  238. 6. Test
  239. -------
  240.  
  241. To build the application with the Unit Test runner:
  242. ant test
  243.  
  244. To build the application with the Integration Test runner:
  245. ant autotest
  246.  
  247. To run Unit Test cases:
  248. ant run-unit-test
  249.  
  250. To run Integration Test cases:
  251. ant run-integration-test
  252.  
  253. To run both Unit and Integration Test cases:
  254. ant run-test
  255.  
  256. To specify the test script url add the following definition to the command line:
  257. -Dtest.script.url=http://url.to.script.com
  258.  
  259.  
  260. 7. Eclipse and Netbeans IDE support
  261. ---------------
  262.  
  263. It is possible to edit the Funambol Sync Client inside Eclipse or NetBeans
  264. IDE.
  265.  
  266. To create a valid Eclipse project, run:
  267. ant eclipse-project
  268. then, in a Eclipse configured for Android development, simply go to
  269. "File -> Import -> Existing project into Workspace" and select as root
  270. directory the directory where you stored the client source.
  271.  
  272. To create a valid Netbeans project, run:
  273. ant netbeans-project
  274. then, in a Netbeans configured for Android development, go to
  275. "File -> Open Project" and the directory where you stored the client source.
  276.  
  277.  
  278. 7. Known Issues
  279. ---------------
  280.  
  281. Using Funambol Sync Client for Android with any other server than Funambol
  282. Server may not work at current state and there is always a possibility that
  283. your data get accidentally modified or lost.
  284.  
  285. Issue: SC96:
  286. Can't choose sync source ID for contacts, calendar, etc
  287. https://android-client.forge.funambol.org/servlets/tracking?id=SC96
  288.  
  289. Issue: SC138
  290. first sync after an recover duplicates all contacts with groupdav connector
  291. https://android-client.forge.funambol.org/servlets/tracking?id=SC138
  292.  
  293. Issue: SC128
  294. Calendar has an issue with timezones so your appointments get moved by hours
  295. depending on the timezone offset between server and client.
  296. https://android-client.forge.funambol.org/servlets/tracking?id=SC128
  297.  
  298. This is not a complete list. There are other issues too!
  299. Check https://android-client.forge.funambol.org/servlets/tracking
  300. for details.
Advertisement
Add Comment
Please, Sign In to add comment
Advertisement
Public Pastes
Advertisement
We use cookies for various purposes including analytics. By continuing to use Pastebin, you agree to our use of cookies as described in the Cookies Policy.  OK, I Understand
Not a member of Pastebin yet?
Sign Up, it unlocks many cool features!