BaseIntegrationConnector Class |
Namespace: CMS.SynchronizationEngine
public abstract class BaseIntegrationConnector : AbstractIntegrationConnector
The BaseIntegrationConnector type exposes the following members.
Name | Description | |
---|---|---|
BaseIntegrationConnector |
Name | Description | |
---|---|---|
ClearTranslationsAfterProcessing |
Says whether to clear cached translation information (true by default). Applies both to internal and external tasks.
If switched to false, translations can still be cleared by calling ClearInternalTranslations() or ClearExternalTranslations().
| |
ConnectorEnabled |
Gets a value that indicates if the connector is enabled.
(Inherited from AbstractIntegrationConnector.) | |
ConnectorID |
Gets integration connector identifier.
(Inherited from AbstractIntegrationConnector.) | |
ConnectorInfo |
Gets integration connector info object.
(Inherited from AbstractIntegrationConnector.) | |
ConnectorName |
Name of the connector.
(Inherited from AbstractIntegrationConnector.) | |
LogIntegrationForExternalTasks |
Determines whether to log integration tasks when processing external tasks.
False by default.
| |
SyncManager |
SyncManager instance.
|
Name | Description | |
---|---|---|
ClearExternalTranslations |
Clears hashtable with external translations
| |
ClearInternalTranslations |
Clears hashtable with internal translations
| |
GetExternalDocumentID |
Based on parameters this method will find out identifier of the document matching external application.
| |
GetExternalObjectID |
Based on parameters this method will find out identifier of the object matching external application.
| |
GetExternalTranslation |
Gets translation for class name and identifier.
| |
GetInternalDocumentParams |
By supplying document identifier and class name the method ensures filling output parameters needed for correct translation between external and internal document.
| |
GetInternalObjectParams |
By supplying object type and identifier the method ensures filling output parameters needed for correct translation between external and internal object.
| |
GetInternalTranslation |
Gets translation for class name and identifier.
| |
Init |
Initializes the provider. Suitable for making subscriptions etc.
ConnectorName has to be initialized within this method.
(Inherited from AbstractIntegrationConnector.) | |
PrepareInternalObject |
Transforms given external object to internal (to TreeNode or GeneralizedInfo).
| |
ProcessExternalTask(IntegrationTaskInfo) |
Processes single external task.
| |
ProcessExternalTask(Object, IntegrationProcessTypeEnum, TaskTypeEnum, TaskDataTypeEnum, String) |
Processes incoming task.
(Overrides AbstractIntegrationConnectorProcessExternalTask(Object, IntegrationProcessTypeEnum, TaskTypeEnum, TaskDataTypeEnum, String).) | |
ProcessExternalTasks |
Fetches external tasks and processes them one by one.
(Overrides AbstractIntegrationConnectorProcessExternalTasks.) | |
ProcessExternalTasks(IEnumerableIntegrationTaskInfo) |
Processes given external tasks one by one.
| |
ProcessInternalTask |
Processes single internal task.
| |
ProcessInternalTaskAsync(GeneralizedInfo, TranslationHelper, TaskTypeEnum, TaskDataTypeEnum, String, String) |
Suitable for implementation of asynchronous outcoming object processing. Identifiers of object are already prepared to match external application.
| |
ProcessInternalTaskAsync(ICMSObject, TranslationHelper, TaskTypeEnum, TaskDataTypeEnum, String, String) |
Suitable for implementing outcoming CMS object processing. Identifiers of object is already prepared to match external application.
(Overrides AbstractIntegrationConnectorProcessInternalTaskAsync(ICMSObject, TranslationHelper, TaskTypeEnum, TaskDataTypeEnum, String, String).) | |
ProcessInternalTaskAsync(TreeNode, TranslationHelper, TaskTypeEnum, TaskDataTypeEnum, String, String) |
Suitable for implementation of asynchronous outcoming document processing. Identifiers of document are already prepared to match external application.
| |
ProcessInternalTasks |
Fetches internal tasks and processes them one by one.
(Overrides AbstractIntegrationConnectorProcessInternalTasks.) | |
ProcessInternalTasks(IEnumerableIntegrationTaskInfo) |
Processes given internal tasks one by one.
| |
ProcessInternalTaskSync(GeneralizedInfo, TaskTypeEnum, String, String) |
Suitable for implementation of synchronous outcoming object processing. Identifiers of object are in their original state.
| |
ProcessInternalTaskSync(ICMSObject, TaskTypeEnum, String, String) |
Suitable for implementing synchronous outcoming CMS object processing.
(Overrides AbstractIntegrationConnectorProcessInternalTaskSync(ICMSObject, TaskTypeEnum, String, String).) | |
ProcessInternalTaskSync(TreeNode, TaskTypeEnum, String, String) |
Suitable for implementation of synchronous outcoming document processing. Identifiers of object are in their original state.
| |
RequestTasksProcessing(String) |
Performs a request to a special page on server defined by given url causing immediate task processing for all connectors.
| |
RequestTasksProcessing(String, String) |
Performs a request to a special page on server defined by given url causing immediate task processing for connector specified by name.
| |
SetExternalTranslation |
Sets translation for class name and identifier.
| |
SetInternalTranslation |
Sets translation for class name and identifier.
| |
SubscribeTo(AbstractIntegrationSubscription) |
Assigns given subscription to this connector.
| |
SubscribeTo(TaskProcessTypeEnum, TaskTypeEnum) |
Subscribes this connector to given type of task.
| |
SubscribeToAllDocuments |
Subscribes this connector to given types of tasks for document processing.
| |
SubscribeToAllObjects |
Subscribes this connector to given types of tasks for object processing.
| |
SubscribeToDocuments(TaskProcessTypeEnum, String) |
Subscribes this connector to given class names.
| |
SubscribeToDocuments(TaskProcessTypeEnum, TaskTypeEnum, String) |
Subscribes this connector to process tasks matching given conditions.
| |
SubscribeToDocuments(TaskProcessTypeEnum, String, TaskTypeEnum) |
Subscribes this connector to process tasks matching given conditions.
| |
SubscribeToDocuments(TaskProcessTypeEnum, TaskTypeEnum, String, String) |
Subscribes this connector to process tasks matching given conditions.
| |
SubscribeToDocuments(TaskProcessTypeEnum, String, String, TaskTypeEnum) |
Subscribes this connector to process tasks matching given conditions.
| |
SubscribeToObjects(TaskProcessTypeEnum, String) |
Subscribes this connector to given types of object.
| |
SubscribeToObjects(TaskProcessTypeEnum, TaskTypeEnum, String) |
Subscribes this connector to process tasks matching given conditions.
| |
SubscribeToObjects(TaskProcessTypeEnum, String, TaskTypeEnum) |
Subscribes this connector to process tasks matching given conditions.
| |
SubscribeToObjects(TaskProcessTypeEnum, TaskTypeEnum, String, String) |
Subscribes this connector to process tasks matching given conditions.
| |
SubscribeToObjects(TaskProcessTypeEnum, String, String, TaskTypeEnum) |
Subscribes this connector to process tasks matching given conditions.
| |
TranslateColumnsToExternal(GeneralizedInfo, TranslationHelper, Boolean) |
Translates column values of given object to match external ones.
| |
TranslateColumnsToExternal(ICMSObject, TranslationHelper, Boolean) |
Translates column values of given CMS object to match external ones.
| |
TranslateColumnsToExternal(TreeNode, TranslationHelper, Boolean) |
Translates column values of given document to match external ones.
|