Class SftpServer

Namespace

ArcanaDevelopment.adTempus.Client

Assembly

ArcanaDevelopment.adTempus.Client.dll

public sealed class SftpServer : FileServiceProvider, IFileServiceProviderSupportsProxy

Inheritance

object

ObjectBase

ADTObject

ADTIndependentObject

FileServiceProvider

SftpServer

Implements

IFileServiceProviderSupportsProxy

Fields

DefaultPort

public const int DefaultPort = 22

Field Value

int

Properties

ClientIPAddress

public string ClientIPAddress { get; set; }

Property Value

string

ClientIdentifier

public string ClientIdentifier { get; set; }

Property Value

string

ConnectionRetryDelay

Amount of time to wait between retries if MaxOperationRetries is set.

public TimeSpan? ConnectionRetryDelay { get; set; }

Property Value

TimeSpan?

FilenameCharset

public string FilenameCharset { get; set; }

Property Value

string

ForceCipher

public string ForceCipher { get; set; }

Property Value

string

ForceV3

public bool ForceV3 { get; set; }

Property Value

bool

HostCertificateThumbprint

public string HostCertificateThumbprint { get; set; }

Property Value

string

MaxConnectionRetries

Maximum number of times to attempt to open a connection to the server.

public int? MaxConnectionRetries { get; set; }

Property Value

int?

Remarks

If a connection cannot be made to the target server, adTempus will retry the connection at the interval specified by ConnectionRetryDelay, up to MaxOperationRetries times.

MaxOperationRetries

This setting is not currently used.

public int? MaxOperationRetries { get; set; }

Property Value

int?

NetworkTimeout

Maximum time to wait for a response from the server.

public TimeSpan? NetworkTimeout { get; set; }

Property Value

TimeSpan?

Remarks

The timeout counter is reset after each data packet received from the server. This value therefore does not specify the maximum length of a transfer; it only specifies the maximum amount of time to wait for a response from the server. Generally you will have no need to configure this.

Set time TimeSpan.Zero for no timeout. Set to to use the default timeout of 60 seconds.

OperationRetryDelay

This setting is not currently used.

public TimeSpan? OperationRetryDelay { get; set; }

Property Value

TimeSpan?

PasswordSet

public bool PasswordSet { get; }

Property Value

bool

Port

public int? Port { get; set; }

Property Value

int?

PreserveTimestampOnDownload

public bool PreserveTimestampOnDownload { get; set; }

Property Value

bool

PreserveTimestampOnUpload

public bool PreserveTimestampOnUpload { get; set; }

Property Value

bool

PrivateKeySet

public bool PrivateKeySet { get; }

Property Value

bool

ProxySettings

public FileServiceProxySettings ProxySettings { get; }

Property Value

FileServiceProxySettings

ReadTimeout

This setting is not currently used.

public TimeSpan? ReadTimeout { get; set; }

Property Value

TimeSpan?

ServerAddress

public string ServerAddress { get; set; }

Property Value

string

UseTempFile

Determines whether a temporary file will be used during uploads

public bool UseTempFile { get; set; }

Property Value

bool

Remarks

If true adTempus will upload to a temporary file and then rename the temporary file to the final name after upload completes. If false the file will be uploaded directly to the final name.

This setting is only valid for adTempus server version 5.0 or later. For earlier versions use the global option "FileTransfer:UseTempFileForUpload" to control this behavior.

UserID

public string UserID { get; set; }

Property Value

string

ValidateServerCertificate

public bool ValidateServerCertificate { get; set; }

Property Value

bool

Methods

SetPassword(string)

public void SetPassword(string password)

Parameters

Name	Type	Description
password	string

SetPrivateKey(string)

public void SetPrivateKey(string key)

Parameters

Name	Type	Description
key	string

Inherited Members

• ClassKeyName
• IsDependent
• ClassID
• WriteToConfigurationReport(IADTObjectConfigurationReportWriter)
• ServiceType
• ServiceName
• Enabled
• Test(string)
• IsCloudService
• SupportsBackup
• ApiKey
• SetApiSecret(string)
• ApiSecretSet
• Refresh()
• Revert()
• Save()
• Save(out MessageCollection)
• SaveWithAuditOrSnapshot(ChangeLogParameters)
• SaveWithAuditOrSnapshot(ChangeLogParameters, out MessageCollection)
• Delete()
• DeleteWithAuditOrSnapshot(ChangeLogParameters)
• GetSecurityDescriptor()
• ReplaceObjectReferences(string[], bool, int, IEnumerable<OID>, ADTObject, bool, ChangeLogParameters)
• GetObjectReferences(string[], bool, int, OID[])
• LastModified
• CreationTimestamp
• FromController
• CustomProperties
• Description
• DescriptionTextType
• OID
• BindingDescription
• ToString()
• ParentObject
• CanPerform(SecurityPermission)
• Duplicate()
• DataContext
• AccessMask
• Validate(MessageCollection)
• SupportedSecurityActions
• SupportedSecurityInheritanceOptions
• GetTopLevelOwner()
• GetConfigurationReport()
• GetConfigurationReport(bool)
• IsReadOnly
• IsDirty
• IsNew
• IsStub
• ClassName
• GetDescriptionWithClassName()
• GetDescription()
• BeginEdit()
• BeginEdit(UndoLevelAction)
• CommitEdit(Guid)
• CommitEdit()
• UndoEdit()
• UndoEdit(Guid)