    Base OCF Reference Implementation  Changes for OCF version 1.1 Changes for OCF version 1.1.1

      Changes for OCF version 1.2 Configuration  OpenCard Home

Please read the License!

# Reference Implementation README

Since release 1.1 of the OpenCard Framework, the code making up the framework is organized in components. Each component is made up of one or more Java packages that provide a well-defined functionality to the application developer. To aid downloading, the components have been grouped together into installation packages.
In the OCF1.2 release an additional installation package was added: The BaseOCF package. This package contains the base-core and base-opt packages, which contain the fundamental OCF classes and which are the base that is needed in every OCF1.2 installation.

The contents of the OCF Reference Implementation installation package is described under Components. To learn about the remaining installation packages, read Installation.

Since it can be tedious to enter a large number of JAR files, each of which having a long file name, into the classpath, a tool has been provided that can repackage a selected set of JAR files into one target JAR file. This tool is described in Using the Rejar Tool.

## Components

The reference implementation contains source code, API documentation, and a JAR file for each component. The source code and API documentation is located under the components/<component name> directory, while the JAR files are located in the lib subdirectory. The component and corresponding JAR file names can be taken from the table below. Clicking on the component name will take you to the API documentation.

Component Names | Jar File Name
sb-demo | sb-demo.jar, sb-demo-ext.jar
reference-services | reference-services.jar
reference-terminals-windows | reference-terminals-windows.jar
gemplus-terminals | gemplus-terminals.jar
pcsc-wrapper-src | pcsc-wrapper-src.jar
migterminals | migterminals.jar
rejar-tool | rejar-tool.jar

## OCF Installation Packages

The installation packages were defined to satisfy the U.S. restrictions on export of cryptographic code as well to allow separation of proprietary code from the publically available reference implementation.

The installation packages build on one another to avoid duplicating code.

1. BaseOCF - contains the exportable (according to export restrictions) source and executable code of the OpenCard Framework owned by the OpenCard Framework consortium. This package is required by all other packages.
2. Reference Implementation - contains the exportable (according to export restrictions) source and executable code. This package is required by all other packages.
3. Reference Implementation U.S. Extension - contains reference implementation functionality that cannot be exported outside North America.

## Using the Rejar Tool

#### Intention

Including several Jar archives into the CLASSPATH variable can quickly become an error-prone and frustrating burden for the user. To ease this situation we provide this tool which allows to generate one big Jar archive from several smaller ones.
The need for such a tool arose because JDK's `jar` tool currently does not allow to modification of an existing Jar archive.

#### Usage

To start the tool type the following on the commandline:

      > java com.ibm.tools.rejar.ReJar <sourceJarArchiveDirectory> [<destJarArchive>]

(assuming your CLASSPATH variable contains the necessary classes) *. This will cause a window to appear offering you all the Jar archives that were found in `<sourceJarArchiveDirectory>`. From this list you may select the ones you want to put into your destination Jar archive. Do this by selecting the according archive with the mouse and pressing the `select` button. Undoing a selection works the same way apart from that you'll have to press the `deselect` button. You can determine the destination Jar archive in one of two ways. Either type its file name on the command line as the second argument or into the text field component of the ReJar main window labelled `new JAR file`. To start the repackaging process press the `create JAR file` button. To close the program press the `exit` button.
* If you are on a Windows platform and used one of the provided self-extracting archives you will find a `ReJarTool.bat` file in the deliverable's top directory that will start the tool.

This page was created by Scott Nicklous and Lothar Merk.