Class Aras​Http​Connection

The main implementation of a connection to an Aras instance over HTTP

Inheritance

System.​Object

Aras​Http​Connection

Inherited Members

System.​Object.​Equals(System.​Object, System.​Object)

System.​Object.​Get​Type()

System.​Object.​Memberwise​Clone()

System.​Object.​Reference​Equals(System.​Object, System.​Object)

System.​Object.​To​String()

Namespace: Innovator.​Client.​Connection

Assembly: Innovator.Client.dll

Syntax

public class ArasHttpConnection : IRemoteConnection, IDisposable, IArasConnection, IAsyncConnection, IConnection

Constructors

ArasHttpConnection(HttpClient, String, IItemFactory)

Initializes a new instance of the Aras​Http​Connection class.

Declaration

public ArasHttpConnection(HttpClient service, string innovatorServerUrl, IItemFactory itemFactory)

Parameters

Type	Name	Description
System.​Net.​Http.​Http​Client	service	The service.
System.​String	innovatorServerUrl	The innovator server URL.
IItem​Factory	itemFactory	The item factory.

Properties

AmlContext

AML context used for creating AML objects and formatting AML statements

Declaration

public ElementFactory AmlContext { get; }

Property Value

Type	Description
Element​Factory

Implements

IConnection.​Aml​Context

Compression

Gets the compression setting to use when sending requests to the server.

Declaration

public CompressionType Compression { get; set; }

Property Value

Type	Description
Compression​Type	The compression setting to use when sending requests to the server.

Implements

IAras​Connection.​Compression

Database

Name of the connected database

Declaration

public string Database { get; }

Property Value

Type	Description
System.​String

Implements

IConnection.​Database

ServerInfo

Gets the server information returned when logging in.

Declaration

public IEnumerable<KeyValuePair<string, string>> ServerInfo { get; }

Property Value

Type	Description
System.​Collections.​Generic.​IEnumerable<System.​Collections.​Generic.​Key​Value​Pair<System.​String, System.​String>>	The server information.

Url

URL that the instance resides at

Declaration

public Uri Url { get; }

Property Value

Type	Description
System.​Uri

Implements

IRemote​Connection.​Url

UserId

ID of the authenticated user

Declaration

public string UserId { get; }

Property Value

Type	Description
System.​String

Implements

IConnection.​User​Id

Version

Gets the major version of the Aras installation

Declaration

public int Version { get; }

Property Value

Type	Description
System.​Int32	The major version of the Aras installation.

Implements

IAras​Connection.​Version

Methods

Clone(Boolean)

Gets a new connection logged in with the same credentials

Declaration

public IPromise<IRemoteConnection> Clone(bool async)

Parameters

Type	Name	Description
System.​Boolean	async	Whether to perform this action asynchronously

Returns

Type	Description
IPromise<IRemote​Connection>	A promise to return a new connection

Implements

IRemote​Connection.​Clone(Boolean)

CreateUploadCommand()

Creates an upload request used for uploading files to the server

Declaration

public UploadCommand CreateUploadCommand()

Returns

Type	Description
Upload​Command	A new upload request used for uploading files to the server

Implements

IConnection.​Create​Upload​Command()

DefaultSettings(Action<IHttpRequest>)

Use a method to configure each outgoing HTTP request

Declaration

public void DefaultSettings(Action<IHttpRequest> settings)

Parameters

Type	Name	Description
System.​Action<IHttp​Request>	settings	Action used to configure the request

Implements

IRemote​Connection.​Default​Settings(Action<IHttp​Request>)

Dispose()

Causes the connection to logout.

Declaration

public void Dispose()

Implements

System.​IDisposable.​Dispose()

Equals(ArasHttpConnection)

Determines whether the specified Aras​Http​Connection, is equal to this instance.

Declaration

public bool Equals(ArasHttpConnection conn)

Parameters

Type	Name	Description
Aras​Http​Connection	conn	The Aras​Http​Connection to compare with this instance.

Returns

Type	Description
System.​Boolean	true if the specified Aras​Http​Connection is equal to this instance (same URL, database, and user ID); otherwise, false.

Equals(Object)

Determines whether the specified System.​Object, is equal to this instance.

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
System.​Object	obj	The System.​Object to compare with this instance.

Returns

Type	Description
System.​Boolean	true if the specified System.​Object is equal to this instance; otherwise, false.

Overrides

System.​Object.​Equals(System.​Object)

GetDatabases()

Returns a set of databases which can be connected to using this URL

Declaration

public IEnumerable<string> GetDatabases()

Returns

Type	Description
System.​Collections.​Generic.​IEnumerable<System.​String>	A set of databases which can be connected to using this URL

Implements

IRemote​Connection.​Get​Databases()

GetHashCode()

Returns a hash code for this instance.

Declaration

public override int GetHashCode()

