Programming with the Java API

Java API requirements

To build and run a  Java API program on either Windows or UNIX, you need the following environment components:

• J2SE Software Development Kit (SDK), version 8 (1.8.0_45) or higher
• Java API files:
  • arapiVerNum.jar
  • arjniVerNum.dll/libarjniVerNum.a
  • arjniVerNum.dll/libarjniVerNum.sl
  • arjniVerNum.dll/libarjniVerNum.so
  • arsys_sample.xml
  • log4j2.xml
  • arlogger-9.1.11-SNAPSHOT.jar

  • websvcjavaVerNum.jar
    
    

    Note

    If you are using the latest Java API, the arjni files are not required.

In these file names, the placeholder VerNum represents the version number of the release. In some cases, this includes a build number.  The  API OSGI bundle can be utilized in an OSGI deployment environment.

To write the Java program

Follow these steps to write the program:

1. Ensure your programming environment is set up correctly as described in the Java API requirements section above.
2. Create a Java project in your IDE.
3. Include the arapiVerNum.jar and the other required JAR files in the  API lib directory in the class path.
4. Create a new class for the methods that call the Java API.
5. Import the com.bmc.arsys.api package and other packages you might use in your program. The API uses collection classes, so you are likely to need java.util.ArrayList, java.util.List, and java.util.Map.
6. Instantiate an ARServerUser object. Set the user name, password, server, and other connection attributes. If the program needs to interact with different servers or as different users, it can create more than one ARServerUser object.
7. Use the ARServerUser.(login) method to open the connection to the server.
8. Perform the required operations using the ARServerUser methods and other API objects and methods to create, retrieve, update, and delete  objects as needed and creating criteria objects and using server object methods as required.
9. Use the ARServerUser.(logout) method to close the connection to the server.

For  Java API troubleshooting information, see Troubleshooting-the-Java-API.