Develop > Groovy scripts > Reference information > Available APIs

Available APIs

This section details the available platform and external APIs:

External APIs

API Applications
Java JDK

Generic JDBC access for functions such as the following:

  • Establishing a connection to the database.
  • Connecting with data sources.
  • Handling SQL Exceptions.
  • Creating and populating tables.
  • Retrieving and modifying data.
  • Using database transactions.

For details, see http://docs.oracle.com/javase/tutorial/jdbc/basics.

General Web Service access.

Use function URL.openConnection()
Command line tools.
Apache

Providing debugging support by logging at runtime without the need to modify the application binary: Use the Apache Log4j logging API (see also Groovy console).

For details, see http://logging.apache.org/log4j/1.2/.

Communication with RESTful Web services: Use the Wink JSR Client API.

For details, see http://incubator.apache.org/wink/.

Leveraging the HTTP protocol to retrieve information in an environment using distributed communication: Use the Apache HTTP Components API.

For details, see http://hc.apache.org/.

Communication with Web services supporting Simple Object Access Protocol (SOAP): Use the Apache Axis2 API.

For details, see http://axis.apache.org/axis2/java/core/.

Functions Used in EPI Scripts

The Groovy script API with full documentation of all arguments and types can be found in the Java API Documentation delivered with the product. It can be found in the following directory:
<OMi_HOME>/opr/api/doc.

For detailed information about developing EPI scripts, see Event Processing Interface.

API for Topology Synchronization Scripts

For more information about the interfaces and object types required for developing your own topology synchronization scripts, see the following Java API documents:

  • <OMi_HOME>/opr/api/doc/opr-external-api-javadoc.zip

  • <OMi_HOME>/opr/api/doc/opr-ts-interfaces-javadoc.zip

The following is a list of externally visible types and functions.

  • Exposed Interfaces:

    • ICi

    • ICiRelation

    • ICiMessage

    • IScriptingInterface

    • INavigator

    • INode

    • ISyncData

  • Exposed Classes:

    • CiMessageCategory

    • CiMessageSeverity

  • The IScriptingInterface interface is accessible through the variable scriptInterface.

  • The ISyncData accessible through the variable syncData.

For detailed information about developing topology synchronization scripts, see Integrate topology data.

API for Service Health Rules

For detailed information about developing service health rules, see Monitor Event Type and Health Indicators.

Send Help Center feedback