Table of Contents

Class FileCompressionSettings

Namespace
ArcanaDevelopment.adTempus.Shared.FileOperations
Assembly
ArcanaDevelopment.adTempus.Shared.dll

Contains settings for a file compression file transfer operation (copy, move, delete).

[DataContract]
public sealed class FileCompressionSettings : FileOperationTaskSettings
Inheritance
object
FileCompressionSettings

Constructors

FileCompressionSettings(string) 

public FileCompressionSettings(string operationType)

Parameters

NameTypeDescription
operationType string

Fields

OperationTypeNameCompress 

public const string OperationTypeNameCompress = "compress"

Field Value

string

OperationTypeNameUncompress 

public const string OperationTypeNameUncompress = "uncompress"

Field Value

string

Properties

Action

The action to take (compress or uncompress).

[ExtensionMember(IncludeInSearch = false, IncludeInProjection = true)]
[DataMember]
public CompressionOperation Action { get; set; }

Property Value

CompressionOperation

CompressionAlgorithm

The compression algorithm to use, if the CompressionType supports more than one algorithm.

[ExtensionMember(IncludeInSearch = false, IncludeInProjection = true)]
[DataMember]
public string CompressionAlgorithm { get; set; }

Property Value

string

CompressionLevel

The compression level to use, if supported by the CompressionType

[ExtensionMember(IncludeInSearch = false, IncludeInProjection = true)]
[DataMember]
public int? CompressionLevel { get; set; }

Property Value

int?

CompressionType

The type of compression (ZIP, BZIP, etc.) to use.

[ExtensionMember(IncludeInSearch = false, IncludeInProjection = true)]
[DataMember]
public string CompressionType { get; set; }

Property Value

string

Remarks

The SupportedCompressionTypes property returns a list of the valid compression types. Setting CompressionType to an unsupported type will produce either a data validation error at save or an error at job execution.

See Also

CreateSubdirectoryForArchive

Determines whether a subdirectory will be created for each archive being uncompressed.

[ExtensionMember(IncludeInSearch = false, IncludeInProjection = true)]
[DataMember]
public bool CreateSubdirectoryForArchive { get; set; }

Property Value

bool

Remarks

If CreateSubdirectoryForArchive is True, a directory will be created under the directory specified in TargetName, named with the base name of the archive (without extension). For example, if TargetName is "c:\temp" and the archive being extracted is "files1.zip", the files from the ZIP will be extracted to "c:\temp\files1". This is useful when multiple archives are being processed and may have files with the same name.

DeleteSource

Determines whether the source files are deleted after successful operation.

[ExtensionMember(IncludeInSearch = false, IncludeInProjection = true)]
[DataMember]
public bool DeleteSource { get; set; }

Property Value

bool

EncryptionAlgorithm

The encryption algorithm to use if a password is specified.

[ExtensionMember(IncludeInSearch = false, IncludeInProjection = true)]
[DataMember]
public string EncryptionAlgorithm { get; set; }

Property Value

string

Remarks

The password is specified using ArcanaDevelopment.adTempus.Client.FileOperationTask.SetEncryptedData1

OperationType

A string constant indicating the operation type.

public override string OperationType { get; }

Property Value

string

SupportedCompressionTypes

A list of all the CompressionType values supported by this version of adTempus.

public static string[] SupportedCompressionTypes { get; }

Property Value

string[]
See Also

Methods

DoValidation(MessageCollection)

Performs validation of the settings

public override void DoValidation(MessageCollection messages)

Parameters

NameTypeDescription
messages MessageCollection

Collection of messages that any validation messages will be added to

IsSupportedCompressionType(string) 

[Pure]
public static bool IsSupportedCompressionType(string value)

Parameters

NameTypeDescription
value string

Returns

bool

Inherited Members