OperationRunner Interface

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

OperationRunner Interface

The com.ca.connector.runtime.OperationRunner interface contains the method declarations to monitor the progress of synchronous and asynchronous custom operations on the domain manager and connector. 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 void abort(String operInstID) throws Exception;

Aborts the operation.

operInstID: Defines the unique instance ID of a running operation obtained through an initial call to start().

public void forget(String operInstID) throws Exception;

Forgets the operation by indicating to the underlying system that the caller is no longer interested in the results, but that the operation does not necessarily need to be aborted.

operInstID: Defines the unique instance ID of a running operation obtained through an initial call to start().

public void recover(String operInstID, DataObject lastState, OperationListener listener, String refID) throws UCFException;

Recovers an operation by restarting it from the state previously saved in an intermediateState() callback to the listener. Some operations may simply restart, others may abort as a result, and others may be able to restart from the obtained state.

operInstID: Defines the unique instance ID of a running operation obtained through an initial call to start().
lastState: Defines the last known operation state.
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.

public void setOperationListener(String operInstID, String refID, OperationListener listener) throws UCFException;

Listens to ongoing operation state changes. The interface supports a single listener per runner. If more are required, you can use a simple multiplexer pattern.

operInstID: Defines the unique instance ID of a running operation obtained through an initial call to start().
refID: Defines an ID understood by the caller.
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.