This example shows how to create a web service client for CA APM.
Tested with version 10.0 and 10.5. Should work with APM 9.x as well.
Apache Axis 1.4 (coming with Eclipse Luna SR2)
How to install the extension.
Maven 3.2.5
- Apache Axis 1.4.
com.wily.apm.webservices_<version>.jarwhich can be found<EM_HOME>/product/enterprisemanager/plugins. Best to add the whole directory to the classpath.
Run mvn install
Change the following variables in ca/apm/introscope/webservices/ClientTest.java to point to your environment:
- host: hostname/IP address of your MOM
- port: webserver port of your MOM (default 8081)
- protocol: http or https, only tested with http! For https you might need to add the certificate of the MOM to the Java keystore.
- user: APM username
- pwd: password
- agents: list of agents that are evaluated against the alerts defined in the Management Modules. The web service API does not support querying the threshold values without supplying an agent. If the agent does not match an alert for a the Management Module a SOAP fault is generated and thrown in a
RemoteException.
Run mvn test.
The sample test class will run two test cases:
- it will print the current live metric data for the metric "Enterprise Manager:Overall Capacity (%)"
- it will print all Management Modules and if an agent matches an alert the following information for that agent/alert combination: Management Module/Alert/Agent: warning threshold, critical threshold, active, status (0 - no data, 1 - OK, 2, - warning/caution, 3 - critical/danger)
I created these classes by downloading the WSDL from (http://<em_host>:8081/introscope-web-services/services/MetricsDataService?wsdl) and generating an Axis client with Eclipse. Starting from this example you can
- get data for other metrics
- call other methods of this service or
- create web service clients from the other CA APM web services as well.
See CA APM API Guide for more information.
Please be aware the web service calls put additional load on your CA APM Enterprise Managers. So keep the number of calls and the amount of metrics collected to the minimum required for your use case. If you try to "copy" the EM data you will crash your system for sure!
This document and associated tools are made available from CA Technologies as examples and provided at no charge as a courtesy to the CA APM Community at large. This resource may require modification for use in your environment. However, please note that this resource is not supported by CA Technologies, and inclusion in this site should not be construed to be an endorsement or recommendation by CA Technologies. These utilities are not covered by the CA Technologies software license agreement and there is no explicit or implied warranty from CA Technologies. They can be used and distributed freely amongst the CA APM Community, but not sold. As such, they are unsupported software, provided as is without warranty of any kind, express or implied, including but not limited to warranties of merchantability and fitness for a particular purpose. CA Technologies does not warrant that this resource will meet your requirements or that the operation of the resource will be uninterrupted or error free or that any defects will be corrected. The use of this resource implies that you understand and agree to the terms listed herein.
Although these utilities are unsupported, please let us know if you have any problems or questions by adding a comment to the CA APM Community Site area where the resource is located, so that the Author(s) may attempt to address the issue or question.
Unless explicitly stated otherwise this extension is only supported on the same platforms as the APM core agent. See APM Compatibility Guide.
Changes for each version of the extension.
| Version | Author | Comment |
|---|---|---|
| 1.0 | Guenter Grossberger | First version |