Class DeploymentProvider

Namespace

Dynamicweb.Deployment

Assembly

Dynamicweb.Deployment.dll

Represents a provider which takes part in the the deployment process as either source or destination.

public abstract class DeploymentProvider

Inheritance

object

DeploymentProvider

LocalDeploymentProvider

RemoteDeploymentProvider

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Name

Gets the name.

public abstract string Name { get; }

Property Value

string

The name.

Url

Gets the URL.

public abstract Uri Url { get; }

Property Value

Uri

The URL.

Methods

CompareDataItems(DeploymentProvider, DataItemSelection)

Compares the data items.

public IEnumerable<Comparison> CompareDataItems(DeploymentProvider destination, DataItemSelection selection)

Parameters

destination DeploymentProvider

The destination.

selection DataItemSelection

The selection.

Returns

IEnumerable<Comparison>

DeployDataItemsFrom(string, Package)

Deploys the data items from.

public DeploymentInfo DeployDataItemsFrom(string id, Package package)

Parameters

id string

The identifier.

package Package

The package.

Returns

DeploymentInfo

DeployDataItemsTo(string, DeploymentProvider, ICollection<DataItemIdentifier>)

Deploys the data items to.

public DeploymentInfo DeployDataItemsTo(string id, DeploymentProvider destination, ICollection<DataItemIdentifier> dataItemIdentifiers)

Parameters

id string

The identifier.

destination DeploymentProvider

The destination.

dataItemIdentifiers ICollection<DataItemIdentifier>

The data item identifiers.

Returns

DeploymentInfo

ExportDataItemsToPackage(string, ICollection<DataItemIdentifier>)

Deploys the data items to.

public ExportInfo ExportDataItemsToPackage(string id, ICollection<DataItemIdentifier> dataItemIdentifiers)

Parameters

id string

The identifier.

dataItemIdentifiers ICollection<DataItemIdentifier>

The data item identifiers.

Returns

ExportInfo

ExportPackage(string, DeploymentSet, Tracker)

Exports the package.

protected abstract Package ExportPackage(string id, DeploymentSet deploymentSet, Tracker tracker)

Parameters

id string

The identifier.

deploymentSet DeploymentSet

The deployment set.

tracker Tracker

The tracker.

Returns

Package

GetDataGroup(string)

Gets the data group.

public virtual DataGroup GetDataGroup(string dataGroupId)

Parameters

dataGroupId string

The data group identifier.

Returns

DataGroup

GetDataGroups()

Gets the data groups.

public abstract IEnumerable<DataGroup> GetDataGroups()

Returns

IEnumerable<DataGroup>

GetDataItem(DataItemType, string)

Gets the data item.

public virtual DataItem GetDataItem(DataItemType dataItemType, string dataItemId)

Parameters

dataItemType DataItemType

Type of the data item.

dataItemId string

The data item identifier.

Returns

DataItem

GetDataItemInfo(DataItemType, string)

Gets the data item information.

public virtual DataItemInfo GetDataItemInfo(DataItemType dataItemType, string dataItemId)

Parameters

dataItemType DataItemType

Type of the data item.

dataItemId string

The data item identifier.

Returns

DataItemInfo

GetDataItemInfos(DataItemSelection)

Gets the data item infos.

public abstract IEnumerable<DataItemInfo> GetDataItemInfos(DataItemSelection selection)

Parameters

selection DataItemSelection

The selection.

Returns

IEnumerable<DataItemInfo>

GetDataItemInfos(DataItemType)

Gets the data item infos.

public virtual IEnumerable<DataItemInfo> GetDataItemInfos(DataItemType dataItemType)

Parameters

dataItemType DataItemType

Type of the data item.

Returns

IEnumerable<DataItemInfo>

GetDataItemInfosAsync(DataItemSelection)

protected virtual Task<IEnumerable<DataItemInfo>> GetDataItemInfosAsync(DataItemSelection selection)

Parameters

selection DataItemSelection

Returns

Task<IEnumerable<DataItemInfo>>

GetDataItems(DataItemSelection)

Gets the data items.

public abstract IEnumerable<DataItem> GetDataItems(DataItemSelection selection)

Parameters

selection DataItemSelection

The selection.

Returns

IEnumerable<DataItem>

GetDataItems(DataItemType)

Gets the data items.

public virtual IEnumerable<DataItem> GetDataItems(DataItemType dataItemType)

Parameters

dataItemType DataItemType

Type of the data item.

Returns

IEnumerable<DataItem>

GetDeploymentStatus(string)

Gets the deployment status.

public virtual ApplicationResponse<TrackingState> GetDeploymentStatus(string id)

Parameters

id string

The identifier.

Returns

ApplicationResponse<TrackingState>

GetSystemInformation()

Gets the system information.

public abstract Dictionary<string, string> GetSystemInformation()

Returns

Dictionary<string, string>

A dictionary of system information

ImportPackage(string, Package, Tracker)

Imports the package.

protected abstract void ImportPackage(string id, Package package, Tracker tracker)

Parameters

id string

The identifier.

package Package

The package.

tracker Tracker

The tracker.

VerifyCompatibility(DeploymentProvider, out ICollection<string>)

Verifies compatibility.

public bool VerifyCompatibility(DeploymentProvider destination, out ICollection<string> differences)

Parameters

destination DeploymentProvider

The destination.

differences ICollection<string>

Returns

bool

VerifyConnection()

Verifies the connection.

public virtual bool VerifyConnection()

Returns

bool