Session properties
A client session has a number of properties associated with it. Properties are key-value pairs. Both the key and the value are case sensitive.
Session properties provide a powerful way for clients to target actions at a
specific client or set of clients whose session properties match a given criteria.
Clients can use session filtering to select a set of clients to perform one of the
following actions on:
- Send messages directly to that client or set of clients.
- Subscribe that client or set of clients to a topic.
- Unsubscribe that client or set of clients from a topic.
Clients can also request the full set of properties or a subset, for a particular client.
Fixed properties
Fixed properties are set by the Diffusion server when a client opens a
session with it. Fixed property keys are prefixed by a dollar sign ($). The fixed
session properties are:
- $SessionId
- The session identifier.
- $Principal
- The security principal the session uses to connect to the Diffusion server.
- $ClientType
- The client type of the session. For more information, see Client types.
- $Transport
- The transport the client session uses to connect to the Diffusion server. For more information, see Client types.
- $ServerName
- The name of the Diffusion server that the client connects to.
- $Connector
- The name of the connector on which the client connected to the Diffusion server.
- $Country
- The two letter country code for the country where the client's internet address is located. The value is uppercase.
- $Language
- The two letter language code for the most common language of the country where the client's internet address is located. The value is lowercase.
User-defined properties
An authentication handler that allows the client session to connect can assign additional properties to the session. The keys of these properties are case sensitive, must begin with an alphabetic character, must be alphanumeric, and must not include any whitespace.
This page last modified: 2016/10/19