Distribution files
The BMC Network Automation Web Services JavaAPI is distributed in a single ZIP file that contains Javadoc documentation, the API .jar files, and other third-party .jar files on which the Web Services API relies. The Java classes have been compiled using JDK 1.8, and require JDK 1.8 or greater at run-time.
The contents of BCAN_HOME\public\bmc\bca-networks\extras\bcan-ws-clientapi-v.r.mm.zip are described in the following table:
File/Directory | Description |
|---|---|
apidocs/ | HTML-based Javadoc for the API. The index.html file located in this directory opens the main page of the Javadoc. The Javadoc covers the class files located in the files:
|
lib/ | Contains all the libraries needed for developing and running applications using the BMC Network Automation Web Services API. |
lib/bcan-dto-v.r.mm.jar | Contains class files for the BMC Data Transfer Objects (DTOs). The DTOs are lightweight containers used to pass data between the server and web services client. |
lib/bcan-shared-v.r.mm.jar | Contains utility classes and constant classes which are commonly needed by client web services. |
lib/bcan-ws-shared-v.r.mm.jar | Contains the shared interfaces for the client and server web services API. |
lib/bcan-ws-clientapi-v.r.mm.jar | Contains the client class files for the web services API. |
lib/* | The other files located in the lib directory are dependencies to the BMC Network Automation and Axis2 distribution and are needed to use the API to run web services applications. |
Related topics
General-API-classes-and-methods
Virtual-Data-Center-API-classes-and-methods