Planning an AMI Interface

Copyright © Cloud Software Group, Inc. All Rights Reserved

Appendix C Planning Your Instrumented Application : Planning an AMI Interface

Planning an AMI Interface

These steps can help you in planning your AMI interface:

1.

Examine the samples of AMI code included with the TIBCO Hawk distribution to see how these requirements are carried out in code.

2.

Copy one of the AMI code samples and amend it to add one or two methods.

3.

When you are ready to create an interface to your application, consider what data and methods is to be accessed or changed through the application’s management interface:

−

List the separate data items you want to be able to retrieve.

−

List the data items you want to be able to change.

−

List the actions you want to be able to carry out.

Each of these items will become a supported method of your AMI interface.

4.

For each of these methods, decide what arguments it will use and what results it will return. If a method uses arguments, consider what course to take if a default argument is supplied.

5.

Using the collected information for each method, create an outline detailing the message structure to be returned to describe these methods to a manager.

6.

Use this outline to write a describer method, which returns a nested message.

7.

Set up the code to initialize the TIBCO Hawk AMI session.

8.

Write methods that respond to method invocation messages from the manager. In creating each message, use an outline as you did with the describe method message, to lay out what information the message will include.