=====================================
SCA BB Service Configuration Java API
=====================================
This file contains information about the Service Configuration Java API
distribution.


================
1. PREREQUISITES
================
+ This API can be used on Win32, Solaris and Linux platforms.
+ Compiling and running Java programs using this API requires JDK and JRE
versions 1.4 or 1.5.
NOTE: To be used with Java 1.5, a special JRE option needs to be set, as
explained below.


===============
2. INSTALLATION
===============
The Service Configuration Java API distribution is packaged in a TGZ file.

To install, unpack the TGZ file (keeping the folder structure) to a clean
folder.
+ On Win32 platforms, use any common windows compression utility to extract the
  file.
+ On Linux/Solaris platforms, use:
   'tar -xvfpz serviceconfig-java-api-dist.tgz'

The API should now be operational.


=======================
3. DISTRIBUTION CONTENT
=======================
<installdir> refers to the directory the distribution file was extracted to.

<installdir>
| README
|
+-doc
	serviceconfig-javadoc.zip
+-lib
    serviceconfigapi.jar
    jdmkrt.jar

The '<installdir>/lib' folder contains 'serviceconfigapi.jar' file, which is
the API library. It may also contains additional library JAR files which are
necessary for the API operation.
The '<installdir>/doc' folder contains the API Javadoc documentation.


========================
4. COMPILING AND RUNNING
========================
In order to compile and run a program that uses the Service Configuration Java
API, you need to have 'serviceconfigapi.jar' in your CLASSPATH.

For example, if your program source is in MyApiClass.java, your compilation 
command line should be:

#> javac -classpath .;<installdir>/lib/serviceconfigapi.jar MyApiClass.java

To run the program, the command line should be:

#> java -cp .;<installdir>/lib/serviceconfigapi.jar MyApiClass

NOTE: To use this API with Java 1.5, some library classes must precede JRE
classes in the boot classpath. To achieve this, add the following argument to
the 'java' command: '-Xbootclasspath/p:<installdir>/lib/jdmkrt.jar'.
For example:

#> java -Xbootclasspath/p:<installdir>/lib/jdmkrt.jar
        -cp .;<installdir>/lib/serviceconfigapi.jar MyApiClass

Don't forget to the replace '<installdir>' with the directory where the
distribution file was extracted to.


=================================
5. OBTAINING TECHNICAL ASSISTANCE
=================================
To obtain additional information about the Service Configuration API, and on
the SCA BB in general, please refer to the SCA BB User Guide and the SCA BB
Service Configuration Java API Reference documents.

To report problems, please use the Cisco TAC WEB site:

    http://www.cisco.com/tac

When reporting problems, please attach your program and any logs or
output dumps you may have.
