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.
To obtain the latest stable releases you need to download
source packages from
the download section
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.
|JAVA_HOME||The home directory for JDK installation.||~/j2sdk1.4.0||c:\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.
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.
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.storetype||Specifies the type of client keystore. Not changed often.|
|jaxr-ebxml.security.keystore||Specifies 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.storepass||Specifies keystore password for the keystore file. Must be set by user.|
|jaxr-ebxml.security.alias||Specifies alias for the user's key within the client keystore file. Must be set by user.|
|jaxr-ebxml.security.keypass||Specifies key password for the users key in the client keystore. Set by user and used by unit tests.|
|UserAdmin.server.url||Specifies the URL to the ebXMl registry server used by UserAdmin tool.|
|UserAdmin.default.keystore.alias||Specifies the default alias used by UserAdmin tool.|
|jaxr-ebxml.tck.compatibilityMode||Turns ON special mode used when testing with JAXR TCK. Not used often.|
|jaxr-ebxml.registryBrowser.objectTypeCombo.initialFetchDepth||Used by Registry Browser to control the depth of fetch for initial objectType combo population.|
|jaxr-ebxml.registryBrowser.objectTypeCombo.initialSelectionIndex||Used by Registry Browser to specify the item in objectTypeCombo to be shown initially.|
|jaxr-ebxml.registryBrowser.ConceptsTreeModel.hiddenSchemesList||Used 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.|
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:
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).
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.
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.
The JAXR ebXML Provider comes with unit tests. To test the provider you must first set up your own private registry server. There is atest.system
target that will run JUnit tests on the provider.
Other Ant targets are also available. See thebuild.xml
file for more information. For example, there is ausage
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.
hhmts start Last modified: Tue Jul 23 17:57:08 PDT 2002 hhmts end