3.4.1.1 Message: RequestSession

Topic Version1Published10/31/2016
For StandardETP v1.1

Sent by a client to request a new session with a server.

Message Type ID: 1

Correlation Id Usage: n/a

Multi-part: False

Sent by: client

Constraint

Details

Description

Within a given request/response for protocol support, protocol id must be unique.

inv: self.requestedProtocols->isUnique(p | p.protocol)

inv: self.requestedProtocols->isUnique(p | p.protocol)

Attribute

Description

Data Type

Min

Max

applicationName

The string by which the client identifies itself, normally a software product or system name. This string may or may not include a version, and the format is entirely application dependent. Vendors are encouraged to identify their company name as part of this string.

string

1

1

applicationVersion

 

string

1

1

requestedProtocols

An array of protocol IDs that the client expects to communicate on for this session. If the server does not support all of the protocols, the client may or may not continue with the protocols that are supported.

SupportedProtocol

1

n

supportedObjects

A list of the Data Objects supported by the client. This list MUST be empty if the client is a customer. This field MUST be supplied if the client is a Store and is requesting a customer role for the server. For details on the content, see the documentation forOpenSession .

string

1

n

Avro Source

{

      "type": "record",

      "namespace": "Energistics.Protocol.Core",

      "name": "RequestSession",

      "messageType": "1",

      "protocol": "0",

      "senderRole": "client",

      "protocolRoles": "client,server",

      "fields":

     [

         { "name": "applicationName", "type": "string" },

         { "name": "applicationVersion", "type": "string" },

         {

          "name": "requestedProtocols",

          "type": { "type": "array", "items": "Energistics.Datatypes.SupportedProtocol" }

     },

         {

          "name": "supportedObjects",

          "type": { "type": "array", "items": "string" }

     }

     ]

}