Skip to main content

CAR service connector framework

Project description

Car Connector Framework

Develop a connector

Use connectors/reference_connector from cp4s-car-connectors project as an example of how this framework is to be used.

A CAR connector project will need to extend the framework classes: BaseFullImport, BaseIncrementalImport, BaseApp, BaseAssetServer and BaseDataHandler, and implement abstract methods of those classes.

Things to note:

  • All communications with CAR digestion microservice are managed by the framework. Connector code normally does not need to access CAR digestion microservice directly

  • The framework is trying to make some intelligent choice for whether to run full vs incremental import. Normally, for performance reasons we would always prefer to run incremental import if one is possible. Some examples of when it is not possible are:

    • The model states for generating delta are not available
    • The model on the CAR side is empty
    • The previous incremental import session failed and a new incremental import session can potentially create a gap in the model data
  • Because of the above the the connector code should properly use (throw/raise) one of three following exceptions when detecting failures:

    • RecoverableFailure is to be used when the failure cannot potentially create a data gap and we can attempt an incremental import session when running next time. One example of a recoverable failure is a connectivity problem.
    • UnrecoverableFailure is to be used when the failure can potentially create a data gap and we must run full import session to recover.
    • DatasourceFailure is to be used when there is datasource API issues.

RecoverableFailure and UnrecoverableFailure are mostly handled in the framework. DatasourceFailure is to be used in the connector code with a corresponding error code. Example: return ErrorCode.TRANSMISSION_AUTH_CREDENTIALS.value. If none of the Failure classes is used, the framework will raise a GENERAL_APPLICATION_FAILURE (Unknown error) and print the error stack.

For more information use guides

Test deploy

https://github.com/IBM/cp4s-car-connectors/blob/develop/deployment/README.md

Publish

Use the guide from PUBLISH.md

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

car-connector-framework-4.0.2.tar.gz (18.1 kB view details)

Uploaded Source

Built Distribution

car_connector_framework-4.0.2-py3-none-any.whl (22.3 kB view details)

Uploaded Python 3

File details

Details for the file car-connector-framework-4.0.2.tar.gz.

File metadata

File hashes

Hashes for car-connector-framework-4.0.2.tar.gz
Algorithm Hash digest
SHA256 2952a779c35a4c3b29a98b23e42d54e0e5c32ef1a05f24e465f3510306d21c1a
MD5 c19ed8db74d4b5517ad8ac9d7fd2b286
BLAKE2b-256 4b454138070fea2b4431b5d20b78c963d6d89802af076a6d310ff459e60567b6

See more details on using hashes here.

File details

Details for the file car_connector_framework-4.0.2-py3-none-any.whl.

File metadata

File hashes

Hashes for car_connector_framework-4.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 adfbf6522c75e58d1a6ba8a51adacbd61ea0bffd898b40a86491bbaae2ca91d1
MD5 a135a1bfe947ad460bd396f771854f5c
BLAKE2b-256 8b33d6fa3bd7b0a2ff7ff278e782903fb37bf14f697e2294eead912f46ad0065

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page