WebSyncHelper Class

Web sync helper.

Inheritance Hierarchy

System.Object
  CMS.WebFarmSync.WebSyncHelper

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

Syntax

public class WebSyncHelper

The WebSyncHelper type exposes the following members.

Constructors

	Name	Description
Public method	WebSyncHelper

Methods

	Name	Description
Public method Static member	Clear	Clears the hashtables of web farm servers.
Public method Static member	CreateTask	Creates task.
Public method Static member	DeleteDynamicServer	Deletes the dynamic web farm server
Public method Static member	DeleteMemorySynchronizationTasks	Deletes memory synchronization web farm tasks.
Public method Static member	DeleteTask	Removes task for specified server.
Public method Static member	GetAllEnabledServers	Obsolete. Returns the DataSet of all the enabled servers records.
Public method Static member	GetAzureWebFarmName	Constructs the name for web farms when running on Azure.
Public method Static member	GetEnabledServerNames	Obsolete. Gets the list of currently enabled server names.
Public method Static member	GetNotificationPath	Gets default notification path for given server physical path
Public method Static member	GetServerTasks	Returns dataset with tasks to specified server.
Public method Static member	GetTaskBinaryData	Returns task binary data.
Public method Static member	GetWebFarmUpdater	Returns web farm updater instance.
Public method Static member	InitWebFarm	Initializes the web farm environment
Public method Static member	IsFileSynchronizationAllowed	Returns value which indicates whether current file is allowed to web farm synchronization.
Public method Static member	IsServerEnabled	Obsolete. Returns true if the server with given ID is enabled
Public method Static member	NotifyServer(Int32)	Notifies a web farm server about a new task.
Public method Static member	NotifyServer(String)	Notifies a web farm server about a new task.
Public method Static member	NotifyServers	Notifies other servers that some changes occurred
Public method Static member	ProcessMyTasks	Reads all tasks assigned to the current server and processes them. It processes only tasks for the server with code name stored in the CMSWebFarmServerName web.config variable.
Public method Static member	ProcessTask	Processes the specified task and deletes it.
Public method Static member	RegisterWatchers	Initializes file system watchers
Public method Static member	RegisterWebFarmMemoryTask	Registers the given task as the memory only task
Public method Static member	SetErrorInTask	Sets the error message to the specified task.

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
Public field Static member	NOTIFY_FILENAME	File name of the file for web farm server notification

Properties

	Name	Description
Public property Static member	CurrentlyDeletedServerID	Gets or sets the ID of the currently deleted server.
Public property Static member	DeleteGeneratedWebFarmServers	Specifies whether generated web farm servers are deleted automatically on application end.
Public property Static member	EnabledServers	Gets the collection of enabled servers.
Public property Static member	GenerateWebFarmServers	Specifies whether web farm servers are generated automatically on first application start.
Public property Static member	InstanceIsHiddenWebFarmServer	Indicates that the instance is hidden part of the web farm.
Public property Static member	MaxWebFarmFileSize	Gets the maximal file size which is allowed for web farm synchronization.
Public property Static member	NotifyPath	Physical path to the watcher folder for web farm server notification.
Public property Static member	NotifyWatcher	File watcher to notify web farm server to process tasks.
Public property Static member	ScriptTimeout	Gets or sets the script timeout in seconds.
Public property Static member	ServerCount	Returns count of enabled web farm servers.
Public property Static member	ServerId	Server ID.
Public property Static member	ServerName	Server name.
Public property Static member	ServersToUpdate	Gets the collection of servers to be updated if needed. Current server is excluded.
Public property Static member	SynchronizeDeleteFiles	Gets or sets value that indicates whether file delete synchronization is enabled.
Public property Static member	SynchronizeFiles	Gets or sets value that indicates whether file synchronization is enabled.
Public property Static member	TeamDevelopmentEnabled	Gets a value that specifies whether the team development is enabled.
Public property Static member	UpdateWebFarmWithinRequest	Gets or sets the value that indicates whether web farm updater should be called within current request.
Public property Static member	UseDbWebFarmUpdater	Returns whether database web farm updater is used.
Public property Static member	UseTasksForExternalApplication	Indicates if synchronization tasks should be logged and processed for external applications.
Public property Static member	WebFarmEnabled	Gets or sets the value that indicates whether web farm for current server is enabled. Set value overrides only web config enable setting.
Public property Static member	WebFarmInstanceEnabled	Gets the value that indicates whether webfarm instance is enabled in configuration file
Public property Static member	WebFarmMemoryTasks	Gets list of all task types which synchronizes only memory objects.
Public property Static member	WebFarmReady	Returns whether are web farms ready.
Public property Static member	WebFarmUpdaterClass	Web farm updater class used to update web farm servers.
Public property Static member	WebFarmUpdaterPage	Gets or sets the web farm updater page location. Default page location: "/CMSPages/webfarmupdater.aspx"

Events

	Name	Description
Public event Static member	OnProcessCustomTask	Custom task event.