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

ConnectorEventPublisher Interface

The com.ca.connector.runtime.EventPublisher interface contains the methods that control how the connector interacts with generic events not related to CIs from the domain manager. This interface includes the following methods:

Important! While the connector framework supports this interface, CA SOI does not currently use the functionality provided by these methods in integrated connectors. While these methods are available for implementation, the Sample connector does not contain sample code or implement any of these methods by default.

public Object getEarliestAvailableBookmark;

Gets a unique bookmark associated with the earliest event available to the connector.

public String subscribeToEvents(String eventTypeID, DataObject filter, ConnectorEventSubscriber subscriber);

Subscribes to general events published by the connector.

eventTypeID

Defines the ID of a type of event published by the connector.

filter

Defines restrictions of events to which the connector subscribes. The object type is the filter type supported by the event type in the eventTypeID parameter.

subscriber

Defines the subscriber to connector events and returns a subscription ID.

public String subscribeToEvents(String eventTypeID, DataObject filter, Object bookmark, ConnectorEventSubscriber subscriber);

Subscribes to general events published by the connector. This variant of the subscription method lets subscribers ask for events (that the connector may have missed, for example) generated since a previously received event. The start event is identified by an ID associated with the event, or a bookmark (see the ConnectorEventSubscriber API for details). The bookmark is opaque to the subscriber. This mechanism is derived from WS-MAN and provides some level of support for recovery.

eventTypeID

Defines the ID of a type of event published by the connector.

filter

Defines restrictions of events to which the connector subscribes. The object type is the filter type supported by the event type in the eventTypeID parameter.

bookmark

Identifies a previously received event. Any event that occurred after the bookmarked event is regenerated for the subscriber. Subscribers use a special value of the bookmark to request all available events returned by the getEarliestAvailableBookmark() method.

subscriber

Defines the subscriber to connector events and returns a subscription ID.

public void unsubscribeFromEvents(String subscriptionID);

Subscribes to entity change events.

subscriptionID

Defines the subscription ID to unsubscribe.