ODMJNI100-0.58beta.txt 0.02 UTF-8 dh:2007-04-10 ODMJNI 1.0 RUNTIME PACKAGE ODMJNI 1.0 ODMJNI100-0.58beta.zip ARCHIVE CONTENT ================================================= The Zip archive includes the runtime components for distribution with an ODMA-aware Java application. These components are intended to be installed in the same folder as the Java application and included in its classpath. There is also an optional component that can be distributed for verification and troubleshooting of correct configuration. The 0.58beta distribution which provides ODMJNI100-0.58beta.zip is available at . Consult that page for the latest status and for links to important related material. If there is any concern for the authenticity of the .zip archive and its content, obtain a full replacement copy from the above 0.58beta page on the ODMA Interoperability Exchange site, http://ODMA.info. The software in this Zip archive is released under the Open Document Management API License 1.0, an open- source software license using the BSD template license. A copy of the license should accompany the computer software that is contained in the Zip archive. If the license has been separated from the material, obtain a copy at . CONTENT 1. Prerequisites 1.1 For redistribution with application programs 1.2 For development of ODMA-aware Java-based application programs 1.3 For development of the ODMJNI 1.0 runtime redistributables 2. Manifest 2.1 Archive contents 2.2 Runtime 2.3 Configuration Test 2.4 Additional Files 3. Dependencies 3.1 Java runtime environment 3.2 ODMA Connection Manager and default DMS 4. Tools Required 4.1 Packaging for Application Deployment 4.2 Usage in Application Development 4.3 Usage in ODMJNI Software 1. PREREQUISITES 1.1 For Redistribution with Application Programs This software is intended for deployment as part of an ODMA-aware Java application that makes use of ODMA 1.0 packages info/odma/practical100 and info/odma/odmjni100. You must be able to create your own installers and deployment packages that incorporate the ODMJNI100.jar and odmjni100.dll files in the same directory as the application's executable Java application file. You must be able to use the Jar tool to add ODMJNI100.jar to the Class-Path descriptor in the manifest of the executable Java application file. (The Clicker.jar confirmation program is an example of how this is done.) You must be prepared to provide instructions on how the user or an administrator of the application can confirm the installed configuration, the availability of an ODMA Connection Manager, and the availability of a default ODMA Document Management System (DMS) integration for use with the application. Information on troubleshooting operation between the application, the ODMA Connection Manager (and its logs), and the DMS should be available in some form. 1.2 For Development of ODMA-aware Java-based Application Programs The included Clicker.jar, ODMJNI100.jar and odmjni100.dll are usable in the development of ODMA-aware Java application programs. They can be used exactly as they would be installed along with the application's executable Jar file. This is important for integration testing of the application program when verifying deployment and installer functions. To use the runtime during unit test and initial development of the application, you must also know how to add ODMJNI100.jar to the class- path of the java compiler and the java runtime environment. The odmjni100.dll must be added to the library path of the java runtime environment when it is not in the same directory as a Jar file that is being executed as the application. Examples of this usage are found in the source-code development tree for the ODMA 1.0 0.58beta info/odma/odmjni100 package and its test programs. 1.3 For Development of the ODMJNI 1.0 Runtime Redistributables The prerequisites for replication and development of the runtime are those that apply to the d061101n-odmjni100-0.58beta.zip updates for the ODMJNI 1.0 development code tree. This includes installation of the 0.50beta baseline distribution and application of the 0.52, 0.54, 0.56, 0.57 and 0.58beta update distributions. These are all available via links at . 2. MANIFEST 2.1 Archive Contents This is a self-contained Zip-format archive. The archive contains the following files: ODMJNI100-0.58beta.zip/ 0.02 archive for the runtime components, 2007-04-10-15:31 Clicker.jar 0.05 optional confirmation program for verifying the operation of ODMJNI100.jar and odmjni100.dll from this archive, 57,032 byte file dated 2007-04-10-12:33 Clicker.txt 0.05 narrative manifest for Clicker.jar 13,271 byte file dated 2007-04-10-12:32 License.txt 0.00 based on Open Document Management License 1.0 (modified BSD license), 3,839 byte file dated 2007-04-09-16:26 ODMJNI100-0.58beta.txt 0.01 narrative manifest (this file) describing the content of the archive, 12,517 byte file dated 2007-04-10-15:30 ODMJNI100.jar 0.02 ODMJNI 1.0 0.58beta Java packages info.odma.practical100 framework and the info.odma.odmjni100 implementations, 21,941 byte file dated 2007-04-10-11:41 ODMJNI100.txt 0.02 narrative manifest of ODMJNI100.jar 7,089 byte file dated 2007-04-10-11:40 odmjni100.dll 0.20 native-method implementations for info.odma.odmjni100 package classes, 81,920 byte file dated 2007-03-27-23:32 2.2 Runtime The runtime elements consist of the two binary files ODMJNI100.jar and odmjni100.dll. These two files are required for delivering ODMA 1.0 functionality to an ODMA-aware Java-based application. The file ODMJNI100.txt provides a narrative manifest for those files and their configuration and installation. The ideal installation is in the same folder with the .jar file of the Java application. ODMJNI100.txt describes the configuration options. 2.3 Configuration Test The file Clicker.jar consists of a simple application that can be installed alongside the runtime elements to confirm configuration. The file Clicker.txt provides a narrative manifest for Clicker.jar and its usage. Clicker.jar may also be installed alongside the runtime if the application program does not confirm ODMJNI100 connection and operation as part of its own installation and configuration. 2.4 Additional Files The License.txt file describes the license that applies to the runtime files, including location of the available source code. Each of Clicker.jar and ODMJNI100.jar include copies of their own license and of their narrative manifest. It is not necessary to include the ODMJNI100-0.58beta.zip license when the Jar components are distributed individually in the packaging of an application. Similarly, this ODMJNI100-0.58beta.txt file need not be redistributed when the runtime files are extracted for redistribution individually. 3. DEPENDENCIES 3.1 Java Runtime Environment Operation of the runtime requires a Java Runtime Environment (JRE) installed on your computer. The runtime requires an x86 implementation of Java running on Windows 2000 or later. JRE 1.4.4 or later should be used. The Java Runtime Environment installation bin/ directory is expected to provide the jawt.dll and awt.dll files needed for use of the runtime and ODMA from a Java GUI application. The code in this package was developed and confirmed with Sun Java 2 JDK version 1.5.0_09. Additional information about the dependencies of the runtime is provided with the ODMJNI100.txt narrative manifest. 3.2 ODMA Connection Manager and Default DMS In order to connect to ODMA, there must be an installed ODMA Connection Manager Odma32.dll (ODMA 2.0 version preferred). The runtime will automatically provide ODMA 1.0 null behavior if no ODMA Connection Manager is available. In order to operate with an ODMA DMS there must be a global-default DMS or else the ODMA Application ID "OdmNativeTest" must have a default DMS assigned for use. 4. TOOLS REQUIRED 4.1 Packaging for Application Deployment To incorporate the runtime in the deployment of a Java-based application, the following tools are required: Internet Connection and Browser for download of the archive Zip-format archive access utility for extraction of the runtime components for redistribution Java-deployment and/or Windows-installer creation software for delivering the runtime along with the Java application software 4.2 Usage in Application Development In addition to the deployment packaging capability, there must be tools for Java development on an Intel x86 Microsoft Windows platform. Use Microsoft Windows 2000 or a later version (XP SP2 or Vista). 4.3 Usage in Development of ODMJNI Software See the tool recommendations for working with the 0.58beta developer- tree source-code downloads and the prerequisite downloads for using that program code and its test programs. - - - - - - - - - - - - - - - - - - | - - - - - - - - - - - - - - - - - - Questions, comments, discussion and feedback about ODMA concepts, status, and materials are welcome. Please send comments to the discussion list at . For further details visit . Copyright © 2007 NuovoDoc This work is licensed under the Creative Commons Attribution License. To view a copy of this license, visit web site http://creativecommons.org/licenses/by/2.5/ or send a letter to Creative Commons, 559 Nathan Abbott Way, Stanford, California 94305, USA. Attributions can be made in any suitable scholarly-citation format. It is requested that citations identify the material sufficiently for others to independently locate the material. This citation example can be adapted to your purpose and format: Hamilton, Dennis E. ODMJNI 1.0 ODMJNI100-0.58beta.zip Archive Content. ODMA Inter- operability Exchange, version 0.02, April 10, 2007. Current version available as part of the runtime distribution package downloadable at . - - - - - - - - - - - - - - - - - - | - - - - - - - - - - - - - - - - - - 0.02 2007-04-10-15:26 Adjusted package material for distribution as the first-available release of the ODMJNI100-0.58beta.zip runtime. 0.01 2007-04-09-21:29 Update with manifest information for the released versions. 0.00 2007-04-09-16:02 Placeholder customized enough for use during check- out of the Zip construction procedure. $Header: /ODMdev/info/odma/OdmDeploy100/ODMJNI100-0.58beta.txt 4 07-04-10 15:30 Orcmid $ *** end of ODMJNI100-0.58beta.txt ***