Default language.

ARDBC plug-in Java and C API methods

The Java API methods defined in the ARDBCPluggable interface and the ARDBCPlugin abstract class are common to all plug-in types. For more information, see the Java plug-in API online documentation located at ARSystemServerInstallDir\ARserver\api\javaplugins\arpluginsdocVerNum.jar.

Related topics

ARDBC-plug-in-API-functions

An ARDBC plug-in API enables  to:

  • Implement calls on an external data source that are analogous to set entry, get entry, create entry, delete entry, and get list C API calls.
  • Use external data to implement Push Field and Set Field filter, escalation, and active link actions.
  • Create, modify, and search for external data through API clients.
  • Construct query-style character menus.
  • Present forms, views, and active links on external data in the same manner as internal data. The data source is transparent to the user.

When you create an ARDBC plug-in, document the capabilities of your plug-in. For example, you might create a read-only plug-in, which does not allow a user to create, set, or delete entries.

If the data source with which you integrate does not support a particular functionality, do not implement that function. Instead, let the default behavior occur. For example, if your data source does not support transactions, do not define ARDBCCommitTransaction and ARDBCRollbackTransaction functions.

Following are the ARDBC plug-in API functions:

  • ARDBCCommitTransaction
  • ARDBCCreateEntry
  • ARDBCDeleteEntry
  • ARDBCGetEntry
  • ARDBCGetEntryBLOB
  • ARDBCGetEntryStatistics
  • ARDBCGetListEntryWithFields
  • ARDBCGetListSchemas
  • ARDBCGetMultipleFields
  • ARDBCRollbackTransaction
  • ARDBCSetEntry

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*