ebXML Registry Repository Client-Side Distribution

Note: Please perform installation steps for the server side installation Prior to performing the client side installation steps on this page. If you do not plan to setup your own registry then you must still download and unpack the server bundle because the client distribution requires several jars from the server distribution

When you unpack the client distribution do so in the same directory as the server distribution as the client and server unpack in different sub-directories.

Downloading the Required Files

To obtain the latest stable releases you need to download source packages from the download section :

  • Windows Platform: Download file ebxmlrr-client- <release_version> -src.zip and extract using WinZip utility.

  • Unix Platform: Download file ebxmlrr-client- <release_version> -src.tar.gz and extract using

    gunzip -c ebxmlrr-server- <release_version> -src.tar.gz
    | tar xvf -

The client source package requires dependent libraries that are provided with the server source package.

Binary packages are not available currently. However, the source distribution comes with all sources already built and ready to use.

Alternatively, you may check out the latest source tree from CVS repository . CVS checkout provides you with latest bug fixes and features. However latest CVS bits may be less stable than a packaged release.

Setting up environment variables



Variable
Description
Unix Example
Windows Example
JAVA_HOMEThe home directory for JDK installation.~/j2sdk1.4.0c:\j2sdk1.4.0

Make sure the Java runtime environment executable (e.g. <JAVA_HOME>/jre/bin/java.exe for Windows) and Java compiler executable (e.g. <JAVA_HOME>/bin/javac.exe for Windows) are in the environment variable PATH.

Configuration

Copy <jaxr>/jaxr-ebxml.properties.template into your home directory (e.g. C:\documents and settings\<username> in win2k) hereafter referred to as <user.home>, and rename as jaxr-ebxml.properties (remove .templates). <jaxr> is the root directory of the client software installation.

The file <user.home>/jaxr-ebxml.properties allows you to configure the ebxmlrr client software. The usage of the configuration properties are as follows. For the properties related to file path, use "/" as path separator in Windows.







Property
Description
jaxr-ebxml.home The home directory for storing run time file such as client keystore. By default, it is set to <user.home>/jaxr-ebxml if you keep this entry commented.

Note: Make sure you use forward slashes '/' as path separator on windows platform.

jaxr-ebxml.security.storetypeSpecifies the type of client keystore. Not changed often.
jaxr-ebxml.security.keystoreSpecifies the location of client keystore file. If relative then it is relative to location specified by jaxr-ebxml.home. Not changed often.
jaxr-ebxml.security.storepassSpecifies keystore password for the keystore file. Must be set by user.
jaxr-ebxml.security.aliasSpecifies alias for the user's key within the client keystore file. Must be set by user.
jaxr-ebxml.security.keypassSpecifies key password for the users key in the client keystore. Set by user and used by unit tests.
UserAdmin.server.urlSpecifies the URL to the ebXMl registry server used by UserAdmin tool.
UserAdmin.default.keystore.aliasSpecifies the default alias used by UserAdmin tool.
jaxr-ebxml.tck.compatibilityModeTurns ON special mode used when testing with JAXR TCK. Not used often.
jaxr-ebxml.registryBrowser.objectTypeCombo.initialFetchDepthUsed by Registry Browser to control the depth of fetch for initial objectType combo population.
jaxr-ebxml.registryBrowser.objectTypeCombo.initialSelectionIndexUsed by Registry Browser to specify the item in objectTypeCombo to be shown initially.
jaxr-ebxml.registryBrowser.ConceptsTreeModel.hiddenSchemesListUsed by Registry Browser to filter out specified ClassificationSchemes from ClassificationScheme dialog. Use this option if concerned that users may be seeing more schems than they need to.

Building From Source

The client distribution comes ready to run, with the software already compiled and packaged into jars. However, it can be built directly from the CVS repository or the source distribution using Apache ant as described next.

To build from source follow these steps:

  1. change current directory to <jaxr_home>.
  2. type "build compile". If you are using Unix/Linux and Korn shell is available, type "./build.sh instead". Also on Unix platforms you may need to make build.sh executable by typing "chmod 755 build.sh".
The source code will be compiled and the binary will be in <jaxr_home>/build/lib/classes.

Running the Registry Browser

Execute the

run.browser

Ant target in the ebxmlrr-client-<version> directory. For example:

% cd jaxr-ebxml/ebxmlrr-client-<version>

% ./build.sh run.browser (unix) or

% .\build.bat run.browser (windows).

Connecting to an ebXML Registry Server

To use the registry browser, you will need an ebXML Registry Server to connect to. Please see server setup documentation to set up your own private server. There is also a test ebXML registry at http://registry.csis.hku.hk:8201/ebxmlrr/registry/soap.

Performing User Registration

At this point you can do read-only operations with ebXML Registries. In order to be able to submite content, update content or remove content you must register yourself with the target ebXML Registry. The steps to perform user registration are described here.

Testing the JAXR ebXML Provider

The JAXR ebXML Provider comes with unit tests. To test the provider you must first set up your own private registry server. There is a

test.system

target that will run JUnit tests on the provider.

Miscellaneous Notes

Other Ant targets are also available. See the

build.xml

file for more information. For example, there is a

usage

target that prints out some other useful targets.

Certain JAXR ebXML provider properties can be customized by using a properties file. See the ebxmlrr-client- version /jaxr-ebxml.properties.template file for more information.

Feedback

Feedback is welcome. Questions or comments on this distribution can be posted to ebxmlrr-tech@lists.sourceforge.net. See this page for subscription information.

hhmts start Last modified: Tue Jul 23 17:57:08 PDT 2002 hhmts end