ConnectionDetails

Inquiry method that gets the name of the Adapter Set (which defines the Metadata Adapter and one or several Data Adapters) mounted on Lightstreamer Server that supply all the items used in this application.

Inquiry method that gets the IP address of this client as seen by the Server which is serving the current session as the client remote address (note that it may not correspond to the client host; for instance it may refer to an intermediate proxy). If, upon a new session, this address changes, it may be a hint that the intermediary network nodes handling the connection have changed, hence the network capabilities may be different. The library uses this information to optimize the connection.

Note that in case of polling or in case rebind requests are needed, subsequent requests related to the same session may, in principle, expose a different IP address to the Server; these changes would not be reported.

Lifecycle: If a session is not currently active, null is returned; soon after a session is established, the value may become available; but it is possible that this information is not provided by the Server and that it will never be available.

Notification: A change to this setting will be notified through a call to ClientListener#onPropertyChange with argument "clientIp" on any ClientListener listening to the related LightstreamerClient.

Inquiry method that gets the configured address of Lightstreamer Server.

Inquiry method that gets the server address to be used to issue all requests related to the current session. In fact, when a Server cluster is in place, the Server address specified through ConnectionDetails#setServerAddress can identify various Server instances; in order to ensure that all requests related to a session are issued to the same Server instance, the Server can answer to the session opening request by providing an address which uniquely identifies its own instance. When this is the case, this address is returned by the method; otherwise, null is returned.
Note that the addresses will always have the http: or https: scheme. In case WebSockets are used, the specified scheme is internally converted to match the related WebSocket protocol (i.e. http becomes ws while https becomes wss).

Edition Note: Server Clustering is an optional feature, available depending on Edition and License Type. To know what features are enabled by your license, please see the License tab of the Monitoring Dashboard (by default, available at /dashboard).

Lifecycle: The method gives a meaningful answer only when a session is currently active.

Notification: A change to this setting will be notified through a call to ClientListener#onPropertyChange with argument "serverInstanceAddress" on any ClientListener .

Inquiry method that gets the instance name of the Server which is serving the current session. To be more precise, each answering port configured on a Server instance (through a <http_server> or <https_server> element in the Server configuration file) can be given a different name; the name related to the port to which the session opening request has been issued is returned.
Note that in case of polling or in case rebind requests are needed, subsequent requests related to the same session may be issued to a port different than the one used for the first request; the names configured for those ports would not be reported. This, however, can only happen when a Server cluster is in place and particular configurations for the load balancer are used.

Edition Note: Server Clustering is an optional feature, available depending on Edition and License Type. To know what features are enabled by your license, please see the License tab of the Monitoring Dashboard (by default, available at /dashboard).

Lifecycle: The method gives a meaningful answer only when a session is currently active.

Notification: A change to this setting will be notified through a call to ClientListener#onPropertyChange with argument "serverSocketName" on any ClientListener .

Inquiry method that gets the ID associated by the server to this client session.

Lifecycle: The method gives a meaningful answer only when a session is currently active.

Notification: A change to this setting will be notified through a call to ClientListener#onPropertyChange with argument "sessionId" on any ClientListener .

Inquiry method that gets the username to be used for the authentication on Lightstreamer Server when initiating the push session.

Setter method that sets the name of the Adapter Set mounted on Lightstreamer Server to be used to handle all requests in the session.
An Adapter Set defines the Metadata Adapter and one or several Data Adapters. It is configured on the server side through an "adapters.xml" file; the name is configured through the "id" attribute in the <adapters_conf> element.

Default value: The default Adapter Set, configured as "DEFAULT" on the Server.

Lifecycle: The Adapter Set name should be set on the LightstreamerClient#connectionDetails object before calling the LightstreamerClient#connect method. However, the value can be changed at any time: the supplied value will be used for the next time a new session is requested to the server.
This setting can also be specified in the LightstreamerClient constructor.

Notification: A change to this setting will be notified through a call to ClientListener#onPropertyChange with argument "adapterSet" on any ClientListener .

Setter method that sets the password to be used for the authentication on Lightstreamer Server when initiating the push session. The Metadata Adapter is responsible for checking the credentials (username and password).

Default value: If no password is supplied, no password information will be sent at session initiation. The Metadata Adapter, however, may still allow the session.

Lifecycle: The username should be set on the LightstreamerClient#connectionDetails object before calling the LightstreamerClient#connect method. However, the value can be changed at any time: the supplied value will be used for the next time a new session is requested to the server.
NOTE: The password string will be stored as a JavaScript variable. That is necessary in order to allow automatic reconnection/reauthentication for fail-over. For maximum security, avoid using an actual private password to authenticate on Lightstreamer Server; rather use a session-id originated by your web/application server, that can be checked by your Metadata Adapter.

Notification: A change to this setting will be notified through a call to ClientListener#onPropertyChange with argument "password" on any ClientListener .

Setter method that sets the address of Lightstreamer Server.
Note that the addresses specified must always have the http: or https: scheme. In case WebSockets are used, the specified scheme is internally converted to match the related WebSocket protocol (i.e. http becomes ws while https becomes wss).

Edition Note: HTTPS is an optional feature, available depending on Edition and License Type. To know what features are enabled by your license, please see the License tab of the Monitoring Dashboard (by default, available at /dashboard).

Lifecycle:This method can be called at any time. If called while connected, it will be applied when the next session creation request is issued.
This setting can also be specified in the LightstreamerClient constructor.

Notification: A change to this setting will be notified through a call to ClientListener#onPropertyChange with argument "serverAddress" on any ClientListener .

Setter method that sets the username to be used for the authentication on Lightstreamer Server when initiating the push session. The Metadata Adapter is responsible for checking the credentials (username and password).

Default value: If no username is supplied, no user information will be sent at session initiation. The Metadata Adapter, however, may still allow the session.

Lifecycle: The username should be set on the LightstreamerClient#connectionDetails object before calling the LightstreamerClient#connect method. However, the value can be changed at any time: the supplied value will be used for the next time a new session is requested to the server.

Notification: A change to this setting will be notified through a call to ClientListener#onPropertyChange with argument "user" on any ClientListener .