Returns

Type	Description
System.​Int32	A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.

Overrides

System.​Object.​Get​Hash​Code()

Login(ICredentials)

Log in to the database

Declaration

public void Login(ICredentials credentials)

Parameters

Type	Name	Description
ICredentials	credentials	Credentials used for authenticating to the instance

Implements

IRemote​Connection.​Login(ICredentials)

Login(ICredentials, Boolean)

Log in to the database asynchronosuly

Declaration

public IPromise<string> Login(ICredentials credentials, bool async)

Parameters

Type	Name	Description
ICredentials	credentials	Credentials used for authenticating to the instance
System.​Boolean	async	Whether to perform this action asynchronously

Returns

Type	Description
IPromise<System.​String>	A promise to return the user ID as a string

Implements

IRemote​Connection.​Login(ICredentials, Boolean)

Exceptions

Type	Condition
System.​Not​Supported​Exception	This connection implementation does not support the specified credential type

Logout(Boolean)

Log out of the database

Declaration

public void Logout(bool unlockOnLogout)

Parameters

Type	Name	Description
System.​Boolean	unlockOnLogout	Whether to unlock locked items while logging out

Implements

IRemote​Connection.​Logout(Boolean)

Logout(Boolean, Boolean)

Log out of the database

Declaration

public void Logout(bool unlockOnLogout, bool async)

Parameters

Type	Name	Description
System.​Boolean	unlockOnLogout	Whether to unlock locked items while logging out
System.​Boolean	async	Whether to perform this action asynchronously

Implements

IRemote​Connection.​Logout(Boolean, Boolean)

MapClientUrl(String)

Expands a relative URL to a full URL

Declaration

public string MapClientUrl(string relativeUrl)

Parameters

Type	Name	Description
System.​String	relativeUrl	The relative URL

Returns

Type	Description
System.​String	A full URL relative to the connection

Implements

IConnection.​Map​Client​Url(String)

Process(Command)

Process a command by crafting the appropriate HTTP request and returning the HTTP response stream

Declaration

public Stream Process(Command request)

Parameters

Type	Name	Description
Command	request

Returns

Type	Description
System.​IO.​Stream

Implements

IConnection.​Process(Command)

Process(Command, Boolean)

Process a command asynchronously by crafting the appropriate HTTP request and returning the HTTP response stream

Declaration

public IPromise<Stream> Process(Command request, bool async)

Parameters

Type	Name	Description
Command	request	The query to execute
System.​Boolean	async	Whether the query should be executed asynchronously

Returns

Type	Description
IPromise<System.​IO.​Stream>

Implements

IAsync​Connection.​Process(Command, Boolean)

SetVaultStrategy(IVaultStrategy)

Sets the vault strategy.

Declaration

public void SetVaultStrategy(IVaultStrategy strategy)

Parameters

Type	Name	Description
IVault​Strategy	strategy	The strategy.

Explicit Interface Implementations

IArasConnection.DefaultSettings

Declaration

List<Action<IHttpRequest>> IArasConnection.DefaultSettings { get; }

Returns

Type	Description
System.​Collections.​Generic.​List<System.​Action<IHttp​Request>>

Implements

IAras​Connection.​Default​Settings

IArasConnection.SetDefaultHeaders(Action<String, String>)

Declaration

void IArasConnection.SetDefaultHeaders(Action<string, string> writer)

Parameters

Type	Name	Description
System.​Action<System.​String, System.​String>	writer

Implements

IAras​Connection.​Set​Default​Headers(Action<String, String>)

Extension Methods

Connection​Extensions.​Apply(IConnection, Command, Object[])

Connection​Extensions.​Apply​Async(IAsync​Connection, Command, Boolean, Boolean, Object[])

Connection​Extensions.​Apply​Async(IAsync​Connection, Command, Cancellation​Token, Object[])

Connection​Extensions.​Apply​Sql(IConnection, Command, Object[])

Connection​Extensions.​Apply​Sql(IAsync​Connection, Command, Boolean)

Connection​Extensions.​Apply​Sql(IAsync​Connection, Command, Cancellation​Token)

Connection​Extensions.​Item​By​Id(IConnection, String, String)

Connection​Extensions.​Item​By​Id<T>(IConnection, String, String, Func<IRead​Only​Item, T>)

Connection​Extensions.​Item​By​Keyed​Name(IConnection, String, String)

Connection​Extensions.​Item​By​Query(IConnection, Command)

Connection​Extensions.​Item​By​Query(IConnection, Command, Boolean)

Connection​Extensions.​Lock(IConnection, String, String)

Connection​Extensions.​Next​Sequence(IConnection, String)

Connection​Extensions.​Promote(IConnection, String, String, String, String)

Connection​Extensions.​Unlock(IConnection, String, String)

See Also

IRemote​Connection

IAras​Connection