Table of Contents

Class RemoteAgentCredentialProfile

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

Overrides a CredentialProfile for a particular RemoteAgent

public sealed class RemoteAgentCredentialProfile : ADTObject
Inheritance
object
RemoteAgentCredentialProfile

Remarks

The RemoteAgentCredentialProfile allows you to specify different credentials for a profile to use on a particular RemoteAgent.

To define an override, create a new RemoteAgentCredentialProfile, set the RemoteAgent, add the RemoteAgentCredentialProfile to the CredentialProfile's AgentProfiles collection, and save the CredentialProfile.

Whenever the CredentialProfile is sent to the RemoteAgent, the credentials specified in the RemoteAgentCredentialProfile will be sent instead of the values defined for the CredentialProfile.

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.

CredentialProfile

The CredentialProfile this override applies to.

public CredentialProfile CredentialProfile { get; set; }

Property Value

CredentialProfile

Domain

Returns the domain portion of the UserID, if one is present.

public string Domain { get; }

Property Value

string

The domain name for the UserID, or an empty string if the UserID does not contain a domain.

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.

RemoteAgent

The RemoteAgent this override applies to.

public RemoteAgent RemoteAgent { get; set; }

Property Value

RemoteAgent

UserID

The user ID. Set to null to use the value specified for the CredentialProfile.

public string UserID { get; set; }

Property Value

string

UserName

Returns the user name portion of the UserID.

public string UserName { get; }

Property Value

string

The user name part of the UserID.

Methods

FindOwningObject()

Get the owner of this object based on relationships.

protected override ADTObject FindOwningObject()

Returns

ADTObject

The owning object, or null if the object is not owned by another object or the owner has not been set.

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.

SetPassword(string)

Sets the password to use for this override.

public void SetPassword(string newPassword)

Parameters

NameTypeDescription
newPassword string

The new password to use

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