Click or drag to resize

HttpServerConnection Class

Implementation of IServerConnection over HTTP.
Inheritance Hierarchy
SystemObject
  Aras.IOMServerConnectionBase
    Aras.IOMHttpServerConnection
      Aras.IOMWinAuthHttpServerConnection

Namespace:  Aras.IOM
Assembly:  IOM (in IOM.dll) Version: 14.0.20.39432
Syntax
public class HttpServerConnection : ServerConnectionBase

The HttpServerConnection type exposes the following members.

Properties
  NameDescription
Public propertyAutoReloginOnSessionError
Gets or sets flag for automatic relogin on session timeout. The default value is false.
Public propertyCode exampleCompression
Property specifies the way of compression of AML sent through IOM.HttpServerConnection. Value from enumeration 'CompressionType' (namespace Aras.Common.Compression) can be set. Available values are:
  • gzip data compression to the gzip format
  • deflate data compression to the deflate format
  • none Default value. Data sent through IOM.HttpServerConnection aren't compressed.
It is highly recommended to store type of compression you are using in configuration file of your application. Example section of application configuration file:
XML
<configuration>
    <appSettings>
        <add key="CompressionType" value="gzip"/>
    </appSettings >
</configuration>
Examples of setting value of Compression property from application configuration file.
Examples
...
HttpServerConnection connection = CreateHttpServerConnection("innovatorServerUrl");
connaction.Compression = GetCompressionTypeFromAppConfig();
...
private CompressionType GetCompressionTypeFromAppConfig()
{
 string value = ConfigurationManager.AppSettings["CompressionType"];
 if (String.IsNullOrEmpty(value))
 {
     return CompressionType.none;
 }
 else
 {
     return (CompressionType)Enum.Parse(typeof(CompressionType), value);
 }
}
Public propertyReadWriteTimeout
Gets or sets a time-out in milliseconds when writing to or reading from a stream.
Public propertyTimeout
Gets or sets the time-out value in milliseconds for the System.Net.HttpWebRequest.GetResponse() and System.Net.HttpWebRequest.GetRequestStream() methods.
Top
Methods
  NameDescription
Public methodCallAction
Send a request with the specified action and AML to Innovator server and write the obtained response into the outDOM.
(Overrides ServerConnectionBaseCallAction(String, XmlDocument, XmlDocument).)
Public methodGetDatabaseName
Returns name of the current database in use.
(Overrides ServerConnectionBaseGetDatabaseName.)
Public methodGetDatabases
Returns all configured databases
(Overrides ServerConnectionBaseGetDatabases.)
Public methodgetFileUrl(String, UrlType)
Returns file full file url. In some cases with AuthenticationBroker's token.
(Overrides ServerConnectionBase.getFileUrl(String, UrlType).)
Public methodgetFileUrl(String, UrlType, VaultUrlType)
Returns file full file url. In some cases with AuthenticationBroker's token.
(Overrides ServerConnectionBase.getFileUrl(String, UrlType, VaultUrlType).)
Public methodgetFileUrls(ArrayList, UrlType)
Returns file full file urls. In some cases with AuthenticationBroker's token.
(Overrides ServerConnectionBase.getFileUrls(ArrayList, UrlType).)
Public methodgetFileUrls(ArrayList, UrlType, VaultUrlType)
Returns file full file urls. In some cases with AuthenticationBroker's token.
(Overrides ServerConnectionBase.getFileUrls(ArrayList, UrlType, VaultUrlType).)
Public methodGetLicenseInfo
Returns information about subscription and all add-on's
(Inherited from ServerConnectionBase.)
Public methodGetLicenseInfo(String, String)
Returns information about subscription and specified add-ons
(Overrides ServerConnectionBaseGetLicenseInfo(String, String).)
Public methodgetUserID
If Login() was already called, returns id of the user associated with the connection; otherwise throws an exception.
(Overrides ServerConnectionBase.getUserID.)
Public methodLogin
Login into Innovator server.
Public methodLogout
Logout from Innovator (do not unlock locked Items).
Public methodLogout(Boolean)
Logout from Innovator.
Public methodUsingParameters
Call action with special HttpConnectionParams
Top
See Also