IReplicationTarget Interface |
Represents a destination location to which published content is replicated as well as corresponding settings for this location.
Namespace: Ingeniux.CMS
Assembly: Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 10.6.308
SyntaxThe IReplicationTarget type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | Archived |
Gets/sets the archived value of this entity
(Inherited from IEntity.) |
| Created |
Gets the entity's creation date.
(Inherited from IEntity.) |
| CreationUser |
Gets the ID of the User who created this entity.
(Inherited from IEntity.) |
| Description |
Gets and sets the detailed description of this target.
|
| Disabled |
Gets and sets whether this target is disabled. Disabled targets cannot perform replications.
|
| LastModified |
Gets the date when the entity was most recently modified.
(Inherited from IEntity.) |
| LastModifiedUser |
Gets the ID of the User who lasted edited the entity.
(Inherited from IEntity.) |
| Manager |
Gets the manager that retrieved this entity instance.
(Inherited from IEntityTManager.) |
| PostReplicationCommand |
Gets and sets the commands that are executed after replication on this target. Use standard Command Prompts (DOS) command syntax.
|
| PostReplicationCommandTimeout |
Gets and sets the timeout (in seconds) for PostReplicationCommand.
|
| PreReplicationCommand |
Gets and sets the commands that are executed before replication on this target. Uses standard Command Prompts (DOS) command syntax.
|
| PreReplicationCommandTimeout |
Gets and sets the timeout (in seconds) for PreReplicationCommand.
|
| PublishingTargetDirectory |
Gets the full path of the Publishing Target Folder to which this replication target belongs.
|
| Replicating |
Gets whether this target is currently performing a replication.
|
| RepTaskDetails |
Gets the details of the last-completed replication.
|
| RepTaskMonitor |
Gets the Monitor object that tracks an ongoing replication. This object will stick around.
|
| Session |
Gets the session that retrieved this entity. An entity is always session-specific.
(Inherited from IEntity.) |
| SessionId |
Gets the unique ID of the session that retrieved this entity.
(Inherited from IEntity.) |
 | Type |
Gets the full Type name of the target.
|
| UseCommands |
Gets and sets whether to execute the PreReplicationCommand and
PostReplicationCommand.
|
| UseWriteThrough |
Gets and sets if the system should write through any intermediate cache and go directly to disk during replication.
|
Methods| Name | Description | |
|---|---|---|
 | AddAdditionalLocation |
Adds a new Additional Location to this replication target.
|
| AddCleanupExemption |
Adds a new Cleanup Exempt Location to this replication target.
|
| AddExemptLocation |
Adds a new Exempt Location to this replication target.
|
| AdditionalLocations |
Retrieves the collection of Additional Locations for this replication target, in a paginated fashion.
|
| AdditionalLocationsCount |
Gets the count of Additional Locations for this replication target.
|
| CancelReplication |
Cancels an ongoing replication and updates the Task Monitor to the cancelled state.
|
| CleanReplicate |
Performs a replication that removes all Files from the replication destination that no longer exist in the
Publishing Target Folder.
|
| CleanupExemptLocations |
Retrieves the collection of Cleanup Exempt Locations for this replication target, in a paginated fashion.
|
| CleanupExemptLocationsCount |
Gets the count of Cleanup Exempt Locations for this replication target.
|
| ClearExemptionAndAdditionalLocations | |
| ExemptLocations |
Retrieves the collection of Exempt Locations for this Replication Target, in a paginated fashion.
|
| ExemptLocationsCount |
Gets the count of Exempt Locations for this replication target.
|
| Replicate |
Performs replication on this target.
|
| SetExclusiveReplicateItems |
Sets the files to be replicated, besides the Additional Locations.
Once this method is called, these are the only files from the Publishing Target Folder
that will be replicated.
|
| Touch |
Updated the entity's LastModified value to the current time.
(Inherited from IEntity.) |
| ValidateData |
Validates this entity's data. Implemented by concrete inheriting types.
(Inherited from IEntity.) |
| ValidateUserPermission |
Validates the user permission on the current entity. Implemented by concrete inheriting types.
It is called automatically upon saving an entity.
(Inherited from IEntity.) |
Events| Name | Description | |
|---|---|---|
 | AfterEntitySave |
This event is fired after a Entity object is saved.
(Inherited from IEntityEvents.) |
| BeforeEntitySave |
This event is fired before any Entity object is about to be saved.
(Inherited from IEntityEvents.) |
Examples
Serialization example:
XML
<ReplicationTarget Disabled="false" ID="FileReplicationTarget/21" Type="IGX.Replication.FileReplicationTarget" Name="dss04" Description="" UseCommands="false" TargetLocation="\\it-webcms04.eastern.ewu.edu\external_dss_content" ChangeDetectionOnContent="false" UseImpersonation="true" TargetLocationAccessUserName="s-webcmsrpl" TargetLocationAccessUserDomain="eastern.ewu.edu" TargetLocationAccessPassword="RDNxA5JhNQV8P481I5yuWCGtP6VLLKY99C8ApDQKF62BdHRp987hsgagrOlWrGEJ"> <PreReplicationCommand Timeout="10"> </PreReplicationCommand> <PostReplicationCommand Timeout="480">E:\igxsites\Sites\external\xml\Custom\media-servers-replication.bat</PostReplicationCommand> <ExemptLocations> <Exempt RelativePath="/PreBuilt/.svn/" ExemptAllFiles="true" ExemptDescendantDirectories="true" SearchPatterns=""/> <Exempt RelativePath="/StyleSheets/.svn/" ExemptAllFiles="true" ExemptDescendantDirectories="true" SearchPatterns=""/> </ExemptLocations> <AdditionalLocations/> <CleanupExemptLocations> <CleanupExempt RelativePath="/prebuilt/aspnet_client/" ExemptAllFiles="true" ExemptDescendantDirectories="true" SearchPatterns="" IsFile="false"/> </CleanupExemptLocations> </ReplicationTarget>
See Also