com.streambase.liveview.client

Class LiveViewConnectionControlImpl

java.lang.Object

com.streambase.liveview.client.LiveViewConnectionControlImpl

All Implemented Interfaces:

LiveViewConnectionControl

public class LiveViewConnectionControlImpl
extends Object
implements LiveViewConnectionControl

Nested Class Summary

Nested classes/interfaces inherited from interface com.streambase.liveview.client.LiveViewConnectionControl

LiveViewConnectionControl.ConnectionState

Constructor Summary

Constructors

Constructor and Description
LiveViewConnectionControlImpl(LiveViewMultiConnectionImpl liveViewMultiConnectionImpl, ConnectionConfig singleConfig)

Method Summary

Methods

Modifier and Type	Method and Description
ConnectionConfig	getConnectionConfig()
LiveViewConnectionControl.ConnectionState	getConnectionState()
long	getLastSuccessfulConnect() If the current status is CONNECTED, this will have the time this connection was made.
LiveViewConnection	getLiveViewConnection()
int	getRetryCount() Valid only if the current state is TRYING_TO_CONNECT.
String	getUri() Convenience method that is the same as getConnectionConfig().getUri()
com.streambase.liveview.internal.protocol.jaxb.VersionType	getVersion() If this server has never been successfully connected to, this value will be null.
boolean	isCurrent()
void	setActive(boolean active) If a connection is set to be inactive, it will stop attempting to connect to the server.
void	synchronousConnect()

Methods inherited from class java.lang.Object

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

Constructor Detail

LiveViewConnectionControlImpl

public LiveViewConnectionControlImpl(LiveViewMultiConnectionImpl liveViewMultiConnectionImpl,
                             ConnectionConfig singleConfig)

Parameters:

liveViewMultiConnectionImpl -

singleConfig -

Method Detail

synchronousConnect

public void synchronousConnect()
                        throws LiveViewConnectionCanceledException,
                               LiveViewException

Throws:

LiveViewConnectionCanceledException

LiveViewException

getConnectionConfig

public ConnectionConfig getConnectionConfig()

Specified by:

getConnectionConfig in interface LiveViewConnectionControl

Returns:

the connectionConfig that was / will be used to create this connection.

getUri

public String getUri()

Description copied from interface: LiveViewConnectionControl

Convenience method that is the same as getConnectionConfig().getUri()

Specified by:

getUri in interface LiveViewConnectionControl

Returns:

The URI to the server represented by this ConnectionControl.

isCurrent

public boolean isCurrent()

Specified by:

isCurrent in interface LiveViewConnectionControl

Returns:

true if this connection is the currently active connection

getConnectionState

public LiveViewConnectionControl.ConnectionState getConnectionState()

Specified by:

getConnectionState in interface LiveViewConnectionControl

Returns:

The state of this connection.

getLastSuccessfulConnect

public long getLastSuccessfulConnect()

Description copied from interface: LiveViewConnectionControl

If the current status is CONNECTED, this will have the time this connection was made.

Specified by:

getLastSuccessfulConnect in interface LiveViewConnectionControl

Returns:

time of last successful connect, or Long.MIN_VALUE if never connected.

getVersion

public com.streambase.liveview.internal.protocol.jaxb.VersionType getVersion()

Description copied from interface: LiveViewConnectionControl

If this server has never been successfully connected to, this value will be null.

Specified by:

getVersion in interface LiveViewConnectionControl

Returns:

The version information received from the server in the last successful connect to it, if there have been any.

getRetryCount

public int getRetryCount()

Description copied from interface: LiveViewConnectionControl

Valid only if the current state is TRYING_TO_CONNECT. It is the number of tries since the last successful connect, or since startup if there has never been a successful connect to this server.

Specified by:

getRetryCount in interface LiveViewConnectionControl

Returns:

number of tries since the last successful connect

setActive

public void setActive(boolean active)

Description copied from interface: LiveViewConnectionControl

If a connection is set to be inactive, it will stop attempting to connect to the server.

Specified by:

setActive in interface LiveViewConnectionControl

getLiveViewConnection

public LiveViewConnection getLiveViewConnection()

Returns:

the liveViewConnection