com.lightstreamer.client

Class ConnectionDetails

java.lang.Object

com.lightstreamer.client.ConnectionDetails

public class ConnectionDetails
extends java.lang.Object

Used by LightstreamerClient to provide a basic connection properties bean. Bean object that contains the configuration settings needed to connect to a Lightstreamer Server.
An instance of this class is attached to every LightstreamerClient as LightstreamerClient.connectionDetails

See Also:

LightstreamerClient

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAdapterSet() 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.
java.lang.String	getServerAddress() Inquiry method that gets the configured address of Lightstreamer Server.
java.lang.String	getServerInstanceAddress() Inquiry method that gets the server address to be used to issue all requests related to the current session.
java.lang.String	getServerSocketName() Inquiry method that gets the instance name of the Server which is serving the current session.
java.lang.String	getSessionId() Inquiry method that gets the ID associated by the server to this client session.
java.lang.String	getUser() Inquiry method that gets the username to be used for the authentication on Lightstreamer Server when initiating the push session.
void	setAdapterSet(java.lang.String adapterSet) 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.
void	setPassword(java.lang.String password) Setter method that sets the password to be used for the authentication on Lightstreamer Server when initiating the push session.
void	setServerAddress(java.lang.String serverAddress) Setter method that sets the address of Lightstreamer Server. Note that the addresses specified must always have the http: or https: scheme.
void	setUser(java.lang.String user) Setter method that sets the username to be used for the authentication on Lightstreamer Server when initiating the push session.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getAdapterSet

public java.lang.String getAdapterSet()

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 adapterSet the name of the Adapter Set; returns null if no name has been configured, that means that the "DEFAULT" Adapter Set is used.

See Also:

setAdapterSet(java.lang.String)

setAdapterSet

public void setAdapterSet(java.lang.String adapterSet)

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.

Parameters:

adapterSet - The name of the Adapter Set to be used. A null value is equivalent to the "DEFAULT" name.

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.

Related notifications:

A change to this setting will be notified through a call to ClientListener.onPropertyChange(java.lang.String) with argument "adapterSet" on any ClientListener listening to the related LightstreamerClient.

Default value:

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

getServerAddress

public java.lang.String getServerAddress()

Inquiry method that gets the configured address of Lightstreamer Server.

Returns:

the serverAddress the configured address of Lightstreamer Server.

setServerAddress

public void setServerAddress(java.lang.String serverAddress)

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

Parameters:

serverAddress - The full address of Lightstreamer Server. A null value can also be used, to restore the default value. An IPv4 or IPv6 can also be used in place of a hostname. Some examples of valid values include: http://push.mycompany.com
http://push.mycompany.com:8080
http://79.125.7.252
http://[2001:0db8:85a3:0000:0000:8a2e:0370:7334]
http://[2001:0db8:85a3::8a2e:0370:7334]:8080

Throws:

java.lang.IllegalArgumentException - if the given address is not valid.

Edition Note:

WSS/HTTPS connections are not supported by the Server if it runs in Allegro edition.

Edition Note:

WSS/HTTPS connections are not supported by the Server if it runs in Moderato edition.

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.

Related notifications:

A change to this setting will be notified through a call to ClientListener.onPropertyChange(java.lang.String) with argument "serverAddress" on any ClientListener listening to the related LightstreamerClient.

Default value:

if no server address is supplied the client will be unable to connect.

getUser

public java.lang.String getUser()

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

Returns:

the username to be used for the authentication on Lightstreamer Server; returns null if no user name has been configured.

setUser

public void setUser(java.lang.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).

Parameters:

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

See Also:

setPassword(String)

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.

Related notifications:

A change to this setting will be notified through a call to ClientListener.onPropertyChange(java.lang.String) with argument "user" on any ClientListener listening to the related LightstreamerClient.

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.

getServerInstanceAddress

public java.lang.String getServerInstanceAddress()

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 setServerAddress(java.lang.String) 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).

Returns:

address used to issue all requests related to the current session.

Edition Note:

Server Clustering is not supported when using Lightstreamer in Moderato edition.

Lifecycle:

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

Related notifications:

A change to this setting will be notified through a call to ClientListener.onPropertyChange(java.lang.String) with argument "serverInstanceAddress" on any ClientListener listening to the related LightstreamerClient.

getServerSocketName

public java.lang.String getServerSocketName()

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.

Returns:

name configured for the Server instance which is managing the current session.

Edition Note:

Server Clustering is not supported when using Lightstreamer in Moderato edition.

Lifecycle:

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

Related notifications:

A change to this setting will be notified through a call to ClientListener.onPropertyChange(java.lang.String) with argument "serverSocketName" on any ClientListener listening to the related LightstreamerClient.

getSessionId

public java.lang.String getSessionId()

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

Returns:

ID assigned by the Server to this client session.

Lifecycle:

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

Related notifications:

A change to this setting will be notified through a call to ClientListener.onPropertyChange(java.lang.String) with argument "sessionId" on any ClientListener listening to the related LightstreamerClient.

setPassword

public void setPassword(java.lang.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).

Parameters:

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

See Also:

setUser(String)

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 in the current instance. 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.

Related notifications:

A change to this setting will be notified through a call to ClientListener.onPropertyChange(java.lang.String) with argument "password" on any ClientListener listening to the related LightstreamerClient.

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.