Reference Guide
Table Of Contents
- 1 Introduction
- 2 Establishing Your Test and Development Environments
- 3 Developing Applications
- Introduction
- Authentication
- REST API
- Audit Logging
- Alert Logging
- Configuration
- High Availability
- OpenFlow
- Metrics Framework
- GUI
- SKI Framework - Overview
- SKI Framework - Navigation Tree
- SKI Framework - Hash Navigation
- SKI Framework - View Life-Cycle
- SKI Framework - Live Reference Application
- UI Extension
- Introduction
- Controller Teaming
- Distributed Coordination Service
- Persistence
- Backup and Restore
- Device Driver Framework
- 4 Application Security
- 5 Including Debian Packages with Applications
- 6 Sample Application
- Application Description
- Creating Application Development Workspace
- Application Generator (Automatic Workspace Creation)
- Creating Eclipse Projects
- Updating Project Dependencies
- Building the Application
- Installing the Application
- Application Code
- 7 Testing Applications
- 8 Built-In Applications
- Appendix A
- Appendix B
- Bibliography
Figure 57 Trying Application’s REST API with RSdoc Example
NOTE
The tool offered by the HP VAN SDN Controller
SDK that generates the RSdoc takes the
Javadoc [21] to generate the REST API documentation as illustrated in F i g u r e 11
. Therefore,
it is mandatory to write Javadoc for the REST APIs (In general, production code classes
should be properly documented). If a REST API method does not contain Javadoc, the
entire REST API won’t be included in the RSDoc.
Creating a GUI
The following information describes the process of creating user interfaces using the HP SKI
framework and integrating such views to the HP VAN SDN Controller GUI. For more information
see GUI on page 59.
197