Interaction SDK
(Web Services)

Service: SystemService


The system service.
Attribute Summary
String system.server-info:host
           The name of the host where the service should run.
String system.server-info:name
           The AIL framework service name.
String system.server-info:port
           The port on which the service should run.
com.genesyslab.ail.ws.system.ServerStatus system.server-info:status
           The current status of the server.
com.genesyslab.ail.ws.Switch system.server-info:switch
           The switch associated with this service. Only used for services of type ServerType.TELEPHONY; null for other services.
com.genesyslab.ail.ws.system.ServerType system.server-info:type
           The type of the server.

Method Summary
com.genesyslab.ail.ws.KeyValue[] getOptions
           Returns options about the application that the AIL currently uses in the Configuration Layer.
com.genesyslab.ail.ws.system.ServerDescriptionDTO[] getServersDescriptionDTO
           Retrieves all the requested attributes about the types of servers.
String getServerVersion
           Returns the current Ail Services version (ex : 7.6.000.10).

Event Summary
SystemEvent
           System service event

Attribute Detail

Attributes of domain system.server-info

Standard response library attributes definition


host

Type: String
The name of the host where the service should run.
Properties: read read-default event-default event


name

Type: String
The AIL framework service name.
Properties: event-default event


port

Type: String
The port on which the service should run.
Properties: read read-default event-default event


status

Type: com.genesyslab.ail.ws.system.ServerStatus
The current status of the server.
Properties: read read-default event-default event


switch

Type: com.genesyslab.ail.ws.Switch
The switch associated with this service. Only used for services of type ServerType.TELEPHONY; null for other services.
Properties: read read-default event-default event


type

Type: com.genesyslab.ail.ws.system.ServerType
The type of the server.
Properties: read read-default event-default event


Method Detail

getOptions

Returns options about the application that the AIL currently uses in the Configuration Layer.
Parameters:

Returns:

  Type:  com.genesyslab.ail.ws.KeyValue[]

   The AIL options.

Errors:

  error.common.AilFactoryNotInitialized


getServersDescriptionDTO

Retrieves all the requested attributes about the types of servers.
Parameters:

  attributes  String[]
   The attributes to retrieve (system.server-info:*).

Returns:

  Type:  com.genesyslab.ail.ws.system.ServerDescriptionDTO[]

   The attributes for each server.

Errors:

  error.common.AilFactoryNotInitialized

  error.common.RequestFailed


getServerVersion

Returns the current Ail Services version (ex : 7.6.000.10).
Parameters:

Returns:

  Type:  String

   The version.

Errors:

  error.common.AilFactoryNotInitialized


Event Detail

SystemEvent

System service event
Available attributes:  system.server-info:*

Filters:

  Key: SERVER_TYPE   Value: *, server type name.  -  See ServerType definition.

Triggers:

  Key: *   Value: *  - 


Interaction SDK
(Web Services)