Copyright © TIBCO Software Inc. All Rights Reserved
Copyright © TIBCO Software Inc. All Rights Reserved


Chapter 1 Introduction to TIBCO Hawk Programming : Programming Tools and Interfaces

Programming Tools and Interfaces
REST API
TIBCO Hawk REST API provide set of HTTP methods to manage and monitor the Hawk agent. You can use these methods to create your own console, if needed.
After you start the Hawk Console, you can view these REST APIs at the Swagger page URL
http://<Console_host_IP>:<Host_port>/HawkConsole/v1/docs
The Swagger page enables you to view the details of each API, such as model schema, required parameters, response messages, and so on. Also, you can try out the APIs by providing the parameters to the API in the Swagger URL.
Console API
The Console API is a comprehensive set of Java interfaces that allow you to manage and interact with TIBCO Hawk agents and monitor alerts generated by these agents. Both the TIBCO Hawk WebConsole and TIBCO Hawk Event Service implement the Console API to monitor and manage agent behavior. Programmers can use the Console API to write custom applications similar to these applications to monitor agent behavior, subscribe to alert messages, and invoke microagent methods.
Configuration Object API
The Configuration Object API is a Java interface for writing custom rulebases. Rulebases are used by TIBCO Hawk agents to monitor and manage systems and applications. The Configuration Object API provides classes to define rules, tests and actions. Instances of these classes are put together to define a new rulebase.
AMI API
The AMI API allows application to instrument their applications with the Hawk API and make them manageable using Hawk Agent. AMI APIs are available in Java, C and C++.
Security API
The TIBCO Hawk Security API is used to build security plug-in modules used for secure agent and console interactions. The security mechanism actually involves two modules, one that is used by the agent and another that is used by the console. If you use the Console API to write console applications that will operate in a secure TIBCO Hawk environment, you must have access to the console-side security plug-in class to be able to perform management operations on agents. The TIBCO Hawk WebConsole requires a security plug-in class to manage agents in a secure environment.
 

Copyright © TIBCO Software Inc. All Rights Reserved
Copyright © TIBCO Software Inc. All Rights Reserved