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

EntityOperationRunner Interface

The com.ca.connector.runtime.EntityOperationRunner interface contains the method declarations to implement custom operations for specific entities within the domain manager. All methods in this interface are optional.

Important! While the connector framework supports custom operations, CA SOI does not currently use custom operations 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.

This interface contains the following methods:

public DataObject execute(String operID, DataObject entityKey, DataObject operParams) throws UCFException;

Executes a synchronous operation against managed entities and returns the result of the operation.

operID

Defines the name of the operation.

entityKey

Defines the entity instances to which the operation applies.

operParams

Defines the operation input parameters.

public String start(String operID, DataObject selector, DataObject operParams, OperationListener listener, String refID) throws UCFException;

Starts an asynchronous operation against managed entities and returns an operation unique instance ID that you can use to refer to the operation.

operID

Defines the name of the operation.

entityKey

Defines the entity instances to which the operation applies.

operParams

Defines the operation input parameters.

listener

Listens for state changes related to the operation instance. This parameter can be null, and a listener can also register for the operation later.

refID

Defines an ID understood by the caller.