Package com.streambase.liveview.client

Class ConnectionConfig

java.lang.Object

com.streambase.liveview.client.ConnectionConfig

public final class ConnectionConfig
extends Object

Connection configuration used to connect to LiveView server.

Constructor Summary

Constructors

Constructor	Description
ConnectionConfig()

Method Summary

Modifier and Type	Method	Description
ConnectionConfig	clone()
static ConnectionConfig	fromTcdsAuthUri(String uri, LiveViewAuth lvauth)	Creates a connection config from a TCDS URI and authentication (optional).
LiveViewAuth	getAuthentication()	Gets the authentication method for this connection
EnumSet<LiveViewClientCapability>	getCapabilities()	Get the capabilities
ProgressMonitor	getConnectionMonitor()	The api uses this method to retrieve the progress monitor specified by the user.
URI	getDisplayUri()	Deprecated. getURI now returns the display URI.
ConnectionListener	getListener()	Get the connection listener
String	getPassword()	Deprecated. Use get/setAuthentication instead.
String	getUri()	Get the uri to connect with (Sanitized since 11.0)
String	getUsername()	Deprecated. Use get/setAuthentication instead.
boolean	isCompress()	Get the compression state of this connection
void	setAuthentication(LiveViewAuth auth)	Sets the authentication method for this connection
ConnectionConfig	setCapabilities(EnumSet<LiveViewClientCapability> capabilities)	Set the ClientCapabilities that are supported by this client.
ConnectionConfig	setCompress(boolean compress)	Enable or disable compression on this connection
ConnectionConfig	setConnectionMonitor(ProgressMonitor monitor)	Sets the monitor to use by the api
ConnectionConfig	setListener(ConnectionListener listener)	Set the connection listener
ConnectionConfig	setPassword(String password)	Deprecated. Use get/setAuthentication instead.
ConnectionConfig	setUri(String uri)	Set the uri to connect with.
ConnectionConfig	setUsername(String username)	Deprecated. Use get/setAuthentication instead.

Methods inherited from class java.lang.Object

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

Constructor Details

ConnectionConfig

public ConnectionConfig()

Method Details

getConnectionMonitor

public ProgressMonitor getConnectionMonitor()

The api uses this method to retrieve the progress monitor specified by the user.

Returns:

the monitor

setConnectionMonitor

public ConnectionConfig setConnectionMonitor(ProgressMonitor monitor)

Sets the monitor to use by the api

Parameters:

monitor - the monitor to set

getUri

public String getUri()

Get the uri to connect with (Sanitized since 11.0)

Returns:

the uri, sans authentication material

Throws:

LiveViewException

getDisplayUri

@Deprecated
public URI getDisplayUri()

Deprecated.

getURI now returns the display URI. Deprecated in 11.0

Get the uri

Returns:

the sanitized uri

Throws:

LiveViewException

setUri

public ConnectionConfig setUri(String uri)
                        throws LiveViewException

Set the uri to connect with. The uri has syntax lv://<host>[:<port>]

Parameters:

uri - the uri to set

Throws:

LiveViewException

getUsername

@Deprecated
public String getUsername()

Deprecated.

Use get/setAuthentication instead. Deprecated in 11.0

Get the username to connect with

Returns:

the username

setUsername

@Deprecated
public ConnectionConfig setUsername(String username)
                             throws LiveViewException

Deprecated.

Use get/setAuthentication instead. Deprecated in 11.0

Set the username to connect with

Parameters:

username - the username to set

Throws:

LiveViewException

getPassword

@Deprecated
public String getPassword()

Deprecated.

Use get/setAuthentication instead. Deprecated in 11.0

Get the password to connect with

Returns:

the password

setPassword

@Deprecated
public ConnectionConfig setPassword(String password)
                             throws LiveViewException

Deprecated.

Use get/setAuthentication instead. Deprecated in 11.0

Set the password to connect with

Parameters:

password - the password to set

Throws:

LiveViewException

getAuthentication

public LiveViewAuth getAuthentication()

Gets the authentication method for this connection

Since:

11.0

setAuthentication

public void setAuthentication(LiveViewAuth auth)

Sets the authentication method for this connection

Parameters:

auth - Authentication built from static methods on LiveViewAuth

Since:

11.0

setCompress

public ConnectionConfig setCompress(boolean compress)

Enable or disable compression on this connection

Parameters:

compress - true to enable compression or false otherwise

Since:

7.5

isCompress

public boolean isCompress()

Get the compression state of this connection

Returns:

true if traffic on this connection is being compressed and false otherwise

Since:

7.5

getCapabilities

public EnumSet<LiveViewClientCapability> getCapabilities()

Get the capabilities

Returns:

an EnumSet of LiveViewClientCapability

setCapabilities

public ConnectionConfig setCapabilities(EnumSet<LiveViewClientCapability> capabilities)

Set the ClientCapabilities that are supported by this client. The default is that you support all the ones that exist in the version of the Java API that you're using. However, if there are capabilities that exist but you don't want to support them, specify it here.

Parameters:

capabilities -

Since:

LiveView 1.6.1

getListener

public ConnectionListener getListener()

Get the connection listener

Returns:

the listener

setListener

public ConnectionConfig setListener(ConnectionListener listener)

Set the connection listener

Parameters:

listener - the listener to set

clone

public ConnectionConfig clone()

Overrides:

clone in class Object

fromTcdsAuthUri

public static ConnectionConfig fromTcdsAuthUri(String uri,
 LiveViewAuth lvauth)
                                        throws LiveViewException

Creates a connection config from a TCDS URI and authentication (optional). Connects to the TCDS server to do so

Returns:

A connection config for the destination of the TCDS redirect with the proper auth configured

Throws:

LiveViewException - If the connection isn't a TCDS destination

Since:

11.0