Class DeploymentProvider
- Namespace
- Dynamicweb.Deployment
- Assembly
- Dynamicweb.Core.dll
Represents a provider which takes part in the the deployment process as either source or destination.
public abstract class DeploymentProvider
- Inheritance
-
DeploymentProvider
- Derived
- Inherited Members
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
DeploymentProviderThe destination.
selection
DataItemSelectionThe selection.
Returns
DeployDataItemsFrom(string, Package)
Deploys the data items from.
public DeploymentInfo DeployDataItemsFrom(string id, Package package)
Parameters
Returns
DeployDataItemsTo(string, DeploymentProvider, ICollection<DataItemIdentifier>)
Deploys the data items to.
public DeploymentInfo DeployDataItemsTo(string id, DeploymentProvider destination, ICollection<DataItemIdentifier> dataItemIdentifiers)
Parameters
id
stringThe identifier.
destination
DeploymentProviderThe destination.
dataItemIdentifiers
ICollection<DataItemIdentifier>The data item identifiers.
Returns
ExportDataItemsToPackage(string, ICollection<DataItemIdentifier>)
Deploys the data items to.
public ExportInfo ExportDataItemsToPackage(string id, ICollection<DataItemIdentifier> dataItemIdentifiers)
Parameters
id
stringThe identifier.
dataItemIdentifiers
ICollection<DataItemIdentifier>The data item identifiers.
Returns
ExportPackage(string, DeploymentSet, Tracker)
Exports the package.
protected abstract Package ExportPackage(string id, DeploymentSet deploymentSet, Tracker tracker)
Parameters
id
stringThe identifier.
deploymentSet
DeploymentSetThe deployment set.
tracker
TrackerThe tracker.
Returns
GetDataGroup(string)
Gets the data group.
public virtual DataGroup GetDataGroup(string dataGroupId)
Parameters
dataGroupId
stringThe data group identifier.
Returns
GetDataGroups()
Gets the data groups.
public abstract IEnumerable<DataGroup> GetDataGroups()
Returns
GetDataItem(DataItemType, string)
Gets the data item.
public virtual DataItem GetDataItem(DataItemType dataItemType, string dataItemId)
Parameters
dataItemType
DataItemTypeType of the data item.
dataItemId
stringThe data item identifier.
Returns
GetDataItemInfo(DataItemType, string)
Gets the data item information.
public virtual DataItemInfo GetDataItemInfo(DataItemType dataItemType, string dataItemId)
Parameters
dataItemType
DataItemTypeType of the data item.
dataItemId
stringThe data item identifier.
Returns
GetDataItemInfos(DataItemSelection)
Gets the data item infos.
public abstract IEnumerable<DataItemInfo> GetDataItemInfos(DataItemSelection selection)
Parameters
selection
DataItemSelectionThe selection.
Returns
GetDataItemInfos(DataItemType)
Gets the data item infos.
public virtual IEnumerable<DataItemInfo> GetDataItemInfos(DataItemType dataItemType)
Parameters
dataItemType
DataItemTypeType of the data item.
Returns
GetDataItemInfosAsync(DataItemSelection)
protected virtual Task<IEnumerable<DataItemInfo>> GetDataItemInfosAsync(DataItemSelection selection)
Parameters
selection
DataItemSelection
Returns
GetDataItems(DataItemSelection)
Gets the data items.
public abstract IEnumerable<DataItem> GetDataItems(DataItemSelection selection)
Parameters
selection
DataItemSelectionThe selection.
Returns
GetDataItems(DataItemType)
Gets the data items.
public virtual IEnumerable<DataItem> GetDataItems(DataItemType dataItemType)
Parameters
dataItemType
DataItemTypeType of the data item.
Returns
GetDeploymentStatus(string)
Gets the deployment status.
public virtual ApplicationResponse<TrackingState> GetDeploymentStatus(string id)
Parameters
id
stringThe identifier.
Returns
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
VerifyCompatibility(DeploymentProvider, out ICollection<string>)
Verifies compatibility.
public bool VerifyCompatibility(DeploymentProvider destination, out ICollection<string> differences)
Parameters
destination
DeploymentProviderThe destination.
differences
ICollection<string>The information differences.
Returns
VerifyConnection()
Verifies the connection.
public virtual bool VerifyConnection()