BaseIntegrationConnector Class

Class that needs to be inherited during implementing custom integration connector. Several members have to be implemented in order to achieve desired functionality.

Inheritance Hierarchy

System.Object
  CMS.Synchronization.AbstractIntegrationConnector
    CMS.SynchronizationEngine.BaseIntegrationConnector

Namespace: CMS.SynchronizationEngine
Assembly: CMS.SynchronizationEngine (in CMS.SynchronizationEngine.dll) Version: 8.2.23

Syntax

public abstract class BaseIntegrationConnector : AbstractIntegrationConnector

The BaseIntegrationConnector type exposes the following members.

Constructors

	Name	Description
Protected method	BaseIntegrationConnector

Methods

	Name	Description
Protected method	ClearExternalTranslations	Clears hashtable with external translations
Protected method	ClearInternalTranslations	Clears hashtable with internal translations
Public method	GetExternalDocumentID	Based on parameters this method will find out identifier of the document matching external application.
Public method	GetExternalObjectID	Based on parameters this method will find out identifier of the object matching external application.
Protected method	GetExternalTranslation	Gets translation for class name and identifier.
Public method	GetInternalDocumentParams	By supplying document identifier and class name the method ensures filling output parameters needed for correct translation between external and internal document.
Public method	GetInternalObjectParams	By supplying object type and identifier the method ensures filling output parameters needed for correct translation between external and internal object.
Protected method	GetInternalTranslation	Gets translation for class name and identifier.
Public method	Init	Initializes the provider. Suitable for making subscriptions etc. ConnectorName has to be initialized within this method. (Inherited from AbstractIntegrationConnector.)
Public method	PrepareInternalObject	Transforms given external object to internal (to TreeNode or GeneralizedInfo).
Public method	ProcessExternalTask(IntegrationTaskInfo)	Processes single external task.
Public method	ProcessExternalTask(Object, IntegrationProcessTypeEnum, TaskTypeEnum, TaskDataTypeEnum, String)	Processes incoming task. (Overrides AbstractIntegrationConnector.ProcessExternalTask(Object, IntegrationProcessTypeEnum, TaskTypeEnum, TaskDataTypeEnum, String).)
Public method	ProcessExternalTasks()	Fetches external tasks and processes them one by one. (Overrides AbstractIntegrationConnector.ProcessExternalTasks().)
Protected method	ProcessExternalTasks(IEnumerable<IntegrationTaskInfo>)	Processes given external tasks one by one.
Public method	ProcessInternalTask	Processes single internal task.
Public method	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.
Public method	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 AbstractIntegrationConnector.ProcessInternalTaskAsync(ICMSObject, TranslationHelper, TaskTypeEnum, TaskDataTypeEnum, String, String).)
Public method	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.
Public method	ProcessInternalTasks()	Fetches internal tasks and processes them one by one. (Overrides AbstractIntegrationConnector.ProcessInternalTasks().)
Protected method	ProcessInternalTasks(IEnumerable<IntegrationTaskInfo>)	Processes given internal tasks one by one.
Public method	ProcessInternalTaskSync(GeneralizedInfo, TaskTypeEnum, String, String)	Suitable for implementation of synchronous outcoming object processing. Identifiers of object are in their original state.
Public method	ProcessInternalTaskSync(ICMSObject, TaskTypeEnum, String, String)	Suitable for implementing synchronous outcoming CMS object processing. (Overrides AbstractIntegrationConnector.ProcessInternalTaskSync(ICMSObject, TaskTypeEnum, String, String).)
Public method	ProcessInternalTaskSync(TreeNode, TaskTypeEnum, String, String)	Suitable for implementation of synchronous outcoming document processing. Identifiers of object are in their original state.
Public method	RequestTasksProcessing(String)	Performs a request to a special page on server defined by given url causing immediate task processing for all connectors.
Public method	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.
Protected method	SetExternalTranslation	Sets translation for class name and identifier.
Protected method	SetInternalTranslation	Sets translation for class name and identifier.
Public method	SubscribeTo(AbstractIntegrationSubscription)	Assigns given subscription to this connector.
Public method	SubscribeTo(TaskProcessTypeEnum, TaskTypeEnum)	Subscribes this connector to given type of task.
Public method	SubscribeToAllDocuments	Subscribes this connector to given types of tasks for document processing.
Public method	SubscribeToAllObjects	Subscribes this connector to given types of tasks for object processing.
Public method	SubscribeToDocuments(TaskProcessTypeEnum, String)	Subscribes this connector to given class names.
Public method	SubscribeToDocuments(TaskProcessTypeEnum, TaskTypeEnum, String[])	Subscribes this connector to process tasks matching given conditions.
Public method	SubscribeToDocuments(TaskProcessTypeEnum, String, TaskTypeEnum[])	Subscribes this connector to process tasks matching given conditions.
Public method	SubscribeToDocuments(TaskProcessTypeEnum, TaskTypeEnum, String, String[])	Subscribes this connector to process tasks matching given conditions.
Public method	SubscribeToDocuments(TaskProcessTypeEnum, String, String, TaskTypeEnum[])	Subscribes this connector to process tasks matching given conditions.
Public method	SubscribeToObjects(TaskProcessTypeEnum, String)	Subscribes this connector to given types of object.
Public method	SubscribeToObjects(TaskProcessTypeEnum, TaskTypeEnum, String[])	Subscribes this connector to process tasks matching given conditions.
Public method	SubscribeToObjects(TaskProcessTypeEnum, String, TaskTypeEnum[])	Subscribes this connector to process tasks matching given conditions.
Public method	SubscribeToObjects(TaskProcessTypeEnum, TaskTypeEnum, String, String[])	Subscribes this connector to process tasks matching given conditions.
Public method	SubscribeToObjects(TaskProcessTypeEnum, String, String, TaskTypeEnum[])	Subscribes this connector to process tasks matching given conditions.
Protected method	TranslateColumnsToExternal(GeneralizedInfo, TranslationHelper, Boolean)	Translates column values of given object to match external ones.
Protected method	TranslateColumnsToExternal(ICMSObject, TranslationHelper, Boolean)	Translates column values of given CMS object to match external ones.
Protected method	TranslateColumnsToExternal(TreeNode, TranslationHelper, Boolean)	Translates column values of given document to match external ones.

Extension Methods

	Name	Description
Public Extension Method	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
Public Extension Method	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Fields

	Name	Description
Protected field	externalTranslations	ID translation table [className.ToLowerCSafe()] -> Hashtable [ID -> "codename|sitename|parentid"]
Protected field	internalTranslations	ID translation table [className.ToLowerCSafe()] -> Hashtable [OldID -> NewID]

Properties

	Name	Description
Protected property	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().
Public property	ConnectorEnabled	Gets a value that indicates if the connector is enabled. (Inherited from AbstractIntegrationConnector.)
Public property	ConnectorID	Gets integration connector identifier. (Inherited from AbstractIntegrationConnector.)
Protected property	ConnectorInfo	Gets integration connector info object. (Inherited from AbstractIntegrationConnector.)
Public property	ConnectorName	Name of the connector. (Inherited from AbstractIntegrationConnector.)
Public property	LogIntegrationForExternalTasks	Determines whether to log integration tasks when processing external tasks. False by default.
Protected property	SyncManager	SyncManager instance.