CMS.SynchronizationEngine
Staging event arguments
Synchronization task
Staging handler
Initiates the event handling
Task object
Staging events
Fires on the source server when the staging synchronizes task or a bulk of tasks to the server
Fires on the source server when the staging synchronizes task to a server
Fires on the target server when the staging processes task
Synchronization event arguments
Task type
Object type
Task data
Task binary data
Staging handler
Initiates the event handling
Task type
Object type
Task data
Task binary data
Class that needs to be inherited during implementing custom integration connector.
Several members have to be implemented in order to achieve desired functionality.
ID translation table [className.ToLowerCSafe()] -> Hashtable [OldID -> NewID]
ID translation table [className.ToLowerCSafe()] -> Hashtable [ID -> "codename|sitename|parentid"]
SyncHelper instance.
Says whether to clear cached translation information.
Processes incoming task.
Object or document to process (either already prepared ICMSObject or raw external object)
What to do if the processing fails
Type of task
Type of input data
Name of the target site
Processes incoming task.
Object or document to process
What to do if the processing fails
Type of task
Type of input data
Name of the target site
Suitable for implementing outcoming CMS object processing. Identifiers of object is already prepared to match external application.
CMS object to process (accepts TreeNode or GeneralizedInfo)
Type of task
Type of data
Possible error message
Name of site
Translation helper object containing translations for given object
Processing result
Suitable for implementing synchronous outcoming CMS object processing.
CMS object to process
Type of task
Possible error message
Name of site
Processing result
Performs a request to a special page on server defined by given url causing immediate task processing for all connectors.
URL of the server to make the request to
Performs a request to a special page on server defined by given url causing immediate task processing for connector specified by name.
URL of the server to make the request to
Name of connector to notify
Processes single internal task.
Task info object
Processing result
Processes single external task.
Task info object
Processing result
Fetches internal tasks and processes them one by one.
Fetches external tasks and processes them one by one.
Processes given internal tasks one by one.
Tasks to process
Checks the license for IntegrationBus feature.
Processes given external tasks one by one.
Tasks to process
Assigns given subscription to this connector.
Subscription to add
Subscribes this connector to given type of task.
Type of task processing (sync/async etc.)
Type of task to subscribe to
Subscribes this connector to given types of tasks for object processing.
Type of task processing (sync/async etc.)
Types of tasks to subscribe to
Subscribes this connector to given types of object.
Type of task processing (sync/async etc.)
Type of object to subscribe to
Subscribes this connector to process tasks matching given conditions.
Type of task processing (sync/async etc.)
Type of object to subscribe to
Types of tasks to subscribe to
Subscribes this connector to process tasks matching given conditions.
Type of task processing (sync/async etc.)
Type of object to subscribe to
Name of site to subscribe to
Types of tasks to subscribe to
Subscribes this connector to process tasks matching given conditions.
Type of task processing (sync/async etc.)
Type of task to subscribe to
Types of objects to subscribe to
Subscribes this connector to process tasks matching given conditions.
Type of task processing (sync/async etc.)
Type of task to subscribe to
Name of site to subscribe to
Types of objects to subscribe to
Subscribes this connector to given types of tasks for document processing.
Type of task processing (sync/async etc.)
Types of tasks to subscribe to
Subscribes this connector to given class names.
Type of task processing (sync/async etc.)
Name of class to subscribe to
Subscribes this connector to process tasks matching given conditions.
Type of task processing (sync/async etc.)
Name of class to subscribe to
Types of tasks to subscribe to
Subscribes this connector to process tasks matching given conditions.
Type of task processing (sync/async etc.)
Name of class to subscribe to
Name of site to subscribe to
Types of tasks to subscribe to
Subscribes this connector to process tasks matching given conditions.
Type of task processing (sync/async etc.)
Type of task to subscribe to
Names of classes to subscribe to
Subscribes this connector to process tasks matching given conditions.
Type of task processing (sync/async etc.)
Type of task to subscribe to
Name of site to subscribe to
Names of classes to subscribe to
Prepares translations for external document or object to enable identifying corresponding internal object.
External CMS object
Type of data
Translations
Translates column values of given object to match external ones.
Internal object
Translations
Whether to translate columns of child objects
Translates column values of given document to match external ones.
Internal document
Translations
Whether to translate columns of child objects
Translates column values of given CMS object to match external ones.
Internal CMS object
Translations
Whether to translate columns of child objects
Handles FK translations
Export settings object
Object (TreeNode / Info object) to process
Column name of the dependency
Object type of the dependency
Determines whether the dependency is required (reflects required flag from TypeInfo).
Handles FK translations
Export settings object
Object (TreeNode / Info object) to process
Column name of the dependency
Object type of the dependency
Determines whether the dependency is required (reflects required flag from TypeInfo).
Handles FK translations
Export settings object
Object ID of the dependency
Object type of the dependency
Gets message customized for NotImplementedException (for internal purpopses only).
Direction (true for external tasks, false for internal tasks)
Sets translation for class name and identifier.
Class name
Old identifier
New identifier
Gets translation for class name and identifier.
Class name
Old identifier
New identifer if present
Clears hashtable with internal translations
Sets translation for class name and identifier.
Class name
External identifier
Translation record ("codename|sitename|parentid")
Gets translation for class name and identifier.
Class name
External identifier
Translation record ("codename|sitename|parentid|groupid")
Clears hashtable with external translations
Suitable for implementation of asynchronous outcoming object processing. Identifiers of object are already prepared to match external application.
Object to process
Translation helper object containing translations for given object
Type of task
Type of data
Name of site
Possible error message
Processing result
Suitable for implementation of asynchronous outcoming document processing. Identifiers of document are already prepared to match external application.
Document to process
Translation helper object containing translations for given document
Type of task
Type of data
Name of site
Possible error message
Processing result
Suitable for implementation of synchronous outcoming object processing. Identifiers of object are in their original state.
Object to process
Type of task
Name of site
Possible error message
Processing result
Suitable for implementation of synchronous outcoming document processing. Identifiers of object are in their original state.
Document to process
Type of task
Possible error message
Name of site
Processing result
Based on parameters this method will find out identifier of the object matching external application.
Type of object
Code name of object
Site name of object
Type of parent object
Parent object identifier
Group identifier
Object identifier for external usage
Based on parameters this method will find out identifier of the document matching external application.
Document unique identifier
Document culture code
Document site name
Whether to return document or node identifier
Document identifier for external usage
By supplying object type and identifier the method ensures filling output parameters needed for correct translation between external and internal object.
Identifier of the object
Type of the object
Returns code name
Returns site name
Returns identifier of parent object
Returns identifier of object community group
By supplying document identifier and class name the method ensures filling output parameters needed for correct translation between external and internal document.
Identifier of the document
Class name of the document
Returns document unique identifier
Returns culture code
Returns site name
Transforms given external object to internal (to TreeNode or GeneralizedInfo).
Object or document to transform
Type of task
Type of input data
Name of site
Determines whether to log integration tasks when processing external tasks.
False by default.
Fetches internal integration tasks for processing.
Fetches external integration tasks for processing.
SyncHelper instance.
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().
Provides an ITask interface for external integration task synchronization.
Executes external integration tasks synchronization.
Scheduling task info object
Possible error
Class representing subscription to documents or objects
Default constructor
Name of connector the subscription is attached to
Type of task processing (sync/async etc.)
Type of task which to subscribe to
Name of site which to subscribe to (accepts '%' as a wildcard representing 0-n characters)
Determines whether given CMS object and task type match the subscription.
This method recognizes TreeNode and GeneralizedInfo as the CMS object.
CMS object to match
Task type to match
Returns type of task processing
TRUE if the CMS object and task correspond with subscription settings
Determines whether given info object and task type match the subscription
Info object to match
Task type to match
Returns type of task processing
TRUE if the info object and task correspond with subscription settings
Determines whether given node and task type match the subscription
Node to match
Task type to match
Returns type of task processing
TRUE if the node and task correspond with subscription settings
Determines whether given task type matches the TaskType property
Task type to evaluate
Returns type of task processing
TRUE if task type is equal to TaskType property
Determines whether given site name matches the SiteName property
Name of site to evaluate
TRUE if site name matches SiteName property
Returns regular expression with pattern used to match words like 'cms.%' or 'cms.pagetemplate%' where '%' represents with 0-n characters
User-friendly expression to transformate to regular expression
Regular expression object
Type of task processing (sync/async etc.)
Task type of document or object to match.
Site name of document or object to match.
Use AbstractIntegrationSubscription.GLOBAL_OBJECTS to match only global objects.
Name of connector the subscription is attached to.
Class representing subscription to documents
Default constructor
Name of connector the subscription is attached to
Type of task processing (supported: AsyncSimple, AsyncSimpleSnapshot, SyncSnapshot)
Type of task which to subscribe to
Name of site which to subscribe to (accepts '%' as a wildcard representing 0-n characters)
Node alias path of document which to subscribe to (accepts '%' as a wildcard representing 0-n characters)
Culture code of document which to subscribe to (accepts '%' as a wildcard representing 0-n characters)
Class name of document which to subscribe to (accepts '%' as a wildcard representing 0-n characters)
Determines whether given node and task type match the subscription
TreeNode to match
Task type to match
Returns type of task processing
TRUE if the node and task correspond with subscription settings
Alias path of document to match
Culture code of document to match
Class name of document to match
Class representing subscription to objects
Default constructor
Name of connector the subscription is attached to
Type of task processing (sync/async etc.)
Type of task which to subscribe to
Name of site which to subscribe to (accepts '%' as a wildcard representing 0-n characters)
Type of object which to subscribe to (accepts '%' as a wildcard representing 0-n characters)
Code name of object which to subscribe to (accepts '%' as a wildcard representing 0-n characters)
Determines whether given info object and task type match the subscription
GeneralizedInfo to match
Task type to match
Returns type of task processing
TRUE if the info object and task correspond with subscription settings
Type of object to match
Code name of object to match
Helper class for synchronization methods.
Administrator user ID.
Gets the instance of the helper.
Processes the given task.
Type of the task
Task object type
Document/object data for the synchronization task
Binary data for the synchronization task
Processes the given task.
Type of the task
Task object type
Document/object data for the synchronization task
Binary data for the synchronization task
Indicates if also child objects should be processed
Processes the given task.
Type of the task
Task object type
Document/object data for the synchronization task
Binary data for the synchronization task
Indicates if also child objects should be processed
Synchronization handler
Gets synchronization task empty DataSet for specified task type.
Task type
Document class name (optional)
Task object type (optional)
Returns the dataset loaded from the given task data.
Task data to make the DataSet from
Task type
Object type
Updates the object.
Object data
Binary data
Task object type
Translation helper
If true, assigns the object to the site
Indicates if child objects should be updated
Updates the object.
Object type definition to process
DataSet with the object data
Translation table
Indicates if child objects should be updated
DataSet with binary data
If true, assigns the objects to the site
Indicates if synchronization tasks should be logged
Returns last processed object
Indicates if the object supports post processing
Info object
Updates the object.
Object to update
DataSet with the object data
Translation table
Indicates if child objects should be updated
DataSet with binary data
If true, assigns the object to the site
List of objects which should be processed after finishing of main objects
Creates a site binding. (Site is specified by SyncHelper.SiteID property.)
Binding object to create.
Identifier of bound object.
Deletes the object.
Object data
Object type
Removes the objects from site.
Object type definition to process
DataSet with the object data
Translation table
Removes the object from site.
Object to update
DataSet with the object data
Translation table
Removes the object from the site.
Object data
Task object type
Translation helper
Updates the document.
Document data
Class name of document in safe format
Indicates if also child objects should be processed
Publishes the document.
Document data
Class name of document in safe format
Archives the document.
Document data
Class name of document in safe format
Rejects the document.
Document data
Class name of document in safe format
Deletes the document.
Document data
Delete all culture versions
Class name of document in safe format
Moves the document.
Document data
Class name of document in safe format
Updates the relationships.
Document node
Relationships table
Updates the categories.
Document node
Categories table
Translation helper
Updates the document aliases.
Document node
Aliases table
Translation helper
Translates given node columns using data from helper.
Node to translate
Translation helper with the data
Translates the user reference column of the document
Document node
Translation helper
Column name
Translates the given page template column of the document
Document node
Translation helper
Column name
Determines whether to continue with translation operations.
Current translation helper object
TRUE if OperationType is other than Integration. When OperationType is Integration there also have to be some translations present.
Removes excluded column values from the given document.
Indicates if source has object table.
Type of the object
Source data
Process media folder task.
Task type
DataSet with folder data
Update node with permissions from DataSet.
Node to process
DataSet with permissions tables
TranslationHelper
Break ACL inheritance.
Document data
Task type information
Class name of document in safe format
Gets synchronization task empty DataSet for specified task type.
Task type
Document class name (optional)
Task object type (optional)
Processes the given task.
Type of the task
Task object type
Document/object data for the synchronization task
Binary data for the synchronization task
Indicates if also child objects should be processed
Synchronization handler
Returns the dataset loaded from the given task data.
Task data to make the DataSet from
Task type
Object type
Gets physical files DataSet.
String representation of physical files data
Removes excluded column values from the given object.
Returns the full error message.
Administrator user ID.
TreeProvider object to use.
Workflow manager instance.
Version manager instance.
Gets ore sets the excluded columns of the document which are not staged.
Indicates if logging staging tasks is enabled.
Indicates if custom handlers should be used for document operations.
Indicates if automatic ordering for documents should be used on target server.
Defines the operation type.
Gets or sets current site name.
Gets ore sets the excluded columns of the object which are not staged.
Gets site ID.
Gets site ID for translation.
Current user.
X509 service assertion.
Constructor.
No client output filter.
No client input filter.
Service input filter.
No service output filter.
Reading the request.
Writes the XML.
X509 Service input filter.
Constructor.
Parent assertion
Filter context
Validates the message security.
Message envelope
Security context
Service policy
Constructor
Constructor.
Overall staging methods.
Authentication of the token was processed.
Hashtable of the X509 certificates indexed by keyIdentifier.
Returns true if the staging server is enabled.
Site name to check
Returns server authentication type for specified site.
Site name to check
Compares two byte arrays, returns true, if they are equal.
Array 1
Array 2
Returns the SHA1 hash byte array for given password string.
Password string
Returns the hash for the specified password.
Password to hash
Returns the task type string.
Task type
Returns the task type enumeration value.
String task type representation
Returns true if given client token is valid.
Token to check
Site name
Returns client token key.
Site name
Returns server token key.
Site name
Returns the security token for X509 authentication.
Token key identifier
Retrieves the X509 security token from the store.
Store location
Store name
Token key identifier
Returns true if given client token is valid.
Token to check
Site name
Returns true if given server token is valid.
Token to check
Site name
This method checks if the incoming message has signed all the important message parts such as soap:Body, all the addressing headers and timestamp.
Soap context to get the signing token for
Security context
The signing token
Checks the context signature of the message.
Vefies, if all the required message parts are present.
Soap context
Runs the task synchronization for specified server and list of task IDs.
DataSet with task IDs and titles to synchronize
Server ID
Runs also older tasks
Site ID (specifies the site which should be used to get the servers when no server is specified)
Log callback function
Runs the task synchronization for specified server and list of task IDs.
Task IDs to synchronize
Server ID
Runs also older tasks
Site ID (specifies the site which should be used to get the servers when no server is specified)
Log callback function
Sorts the given list of task IDs by their creation date (oldest go first).
Runs the task synchronization for specified server and list of tasks.
Tasks to synchronize
Server ID
Runs also older tasks
Site ID (specifies the site which should be used to get the servers when no server is specified)
Log callback function
Runs the synchronization.
Task ID
Server ID
Runs the task synchronization for specified server.
Task ID
Server ID
Runs also older tasks
Runs the task synchronization for specified server.
Task ID
Server ID
Runs also older tasks
Site ID (specifies the site which should be used to get the servers when no server is specified)
Runs the task synchronization for specified server.
Task ID
Server ID
Runs also older tasks
Site ID (specifies the site which should be used to get the servers when no server is specified)
If true, the task is synchronized on it's own
Runs the synchronization for a single task
Task data
Server ID
Site ID
Synchronizes the task on all enabled servers
Task ID
Run older tasks
Site ID
If true, the tasks should be executed as standalone tasks
Runs the older tasks for the given task
Original task
Server ID
Site ID
Logs the synchronization error.
Task ID
Server ID
Result
Indicates whether to delete instance global tasks (tasks belonging to servers with same ServerName) after synchronization
Automatic staging worker task.
Executes the publish action.
Task to process
Synchronization client.
Constructor, initializes synchronization service client for specified server.
Server data
Runs the synchronization task.
Task object
Returns error message
Returns the full error message.
Error message
Gets timeout for staging service.
Indicates if external configuration file should be used (wse3policy.config).
Gets or sets the value that indicates whether staging SOAP must understand.
Synchronization service.
Synchronization server.
Content staging service.
Processes the given synchronization task.
Title of the synchronization task
Type of the synchronization task
Document data for the synchronization task
Processes the given synchronization task.
Title of the synchronization task
Type of the synchronization task
Task object type
Document data for the synchronization task
System version
Processes the given synchronization task.
Title of the synchronization task
Type of the synchronization task
Task object type
Document data for the synchronization task
Binary data for the synchronization task
System version
Processes the given synchronization task.
Title of the synchronization task
Type of the synchronization task
Task object type
Document data for the synchronization task
Binary data for the synchronization task
List of servers, which already processed the synchronization task
System version
Returns the full error message.
Indicates if logging staging task is enabled.
Indicates if custom handlers should be used for document staging operations.
Indicates if automatic ordering for documents should be used on target server.
SyncHelper instance.
Module registration.
Constructor.
Module info
Initializes synchronization module
Registers the object type of this module
Remove object and child objects versions
Parameters array
Invalidates collections with connectors and subscriptions
Parameters array
Process synchronization task optionally with children
Parameters array
Web service authorization interface for username authentication.
Verifies the incoming username token.
Token to verify
Authentication function, returns the password for specified username.
Token to authorize against
X509 Security assertion.
Constructor.
Client certificate key ID
Server certificate key ID
Client output filter.
No client input filter.
No service input filter.
No service output filter.
Client certificate key ID.
Server certificate key ID.
Client output filter.
Constructor.
Parent assertion
Filter context
Secures the message context.
Message envelope
Security context
Class for document synchronization action
Executes action
Indicates if child documents should be included.
Indicates if document tasks should be explicitly logged.