See: Description
See: Description
The Java API is a collection of classes, interfaces, and relationships that provide full client functionality like the AR System C API in a style consistent with typical Java programming techniques. Like the C API, the Java API is forward and backward compatible with other versions of AR System. See the Integrating section in the AR System documentation for information about setting up to use the Java API.
For product related issues or questions, contact Customer Support by e-mail at customer_support@bmc.com.
Consistent with object-oriented design, the AR System Java API represents AR System server objects as Java objects. Classes are defined for forms, fields, menus, active link, filter, escalations, and all other objects in an AR System application. Entry objects represent entries (requests) so your Java client can manipulate AR System data as well as definitions.
The following paragraphs summarize the key classes and types of classes in the API. Click the links for details.
The ARServerUser object represents the connection between your Java client program and the AR System server. It include session information such as user name, password, and server. A typical program starts by creating an ARServerUser object with user name, password, server name, and the like. Using the ARServerUser instance methods, it logs in to the AR System server; creates, gets, searches for, updates, and deletes server objects; and log out. A call to a get method returns a server object, a call to a getList (search) methods return a list of object identities (for example, names for forms or IDs for fields), and a call to a getListObjects method returns a list of objects.
The Java API includes classes for all server objects: Form, Field, View, ActiveLink, Escalation, Filter, Container, Menu, Entry, and SupportFile. The Form, Field, Container, and Menu classes have subclasses to represent specialized types, for example, RegularForm, IntegerField, ApplicationContainer, and SqlMenu.
The ARServerUser create methods create these objects. The get and getListObjects methods return them. Each set method takes a server object parameter that specifies which object the server should update. For example, the ARServerUser method setField takes a Field parameter.
Objects in the AR System Java API are cloneable. The clone() method performs a deep copy of the object. A deep copy is a copy of an object that contains the complete encapsulated data of the original object, allowing it to be used independently of the original Java object. Of course, if the original Java object represents an AR System server object, the clone represent the same object.
Errors are modeled through the ARException class. All error messages that are returned by the server are thrown as an ARException in the Java API.
The following methods are added in release 8.8:
| Method | Description |
void setEndClientIPAddress(String) |
New method introduced to supply end client IP address to API Monitoring feature.
The API monitoring services monitors the client information and the bytes coming in and going out as part of any API call on an hourly basis. |
| String getEndClientIPAddress() |
Get the end client IP address |
BMC, BMC Software, and the BMC Software logo are the exclusive properties of BMC Software, Inc., are registered with the U.S. Patent and Trademark Office, and may be registered or pending registration in other countries. All other BMC trademarks, service marks, and logos may be registered or pending registration in the U.S. or in other countries. All other trademarks or registered trademarks are the property of their respective owners.
DB2 is a registered trademark of International Business Machines Corporation.
IBM is a registered trademark of International Business Machines Corporation.
ITIL is a registered trademark, and a registered community trademark of the Office of Government Commerce, and is registered in the U.S. Patent and Trademark Office.
Linux is the registered trademark of Linus Torvalds in the U.S. and other countries.
Oracle is a registered trademark of Oracle Corporation.
UNIX is a registered trademark of The Open Group.
BMC Software considers information included in this documentation to be proprietary and confidential. Your use of this information is subject to the terms and conditions of the applicable End User License Agreement for the product and the proprietary and restricted rights notices included in this documentation.
? Copyright 2013 BMC Software, Inc.