Class Connection

Object
   |
   +--Connection

class Connection

Bean object that contains the configuration settings needed to connect to Lightstreamer Server.
Defined in lscommons.js

See:

- LightstreamerEngine

Constructor Detail

Connection

Connection()

Used by Lightstreamer to provide a connection properties bean object to the LightstreamerEngine object.

See:
- LightstreamerEngine

getAdapterName

String getAdapterName()

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.

Returns:
the name of the Adapter Set; returns null if no name has been configured, so that the "DEFAULT" Adapter Set is used.

See:
- setAdapterName()

getLSHost

String getLSHost()

Inquiry method that gets the address of Lightstreamer Server.

Returns:
The address of Lightstreamer Server.

See:
- setLSHost()

getLSPort

Number getLSPort()

Inquiry method that gets the TCP port to be used for the connections to Lightstreamer Server.

Returns:
the TCP port to be used for the connections to Lightstreamer Server.

See:
- setLSPort()

getServerUrlPath

String getServerUrlPath()

Inquiry method that gets the base URL path currently prepended to all request URLs for Lightstreamer Server.

Returns:
The base URL path; it always starts with a '/' character.

See:
- setServerUrlPath()

setAdapterName

void setAdapterName(<String> adapterName)

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 ID is configured through the "id" attribute in the "adapters_conf" element.

Invocation: optional.

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

Lifecycle: The Adapter Set name should be set on the LightstreamerEngine.connection object before changing the status to "STREAMING" or "POLLING". However, the value can be changed at any time, provided that the Engine status is "DISCONNECTED"; the supplied value will be used for the next connection attempt.

Parameters:
adapterName - The name of the Adapter Set te be used.

See:
- LightstreamerEngine.changeStatus()

setLSHost

void setLSHost(<String> hostAddress)

Setter method that sets the address of Lightstreamer Server. Setting Lightstreamer Server address is not required when the front-end pages are supplied by Lightstreamer Server itself (although this scenario is advised only for demo purpose). On the other hand, the setting is mandatory if the front-end pages are served by an external Web server. In this case, calling the setLSPort() method may also be needed, because its default value is the port used for loading the library pages from the Web server, which may be different than the port used by Lightstreamer Server. The protocol used to connect to Lightstreamer Server is always the same used to download the Master Push-Page. So if the Master Push-Page is downloaded through HTTP, then HTTP will be used for all the connections to Lightstreamer Server. It the Master Push-Page is downloaded through HTTPS, all the connections to Lightstreamer Server will use HTTPS.
Edition Note: HTTPS connections are not supported by the Server if it runs in Allegro edition.
Edition Note: HTTPS connections are not supported by the Server if it runs in Moderato edition.

Invocation: optional.

Default value: location.hostname (the hostname of the server that supplies the library pages).

Lifecycle: The Server address should be set on the LightstreamerEngine.connection object before changing the status to "STREAMING" or "POLLING". However, the value can be changed at any time, provided that the Engine status is "DISCONNECTED"; the supplied value will be used for the next connection attempt.

Parameters:
hostAddress - The full address of Lightstreamer Server (e.g. "push.mycompany.com"). A null value can also be used, to restore the default value, determined as location.hostname.

See:
- LightstreamerEngine.changeStatus()

setLSPort

void setLSPort(<Number> port)

Setter method that sets the TCP port to be used for all the connections to Lightstreamer Server.

Invocation: optional.

Default value: location.port (the port used for the library pages loading).

Lifecycle: The port should be set on the LightstreamerEngine.connection object before changing the status to "STREAMING" or "POLLING". However, the value can be changed at any time, provided that the Engine status is "DISCONNECTED"; the supplied value will be used for the next connection attempt.

Parameters:
port - The TCP port to be used for the connections. A null value can also be used, to restore the default value, determined as location.port.

See:
- LightstreamerEngine.changeStatus()

setPassword

void setPassword(<String> password)

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).

Invocation: optional.

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 password should be set on the LightstreamerEngine.connection object before changing the status to "STREAMING" or "POLLING". However, the value can be changed at any time, provided that the Engine status is "DISCONNECTED"; the supplied value will be used for the next connection attempt.
NOTE: The password string will be stored as a JavaScript variable and as a temporary local cookie in the browser memory. 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.

Parameters:
password - The password to be used for the authentication on Lightstreamer Server. The password can be null.

See:
- setUserName()
- setAdapterName()
- LightstreamerEngine.changeStatus()

setServerUrlPath

void setServerUrlPath(<String> urlPath)

Setter method that sets the base URL path to be prepended to all request URLs for Lightstreamer Server. As some request URLs may be displayed on the screen by the browser, customizing the first part of the URL could be desirable. Note that, in order to use a non-default base URL path, the same path must be configured on the Server, through the element. The URL path should start with a '/' character.

Invocation: optional.

Default value: "/lightstreamer".

Lifecycle: The base URL path can be changed at any time.

Parameters:
urlPath - a legal URL path, starting with a '/' character. A null value can also be used, to restore the default "/lightstreamer" URL path.

setUserName

void setUserName(<String> user)

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).

Invocation: optional.

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 LightstreamerEngine.connection object before changing the status to "STREAMING" or "POLLING". However, the value can be changed at any time, provided that the Engine status is "DISCONNECTED"; the supplied value will be used for the next connection attempt.

Parameters:
user - The username to be used for the authentication on Lightstreamer Server. The username can be null.

See:
- setAdapterName()
- LightstreamerEngine.changeStatus()