The Programmable Host On-Demand API is a set of Java APIs that allow developers to integrate various pieces of the Host On-Demand client code, such as terminals, menus, and toolbars, into their own custom Java applications and applets. The API gives the developer complete control over the Host On-Demand desktop (what the user sees) without starting with the Host Access Java Beans found in the Toolkit. The underlying Host On-Demand code handles all the "wiring" of the various components, including saving user preferences, such as macros, keyboard remappings, and color remappings, to the local file system for future use. The developer must only determine the layout of the Host On-Demand desktop. The developer can use the API to create a Host On-Demand desktop that shows the session icons and allows sessions to be started by double clicking the icons or a custom desktop that does not show the session icons. In the latter case, an API call starts the sessions.
The Programmable Host On-Demand API works with sessions defined by the Deployment Wizard using the HTML model. The configuration server and combined models are not supported. The API uses the Host On-Demand code that allows sessions started by the API to still honor the other items configured through the Deployment Wizard, such as Disable Functions (for the user) and Add HTML parameters. The API uses the entire contents of the HODData\name directory created by the Deployment Wizard, where name is the name of the HTML file generated.
The Programmable Host On-Demand API supports both applets and applications. The following table lists the locations of the session definition files and user preferences:
| Location of session definition files | Location of user preferences | |
| Applet | Web server | Local file system |
| Application | Local file system or file server Web server |
Local file system |
If you use an application, Programmable Host On-Demand API uses the contents of the HODData\name directory, not the HTML file generated by the Deployment Wizard. You must preserve this directory structure, as generated by the Deployment Wizard, even when the session definition files reside on a local file system.
The full Beans and HACL APIs are available when you use the Programmable Host On-Demand API and a custom desktop. This allows even more flexibility as the applet or application can interact directly with the host session to send or receive data, dynamically change properties, etc.
Host Access Client Package provides many Application Programming Interfaces/solutions for your business needs. The following table lists each solution and the best environment to use that solution.
| Solution: | Required skills: | Intended for: | Beans/HACL API support: |
| Host On-Demand product | Out of the box solution; no programming required | Client applets | Yes, if needed (Run Applet) |
| Session Manager API | JavaScript skills; no Java programming required | Client applets | Limited (JavaScript API) Full support (Run Applet) |
| Programmable Host On-Demand | Java programming | Client applets or applications | Yes |
| Host On-Demand Connector | Java programming | J2EE Architecture | Yes |
| Beans/HACL API | Java programming | Client or server solutions | Yes |
The following functions supported by the Host On-Demand applet are not supported by Programmable Host On-Demand API when using the custom desktop:
[ Top of Page | Previous Page | Next Page | Table of Contents]