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

EntityManager Interface

The com.ca.connector.runtime.EntityManager interface contains the methods that support the data retrieval from the domain manager and inbound operations in the domain manager. Only the get() method is required if you do not want to enable inbound operations in the domain manager. This interface includes the following methods:

public Collection<DataObject> get(DataObject selector) throws UCFException;

Retrieves the entities that match the provided selector. The method reads data from the domain manager in response to a request from the IFW. The get() method accepts a selector of type DataObject that instructs the connector about the type of data that is being requested. In CA SOI, the underlying type for this selector DataObject is SiloDataFilter. The return type for the get() method is a Collection of DataObjects. Each DataObject in the return collection is a single entity from the domain manager, having the CA SOI underlying type of SiloData.

selector

Defines an instance of the selector type associated with one of the entity types managed by the connector.

public DataObject create(DataObject newValue) throws UCFException;

(Optional) Creates the specified entity in the domain manager and returns the created entity.

newValue

Defines the new value for the managed entity to be created in the domain manager.

public DataObject update(DataObject newValue) throws UCFException;

(Optional) Updates the specified entity in the domain manager and returns the updated entity.

newValue

Defines the new value for the managed entity to be updated in the domain manager.

public void delete(DataObject selector) throws UCFException;

(Optional) Deletes the entity in the domain manager that matches the provided selector.

selector

Defines an instance of the selector type associated with one of the entity types managed by the connector.

public void discover(DataObject selector) throws UCFException;

(Not supported) Discovers the entities that match the provided selector.

selector

Defines an instance of the selector type associated with one of the entity types managed by the connector. If the selector is found, it is reported as a normal onCreate event to CI change subscribers.

public Enumeration<DataObject> enumerate(DataObject selector, UUID enumID) throws UCFException;

(Not supported) Enumerates the entities that match the provided selector and returns an enumeration of the entity type that matches the selector. While this method is semantically equivalent to a (Java) enumeration over the results of the get(EntitySelector sel) method, this call provides the opportunity to iteratively build/transfer the results. For example, an implementation may compute/retrieve matching entities from the managed system in batches.

selector

Defines an instance of the selector type associated with one of the entity types managed by the connector.

enumID

Defines a unique ID that is subsequently used by the caller in a call to closeEnumeration() to indicate that it is no longer interested in the enumeration.

public void closeEnumeration(UUID enumID) throws UCFException;

(Not supported) Indicates that callers are no longer interested in the remaining values of an enumeration started earlier with the same ID.

enumID

Defines a unique ID that is subsequently used by the caller in a call to closeEnumeration() to indicate that it is no longer interested in the enumeration.

Important! While the connector framework supports the discover(), enumerate(), and closeEnumeration() methods, CA SOI does not currently use the functionality enabled by these methods. While these methods are available for implementation, the Sample connector does not contain sample code or implement any of these methods by default.