CWConnectorAgent class

The CWConnectorAgent class is the base class for a Java connector. From this class, a connector developer must derive a connector class and implement the user-defined methods for the connector. This derived connector class contains the code for the application-specific component of the connector.

Note:
The CWConnectorAgent class extends the ConnectorBase class of the low-level Java connector library. For more information on the classes of the low-level Java connector library, see Overview of the low-level Java connector library.

Important:
All Java connectors must extend this connector base class and provide implementations for the following methods: agentInit(), getVersion(), getConnectorBOHandlerForBO(), pollForEvents(), and terminate(). However, CWConnectorAgent provides default implementations for the getVersion(), getConnectorBOHandlerForBO(), and pollForEvents() methods. In their derived connector base class, developers can either use these default implementations or override them to implement their own versions. Developers must provide implementations for the agentInit() and terminate() methods.

Table 115 summarizes the methods in the CWConnectorAgent class.

Table 115. Member methods of the CWConnectorAgent class
Member method Description Page
CWConnectorAgent() Creates a connector object. CWConnectorAgent()
agentInit() Initializes the connector agentInit()
executeCollaboration() Sends business object requests to collaborations as a synchronous request. executeCollaboration()
getCollabNames() Retrieves the list of collaborations that are available to process business object requests. getCollabNames()
getConnectorBOHandlerForBO() Retrieves the business object handler for a specified business object definition. getConnectorBOHandlerForBO()
getEventStore() Retrieves a reference to the connector's event store. getEventStore()
getVersion() Retrieves the version of the connector. getVersion()
gotApplEvent() Sends a business object to InterChange Server. gotApplEvent()
isAgentCapableOfPolling() Determines whether this connector process is capable of polling. isAgentCapableOfPolling()
isSubscribed() Determines whether the integration broker has subscribed to a particular business object with a particular verb. isSubscribed()
pollForEvents() Polls an application's event store for events that cause changes to business objects. pollForEvents()
terminate() Closes the connection with the application and frees allocated resources. terminate()

Copyright IBM Corporation 1997, 2004. All Rights Reserved.