The jSyncManager Project

File Release Notes and Changelog

Release Name: v3.2 alpha 01

Notes:
The jSyncManager API v3. ALPHA 01 -- RELEASE NOTES
==================================================

Copyright (c) 2004 Brad BARCLAY <bbarclay@jsyncmanager.org>

Date:  20040527

Welcome to the jSyncManager API Release Notes.  This document contains 
important information on this release.  Please be sure to read it before 
attempting to use the files in this release.


CONTENTS
========

1.0      -- NOTICES
   1.1   -- How this Library is Licensed
   1.2   -- Software Status
   1.3   -- Contacting Us

2.0      -- USAGE NOTES
   2.1   -- Where to place this library
   2.2   -- How to develop code using this library
   2.3   -- Where to obtain documentation for this library
   2.4   -- Where to obtain source code for this library
   2.5   -- CVS tags for this library
   2.6   -- Dependencies
   2.7   -- Warning concerning retreival of handheld serial numbers.

A.0      -- APPENDICES
   A.1   -- Appendix 1 -- Acknowledgements


1.0 -- NOTICES
==============

1.1 -- How This Library is Licensed
-----------------------------------

These files are released under the GNU Lesser General Public License, 
version 2.1.  Please be aware of the following notice concerning this
software:

   The jSyncManager API
   Copyright (C) 1998 - 2003 Brad BARCLAY <bbarclay@jsyncmanager.org>

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Lesser General Public
   License as published by the Free Software Foundation; either
   version 2.1 of the License, or (at your option) any later version.

   This library is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
   Lesser General Public License for more details.

   You should have received a copy of the GNU Lesser General Public
   License along with this library; if not, write to the Free Software
   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

For full text of this license, please see:

         http://www.opensource.org/licenses/lgpl-license.php

1.2 -- Software Status
----------------------

   Please read the following section carefully:

   THIS SOFTWARE IS PRE-RELEASE ALPHA SOFTWARE.  IT HAS NOT BEEN
FULLY TESTED FOR DEFECTS, AND DOES NOT CONTAIN ALL THE FEATURES
PLANNED FOR THE FINAL RELEASE.  YOU USE THIS SOFTWARE COMPLETELY
AT YOUR OWN RISK.

1.3 -- Contacting Us
--------------------

Questions or comments concerning this library, its contents, or its license
should be directed to the jSyncManager team.  Here's how you can contact us 
online:

      E-Mail:     info@jsyncmanager.org
      Web:        http://www.jsyncmanager.org
      IRC:        irc://irc.sourceforge.net/jsyncmanager


2.0 -- USAGE NOTES
==================

2.1 -- Where to place this library
----------------------------------

This library implements the Java Languages "standard extension" feature. 
As such, you have two possible choices as to its location:

   i.    Place the library in the Java Standard Extension directory

         This library may be placed in the directory Java sets aside for the 
         storage of standard extensions.  Depending on your platform, this
         directory will typically be in your Java runtime directory as
         'lib/ext'.  Please see the release notes for your Java distribution 
         for more details.

   ii.   Place the library elsewhere, and add it to your CLASSPATH

         Please see the release notes for your Java distribution for more 
         information on adding a library to your CLASSPATH.


2.2   -- How to develop code using this library
-----------------------------------------------

To develop code using this library, a familiarity with Java software 
development is a must.  As well, it is suggested that you download the JavaDoc
documentation for this library, as it contains details and descriptions for 
every class, interface, method, and field accessible in this library.

Additionally, depending on what sort of code you're developing, you may 
require additional third-party libraries.  Please see section 2.6 below for 
details.


2.3 -- Where to obtain documentation for this library
-----------------------------------------------------

JavaDoc documentation in HTML format is available for this library.  Please 
visit http://sourceforge.net/projects/jsyncmanager to download this 
documentation as a JAR file.

Please be sure that the documentation package you download matches the version
of this library that you're developing for.


2.4 -- Where to obtain source code for this library
---------------------------------------------------

Source Code for this library is available from our project web site at 
http://sourceforge.net/projects/jsyncmanager.  This library's sources are 
released under the LGPL license -- please be sure to familiarize yourself with
its requirements before modifying the sources for this library.


2.5 -- CVS tags for this library
--------------------------------

Source code for this library is accessible via the Internet through the 
Concurrent Versions System (CVS).  For information on how to access this 
source repository, please visit:

         https://sourceforge.net/cvs/?group_id=63234

This library's sources are tagged as follows:   JSYNCMAN_API_3-2_alpha_01


2.6 -- Dependencies
-------------------

This library has several external dependencies -- some which are required, 
some which are optional depending on what type of code you're developing. 

   i.    REQUIRED:
      - The Core Java API v1.1 or higher (v1.3 recommended)

   ii.   OPTIONAL:
      - Java API for XML Processing
         -- http://java.sun.com/xml
         -- Required for the jSyncManager XML objects.

      - The Java Communications API (JCA)
         -- http://java.sun.com/products/javacomm/
         -- Required for access to serial based handheld docks and IR ports.

      - JDOM 

         -- http://www.jdom.org
         -- Required for use of the jSyncManager XML objects.

      - jUSB
         -- http://jusb.sourceforge.net
         -- Required for access to USB based handheld docks.

      - Java Mail API
         -- http://java.sun.com/products/javamail/
         -- Required for the Email jConduit.

      - JavaBeans Activation Framework (JAF)
         -- http://java.sun.com/beans/glasgow/jaf.html
         -- Required for the Email jConduit.


2.7 -- Warning concerning retreival of handheld serial numbers
--------------------------------------------------------------

The jSyncManager team has received reports from some developers that use of 
the org.jSyncManager.API.Conduit.ConduitHandler classes 
getDeviceSerialNumber() method may cause a handheld device to crash, requiring
a soft reset.  While this won't cause data loss on the handheld device, it 
does cause the synchronization process to abruptly end.

Due to the vaguirities and oddities as to how this information retreival 
works, and the nearly non-existant information available to debug the issue, 
as well as the inability of the jSyncManager team to reproduce this crash, we 
highly recommend testing the use of this method against the specific handhelds
you intend to use it with, whenever possible.  If not possible, we suggest 
avoiding using this method call until such time that a fix or work-around is 
available.


A.0 -- APPENDICES
=================

A.1 -- Appendix 1 -- Acknowledgements
-------------------------------------

The jSyncManager team would like to acknowledge the following individuals for 
their time and effort in contributing to the development of this library:

   Anuj AGRAWAL            <build@jsyncmanager.org>
   Brad BARCLAY            <bbarclay@jsyncmanager.org>
   Dave BARTMESS           <dbartmess@jsyncmanager.org>
   Jean-Fran‡ois EL FOULY  <jfelfouly@users.sourceforge.net>
   Per JOHANSSON           <hawklord@one.se>
   Michael REINSCH         <michael.reinsch@InnoviData.com>
   Bob YURKOVIC            <webmaster@jsyncmanager.org>

We'd also like to thank everyone who has taken the time to support our 
efforts.

Special thanks to the SourceForge team for providing the services necessary to
bring this project to the Open Source world.


Changes: