IAdmServiceLog2

The IAdmServiceLog2 interface provides properties and methods to configure Adaxes service log database settings and Syslog output.

Inheritance: IAdmServiceLog

Methods

  • Method

  • Description

  • SetDatabaseType()

  • Sets the type of the database where the service log will be stored.

  • GetDatabaseServers()

  • Returns names of database servers installed in the current organization.

  • GetDatabases()

  • Returns information about databases installed on the specified server.

  • GetDatabase()

  • Returns information about the specified external database.

  • GetCommunicationInfo()

  • Returns information about external databases that each Adaxes service sharing common configuration with the current service can connect to.

  • GetCommunicationStatus()

  • Checks whether all Adaxes services sharing common configuration with the current service can write log records.

Properties

  • Property

  • Description

  • DatabaseType

  • Gets the type of the log database that is currently used by the Adaxes service.

  • DatabaseInfo

  • Gets an Object that represents the log database currently used by the Adaxes service.

  • ErrorReportingEnabled

  • Gets or sets a value that indicates whether email error reporting is enabled.

  • ErrorReportingEmails

  • Gets or sets a semicolon-separated list of e-mail addresses, to which error reports will be sent.

  • LocalDatabasePath

  • Gets the path of the local database file.

  • SyslogOutputEnabled

  • Gets or sets a value indicating whether Syslog output is enabled.

  • SyslogServer

  • Gets or sets the Syslog server to which Adaxes will send Syslog messages.

Details

SetDatabaseType()

Sets the type of the database where the service log will be stored.

void SetDatabaseType(ADM_LOGDATABASETYPE_ENUM dbType, Object dbInfo)

Parameters

  • dbType - Specifies the database type.
  • dbInfo - Contains information about the database.
    • If the dbType parameter is set to ADM_LOGDATABASETYPE_LOCAL, this parameter must be NULL.
    • If the dbType parameter is set to ADM_LOGDATABASETYPE_MSSQL, this parameter must be set to an instance of the IAdmServiceLogMSSqlServerDatabaseInfo interface.

GetDatabaseServers()

Returns names of database servers installed in the current organization.

String[] GetDatabaseServers(ADM_LOGDATABASETYPE_ENUM dbType)

Parameters

The dbType parameter specifies the type of database servers that will be returned.

GetDatabases()

Returns information about databases installed on the specified server.

Object[] GetDatabases(ADM_LOGDATABASETYPE_ENUM dbType, String server)

Parameters

  • dbType - Specifies the database type. Currently, the only supported type is ADM_LOGDATABASETYPE_MSSQL.
  • server - Specifies the name of the database server.

Return value

An Object[] array, where each OBJECTTYPE represents information about a single database. The interfaces supported by items in the array depend on the database type specified by the dbType parameter.

Currently, the only supported database type is ADM_LOGDATABASETYPE_MSSQL, and each item in the array returned by the method implements the IAdmServiceLogMSSqlServerDatabaseInfo interface.

GetDatabase()

Returns information about the specified external database.

Object GetDatabase(ADM_LOGDATABASETYPE_ENUM dbType,
                   String server,
                   String databaseName)

Parameters

  • dbType - Specifies the database type. Currently, the only supported type is ADM_LOGDATABASETYPE_MSSQL.
  • server - Specifies the name of the database server.
  • databaseName - Specifies the database name.

Return value

An Object that represents information about the specified database. The interfaces supported by the returned value depend on the database type specified by the dbType parameter.

Currently, the only supported database type is ADM_LOGDATABASETYPE_MSSQL, and the Object returned by the method implements the IAdmServiceLogMSSqlServerDatabaseInfo interface.

GetCommunicationInfo()

Returns information about external databases that each Adaxes service sharing common configuration with the current service can connect to.

IAdmServiceLogDatabaseServerCommunicationInfo[] GetCommunicationInfo()

GetCommunicationStatus()

Checks whether all Adaxes services sharing common configuration with the current service can write log records.

ADM_COMUNICATIONSTATUS_ENUM GetCommunicationStatus()

Return value

  • ADM_COMUNICATIONSTATUS_SUCCESS - All Adaxes services can write log records.
  • ADM_COMUNICATIONSTATUS_ERROR - At least one of the Adaxes services cannot write log records.
  • ADM_COMUNICATIONSTATUS_PENDING - The service log settings have not been replicated to all services yet.

DatabaseType

Gets the type of the log database that is currently used by the Adaxes service.

DatabaseInfo

Gets an Object that represents the log database currently used by the Adaxes service.

  • Type:
  • Object
  • Access:
  • Read-only

Remarks

ErrorReportingEnabled

Gets or sets a value that indicates whether email error reporting is enabled.

  • Type:
  • Boolean
  • Access:
  • Read/Write

ErrorReportingEmails

Gets or sets a semicolon-separated list of e-mail addresses, to which error reports will be sent.

  • Type:
  • String
  • Access:
  • Read/Write

LocalDatabasePath

Gets the path of the local database file.

  • Type:
  • String
  • Access:
  • Read-only

SyslogOutputEnabled

Gets or sets a value indicating whether Syslog output is enabled.

  • Type:
  • Boolean
  • Access:
  • Read/Write

SyslogServer

Gets or sets the Syslog server to which Adaxes will send Syslog messages. A server is identified by its host name or IP address and an optional port number (e.g. mysyslog.company.com:514 or 192.168.10.10).

  • Type:
  • String
  • Access:
  • Read/Write

Requirements

Minimum required version: 2013.2

See also

© Softerra 2021. All rights reserved.
Send feedback