Building a Custom Connector Using the Sample Connector › How to Build a Custom Connector › How You Implement a Custom Connector › Connector Interfaces and Methods › Connector Interface

Connector Interface

The com.ca.connector.runtime.Connector interface contains the methods that control the connector lifecycle with the domain manager. This interface includes the following methods:

public void initialize(UUID uuid, DataObject config, Properties properties) throws UCFException;

Initializes the connector, based on a configuration file that you define in the SOI_HOME\resources\Configurations directory. The integration framework reads any configuration parameters that are listed in the connector configuration file (ConnectionInfo tag), and pass them as input parameters to the initialize() method. As the name indicates, this method completes any tasks required for the connector to become ready for fulfilling requests for data.

uuid

Uniquely identifies this instance of the connector.

config

Created from an instance of the ConnectorConfigDesc associated with the connector. The config object is edited by installers, the administration user interface, and other means.

properties

Defines properties that are provided to the instance and are typically used by proxy client implementations to connect to the domain manager.

public boolean isSystemUp();

Determines whether the domain manager is available. This method checks whether the system is running and returns a flag indicating whether the underlying system is up or down. The IFW uses this method to help detect error states. If this method does not return true, the connector is not able to come online.

public void restart();

Restarts the connector. This is an equivalent to a shutdown and reinitialize.

public void shutdown();

Shuts down the connector and cleans up the connection with the underlying system.