Table of Contents

Class FileServiceProvider

Namespace
ArcanaDevelopment.adTempus.Client
Assembly
ArcanaDevelopment.adTempus.Client.dll

Settings for connecting to a file server (ftp server, etc.)

public class FileServiceProvider : ADTIndependentObject
Inheritance
object
FileServiceProvider
Derived

Properties

ClassID

The Class ID for the object

[IgnoreDataMember]
public override ClassID ClassID { get; }

Property Value

ClassID

ClassKeyName

The key name for the class.

public override string ClassKeyName { get; }

Property Value

string

Remarks

This name the name used by adTempus to identify the class and is intended for programmatic use only. Use the ClassName for a user-friendly name.

Enabled

Determines whether this provider is enabled

public bool Enabled { get; set; }

Property Value

bool

Remarks

If the provider is disabled, jobs that use it will fail.

IsCloudService

Indicates whether the provider is a cloud storage provider.

public bool IsCloudService { get; }

Property Value

bool

Remarks

ServiceType must be set

IsDependent

Indicates whether the object is a dependent of (owned by) another object

[IgnoreDataMember]
public override bool IsDependent { get; }

Property Value

bool

Remarks

An independent object (IsDependent is false) is an object that can exist on its own without being part of another object. For example, Jobs, Job Groups, etc.

A dependent object (IsDependent is true) is a part of another object. For example, a JobStep cannot exist independently of a Job, so the JobStep is dependent.

Dependent objects cannot be directly fetched from the server: they are only fetched as part of the object they belong to. They also cannot be saved or deleted independently: they are automatically saved or deleted when the owning object is saved or deleted.

ServiceName

Display name for the service

public string ServiceName { get; set; }

Property Value

string

ServiceType

The type of service. From FileServiceTypes

public string ServiceType { get; }

Property Value

string

SupportsBackup

Indicates whether the provider supports making a backup before overwriting a file.

public bool SupportsBackup { get; }

Property Value

bool

Remarks

ServiceType must be set

Methods

GetObjectDescription()

Gets a description of the object's key settings.

protected override string GetObjectDescription()

Returns

string

Remarks

This method is called by GetDescription() to get a user-friendly description of the object (such as its key settings) for display to the user. The description should contain enough information to distinguish this object from others of the same class.

Test(string)

Tests to determine if a successful connection can be made using the settings

public MessageCollection Test(string testData)

Parameters

NameTypeDescription
testData string

Reserved

Returns

MessageCollection

A collection of messages indicating the results or errors encountered

Remarks

If the test is successful the collection will contain a message with MessageType set to Informational and the HighestSeverity() will be Informational. Otherwise the collection will contain one or more messages giving more information about the problem

WriteToConfigurationReport(IADTObjectConfigurationReportWriter)

Writes the object and any contained objects to a configuration report

public override void WriteToConfigurationReport(IADTObjectConfigurationReportWriter reportBuilder)

Parameters

NameTypeDescription
reportBuilder IADTObjectConfigurationReportWriter

The report builder to write the object to.

Inherited Members