Preface
Introduction to Informatica Connector Toolkit
- Supported features
- Informatica Connector perspective
  - Connector Navigator
  - Connector Progress
Before you begin
- Download the welcome kit
- Download and install Eclipse IDE
- Download and install the Informatica Connector Toolkit
- Download OpenJDK and configure environment variables
- Log in to Informatica Intelligent Data Management Cloud
Develop a connector for Cloud Data Integration
- Create a new connector project
- Phase 1: Establish a connection
  - Create a connection
  - Test a connection
- Phase 2: Define the metadata
- Phase 3: Configure the runtime behavior
- Phase 4: Generate the connector package
  - Naming Convention
- Phase 5: Generate and run the test scenarios
  - Generate the test scenarios
    - Configure parameters in test suite file
    - Regenerate a test case
  - Run the test scenarios
    - Unit tests and sanity tests
    - Integration tests
Develop a connector for Data Loader
- Create a new connector project
- Phase 1: Establish a connection
  - Create a connection
  - Test a connection
- Phase 2: Define the metadata
- Phase 3: Configure the runtime behavior
- Phase 4: Generate the connector package
  - Naming Convention-DLT
- Phase 5: Generate and run the test scenarios
  - Generate the test scenarios
    - Configure parameters in test suite file
    - Regenerate a test case
  - Run the test scenarios
    - Unit tests and sanity tests
    - Integration tests
Import a connector
Connection attributes
- Connection attribute properties
Type system
- Native types and semantic categories
  - Native Type Properties
- Cloud Data Integration types
Connector metadata
- Metadata components
- Import dialog box settings
Partitioning capability
- Automatic partitioning
- Static partitioning
Pushdown capability
- Pushdown optimization execution flow
- Classes and methods for pushdown capabilities
Mappings in advanced mode
- Project, classes, and methods
Manual changes to Informatica Connector Toolkit source code
- Code changes for connection pooling
  - Connection Pooling through API
- Code changes for custom query
- Code changes for object path override
- Code changes for pushdown capability
- Code changes for SQL transformation
- Code changes for stored procedures
Runtime behavior
- Runtime Java functions
Connector example: MySQL_Cloud
- MySQL_Cloud Connector requirements
- Building the sample connector
- MySQL_Cloud Connector components
Version control integration
- Git version control integration
  - Prerequisites
  - Build a connector in Git repository
- Perforce version control integration
Appendix A: Metadata models
- Metadata model components
- Metadata patterns
- Features of type A metadata template
Appendix B: ASO model
- ASO model components
- ASO projections
Appendix C: Connector project migration
- Migrate connector project from Windows platform to other platforms
Appendix D: Frequently used generic APIs in Informatica Connector Toolkit
Appendix E: Frequently asked questions

Cloud Data Integration Connector Toolkit Developer Guide

Back Next

Appendix D: Frequently used generic APIs in Informatica Connector Toolkit

You can use the following generic APIs that are frequently used to create a connector using the Informatica Connector Toolkit:

Connection Adapter APIs

ConnectInfoAdapter Class: public SDKErrorInfo validateAttributes(Map<String, Object> attrNameValmap)
Validates the connection attributes and provide any validation errors.; public List<Object> getConnectInfoUpdatedConsumerInfo(Map<String, Object> map, SDKConsumerTypeEnum consumerType)
Provides the list of objects that appears in the Connection UI.

Metadata Adapter APIs

Connection Class: public Status openConnection(Map<String, Object> connAttrs)
Establishes a connection to the data source.; public Status closeConnection()
Closes the connection to the data source.
Metadata Adapter Class: Connection getMetadataConnection(List<Option> options, Map<String, Object> connAttrs)
Use this method to get the adapter metadata connection instance.; public Boolean populateObjectCatalog(Connection connection, List<Option> options, Catalog catalog)
Use this method to populate the third-party metadata information such as schemas & tables; public void populateObjectDetails(Connection connection, List<Option> options, List<ImportableObject> importableObjects, Catalog catalog)
Use this method to populate the field details & extensions for the object selected; public boolean validate(Connection sdkConnection, List<Option> options)
Use this method to validate the custom query provided by the user to fetch the metadata; public Status writeObjects(Connection connection, MetadataWriteSession writeSession, MetadataWriteOptions defOptions)
Use this method to create a data source object in the third-party to handle create target scenario

Runtime Adapter APIs

DataAdapter Class: public int initDataSession(DataSession dataSession) throws SDKException
Use this method to initialize the data session.; public int read(DataSession dataSession, ReadAttributes readAttr) throws SDKException
Use this method to implement the code to read data from the data source.; public int write(DataSession dataSession, WriteAttributes writeAttr) throws SDKException
Use this method to implement the code to write data to the data source.; public int call(DataSession dataSession, CallAttributes callAttr) throws SDKException
Use this method to implement the code to read data from the data source by executing the procedure.; public int deinitDataSession(DataSession dataSession)
Use this method to deinitialize the data session.

OperationAdapter Class: public int initDataSourceOperation(DataSourceOperationContext dsoHandle, MetadataContext connHandle) throws SDKException
Use this method to initialize the data source operation adapter before any partitions are executed.; public int deinitDataSourceOperation(DataSourceOperationContext dsoHandle, MetadataContext connHandle) throws SDKException
Use this method to deinitialize the data source operation adapter after all partitions are executed.
DataConnection Class: public Object getNativeConnection()
Use this method toreturn a data source connection object.
Plugin Class: public int initPlugin(PluginInfo pluginInfo)
This method will be called by SDK framework at the plugin loading time. Adapter developer needs to provide plugin info in this API.; public Connection createConnection()
Use this method to return adapter specific connection class instance; public DataAdapter getDataAdapter()
Use this method to return the adapter DataAdapter Object; public DataSourceOperationAdapter getDataSourceOperationAdapter()
Use this method to return the adapter DataSourceOperation object

Runtime Semantic APIs

ASOOperationObjMgr Class: public boolean validateAll(boolean recurse, ObjectManagerContext ctx, MetadataObject currentObj, MetadataObject containerObj) throws SL_ValidationException
Validates all the fields. If pushdown optimization is supported by the adapter, validate and generate pushdown SQL query for the mapping..

Typesystem APIs

Typesystem Class in the seed.provider project: DirectMapUtils.INSTANCE.createDataTypeMap(DirectTypeSystemMap directTSMap, DataType localDT, DataType foreignDT, boolean lossyToLocal, boolean lossyToForeign, boolean bestMapFromLocal, boolean bestMapFromForeign)
Creates a Connector Typesystem map with all the data types.

LicenseChecker API

LicenseChecker Class: public boolean isLicensedToRun(InformaticaLicenseChecker checker)
Validates if the user has the adapter license to execute tasks.

Rename Saved Search

Table of Contents

Cloud Data Integration Connector Toolkit Developer Guide

Cloud Data Integration Connector Toolkit Developer Guide

Appendix D: Frequently used generic APIs in Informatica Connector Toolkit

Appendix D: Frequently used generic APIs in Informatica Connector Toolkit

Connection Adapter APIs

Metadata Adapter APIs

Runtime Adapter APIs

Runtime Semantic APIs

Typesystem APIs

LicenseChecker API