Important

   

Starting version 8.9.03, BMC Network Automation is renamed to TrueSight Network Automation. This space contains information about BMC Network Automation 8.9.02 and previous versions. For TrueSight Network Automation 8.9.03 and later releases, see the TrueSight Network Automation documentation.

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.

Note

v.r.mm is a substitute for the current version of BMC Network Automation.

File/DirectoryDescription
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:

  • bcan-dto-v.r.mm.jar
  • bcan-shared-v.r.mm.jar
  • bcan-ws-shared-v.r.mm.jar

You must log on to access the Javadoc documentation.


lib/

Contains all the libraries needed for developing and running applications using the BMC Network Automation Web Services API.
This includes both library files generated by the system and other third-party libraries.

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.jarContains 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

Was this page helpful? Yes No Submitting... Thank you

Comments