Adapter Interfaces

Definitions and Terms

External Relation. The relation between two external CI types that are supported by the same adapter.

Adapter Interfaces for Federated TQL Queries

Use the appropriate adapter interface for each adapter, as follows.

  • A Single Node topology interface is used when the adapter does not support any external relations; that is, the adapter is never meant to receive a request with more than one external CI. The reconciliation data needed to complete the operation can be described as complex query (see SingleNodeFederationTopologyReconciliationAdapter below).

    All SingleNode interfaces are created to simplify the workflow; for those cases where you need to use a more extensive query, use the FederationTopologyAdapter interface.

  • A FederationTopologyAdapter interface is used to define adapters that support complex federated queries. The reconciliation request in these adapters is part of the QueryDefinition parameter.

    The Federation engine uses reconciliation data in order to connect the federated data to the proper local CIs. Reconciliation data may be fetched in more than one request (calculated recursively according to results). In this case, the adapter receives a request with only reconciliation data.

SingleNode Interfaces

The following interfaces have different types of reconciliation data:

  • SingleNodeFederationIdReconciliationAdapter. Use if the adapter supports a single-node TQL and the reconciliation between data repositories is calculated by the ID.

  • SingleNodeFederationPropertyReconciliationAdapter. Use if the adapter supports a single-node TQL and the reconciliation between data repositories is done by the properties of one CI.

  • SingleNodeFederationTopologyReconciliationAdapter. Use if the adapter supports a single-node TQL and the reconciliation between data repositories is done by topology. The adapter should support the case where the query element is empty and only reconciliation topology is requested.

Data Adapter Interfaces

  • FederationTopologyAdapter. Use this adapter to support complex federated TQL queries. Allows the most diversity. The adapter should support the case where the query definition is describing only reconciliation data.

  • PopulateDataAdapter. Use this adapter to support complex federated TQL queries and population flows. In a population flow, this adapter retrieves the entire data set, and lets the probe filter the difference since the last execution of the job.

  • PopulateChangesDataAdapter. Use this adapter to support complex federated TQL queries and population flows. In a population flow, this adapter supports the retrieval of only the changes that occurred since the last execution of the job.

Note When developing an adapter that may return large data sets of data, its important to allow chunking by implementing the ChunkGetter Interface. See the Java document of the specific adapter for more information.

Resource Reporting Interfaces

The following interfaces enable the adapter to report the resources that can be configured to customize the adapter's behavior. This enables you to edit these resources directly from the Integration Studio. These interfaces should be used in addition to the regular adapter interfaces above.

  • PopulationQueriesResourcesLocator. Defines which resources may be edited for each specific Population query.

  • PushQueriesResourceLocator. Defines which resources may be edited for each Data Push query.

  • GeneralResourcesLocator. Defines which general resources may be edited in this adapter.

Additional Interfaces

  • SortResultDataAdapter. Use if you can sort the resulting CIs in the external data repository.

  • FunctionalLayoutDataAdapter. Use if you can calculate the functional layout in the external data repository.

Adapter Interfaces for Synchronization

  • SourceDataAdapter. Use for source adapters in population flows.

  • TargetDataAdapter. Use for target adapters in data push flows.