Class MirroringTransferProviderBase
The bas class for transfering mirroring job. The Mirrorring transfering protocol is based on provider base for the custom implementation should inherits this class. There are a few abstract method which be called on the instance when the mirrorin is starting The InitializeMirroring is a synchronize method which returns a MirroringStatus. If the Status is OK then the mirroring frameworks(Export component) calls other methods which are asyncronize. The communication between the MirroringFramework(Export component) and the MTP (Mirrroing transfer protocol) should be via MirroringTransferStatusEvent If there is problem in transfering an MirroringTransferStatusEvent should be fired.
Namespace: EPiServer.MirroringService.MirroringTransferProtocol.Common
Assembly: EPiServer.Enterprise.dll
Version: 8.11.0Syntax
public abstract class MirroringTransferProviderBase : ProviderBaseConstructors
MirroringTransferProviderBase()
Declaration
protected MirroringTransferProviderBase()Properties
DestinationBasePath
Gets or sets the basePath for EPiServer.Framework.AppData.BasePath for destination service.
Declaration
public virtual string DestinationBasePath { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The name of the destination connection string. |
DestinationConnectionStringName
Gets or sets the name of the destination connection string.
Declaration
public virtual string DestinationConnectionStringName { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The name of the destination connection string. |
DestinationPath
Gets or sets the destination path.
Declaration
public virtual string DestinationPath { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The destination path. |
DestinationUri
Declaration
public virtual string DestinationUri { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
NumberofFilesInpackage
Gets or sets the numberof files inpackage.
Declaration
public virtual int NumberofFilesInpackage { get; set; }Property Value
| Type | Description |
|---|---|
| System.Int32 | The numberof files inpackage. |
NumberofPagesInpackage
Gets or sets the numberof pages inpackage.
Declaration
public virtual int NumberofPagesInpackage { get; set; }Property Value
| Type | Description |
|---|---|
| System.Int32 | The numberof pages inpackage. |
SourcePath
Gets or sets the source path.
Declaration
public virtual DirectoryInfo SourcePath { get; set; }Property Value
| Type | Description |
|---|---|
| System.IO.DirectoryInfo | The source path. |
SyncExternalData
Declaration
public bool SyncExternalData { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
Methods
Cleanup(Guid, MirroringStatus)
Cleanups the Mirroring job.
Declaration
public virtual void Cleanup(Guid context, MirroringStatus mirroringStatus)Parameters
| Type | Name | Description |
|---|---|---|
| System.Guid | context | The context. |
| MirroringStatus | mirroringStatus | The mirroring status. |
CompleteMirroring(Guid)
Completes the mirroring.
Declaration
public abstract void CompleteMirroring(Guid context)Parameters
| Type | Name | Description |
|---|---|---|
| System.Guid | context | The context. |
CreateInstance(ProviderSettings, MirroringData)
Declaration
public static MirroringTransferProviderBase CreateInstance(ProviderSettings providerSettings, MirroringData MirroringData)Parameters
| Type | Name | Description |
|---|---|---|
| System.Configuration.ProviderSettings | providerSettings | |
| MirroringData | MirroringData |
Returns
| Type | Description |
|---|---|
| MirroringTransferProviderBase |
Initialize(String, NameValueCollection)
Initializes the provider.
Declaration
public override void Initialize(string name, NameValueCollection config)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name | The friendly name of the provider. |
| System.Collections.Specialized.NameValueCollection | config | A collection of the name/value pairs representing the provider-specific attributes specified in the configuration for this provider. |
Exceptions
| Type | Condition |
|---|---|
| System.ArgumentNullException | The name of the provider is null. |
| System.ArgumentException | The name of the provider has a length of zero. |
| System.InvalidOperationException | An attempt is made to call System.Configuration.Provider.ProviderBase.Initialize(System.String,System.Collections.Specialized.NameValueCollection) on a provider after the provider has already been initialized. |
InitializeMirroring(Guid, MirroringInitializeData)
Initializes the mirroring.
Declaration
public abstract MirroringStatus InitializeMirroring(Guid context, MirroringInitializeData mirroringInitializeData)Parameters
| Type | Name | Description |
|---|---|---|
| System.Guid | context | The context. |
| MirroringInitializeData | mirroringInitializeData | The mirroring initialize data. |
Returns
| Type | Description |
|---|---|
| MirroringStatus |
OnMirroringStatus(MirroringStatusEventArgs)
Raises the MirroringTransferStatusEventHandler event.
Declaration
protected void OnMirroringStatus(MirroringStatusEventArgs e)Parameters
| Type | Name | Description |
|---|---|---|
| MirroringStatusEventArgs | e | The MirroringStatusEventArgs instance containing the event data. |
ProcessFilePackage(Guid, String)
Processes the file package.
Declaration
public abstract void ProcessFilePackage(Guid context, string filePath)Parameters
| Type | Name | Description |
|---|---|---|
| System.Guid | context | The context. |
| System.String | filePath | The file path. |
ProcessPackage(Guid, String)
Processes the package.
Declaration
public abstract void ProcessPackage(Guid context, string filePath)Parameters
| Type | Name | Description |
|---|---|---|
| System.Guid | context | The context. |
| System.String | filePath | The file path. |
Validate(NameValueCollection, out String)
Declaration
public virtual bool Validate(NameValueCollection configurationParameters, out string errorMessage)Parameters
| Type | Name | Description |
|---|---|---|
| System.Collections.Specialized.NameValueCollection | configurationParameters | The parameters to validate |
| System.String | errorMessage | Error message that will be displayed, if any |
Returns
| Type | Description |
|---|---|
| System.Boolean | true if valid else false |
Events
MirroringTransferStatusEventHandler
Occurs when [mirroring transfer status event handler].
Declaration
public event MirroringTransferStatusEventHandler MirroringTransferStatusEventHandlerEvent Type
| Type | Description |
|---|---|
| MirroringTransferStatusEventHandler |
