com.streambase.liveview.client

Class LiveViewMultiConnectionImpl

java.lang.Object

com.streambase.liveview.client.LiveViewMultiConnectionImpl

All Implemented Interfaces:

LiveViewConnection, LiveViewMultiConnection

public class LiveViewMultiConnectionImpl
extends Object
implements LiveViewMultiConnection

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	LiveViewMultiConnectionImpl.DummyMultiConnectionListener

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

LiveViewConnection.TableProviderAPIHelper

Field Summary

Fields

Modifier and Type	Field and Description
protected org.slf4j.Logger	logger

Fields inherited from interface com.streambase.liveview.client.LiveViewConnection

CQS_INTERNAL_ID

Constructor Summary

Constructors

Constructor and Description
LiveViewMultiConnectionImpl(MultiConnectionConfig config)

Method Summary

Methods

Modifier and Type	Method and Description
void	addTableProvider(String id, com.streambase.liveview.internal.protocol.jaxb.ExternalConnectionTypeType externalConnectionType, String javaClassName, com.streambase.liveview.internal.protocol.jaxb.ExternalServerConnectionType.Parameters parameters, com.streambase.liveview.internal.protocol.jaxb.ExternalServerConnectionType.Mappings mappings, int maxFailAttempts, int waitSeconds) Connect to a TableProvider, which then allows for remote connections as if they were LiveView Tables.
boolean	checkPermission(LiveViewPermission permission) Checks whether the authenticated user has the specified permission.
List<Boolean>	checkPermissions(List<LiveViewPermission> permissions) Checks whether the authenticated user has the specified permissions.
void	close() Closes all queries and open resources with the server.
com.streambase.liveview.internal.protocol.jaxb.AlertRule	createAlertRule()
void	deleteAlertRule(Long id)
void	deleteQuery(Long id) deletes a QueryConfig on the server.
void	deleteRows(QueryConfig config) Delete rows based on the supplied QueryConfig.
Query	describeQuery(QueryConfig config) Get information about a query, such as its result schema, without actually running it
SnapshotResult	executeSnapshotQuery(QueryConfig config) This method makes it easy to run a snapshot-only query where the results come back in an object that can be iterated over to retrieve the snapshot tuples.
AlertManager	getAlertManager()
com.streambase.liveview.internal.protocol.jaxb.AlertRule	getAlertRule(long alertID)
List<com.streambase.liveview.internal.protocol.jaxb.AlertRule>	getAlertRules(String user)
<T extends LiveViewServerCapability> T	getCapability(Class<T> typeOfCapability) Returns the object that represents a capability of the connected server, or throws NoSuchCapabilityException if the type of capability is not supported by the server.
List<? extends LiveViewConnectionControl>	getConnectionControls() This list will have a one-for-one correspondence with the list of ConnectionConfigs or the list of URIs that were used to create this LiveViewMultiConnection.
String	getConnectionURI() Retrieves the URI that was used to connect to the server
LiveViewConnectionControl	getCurrentConnection() LiveViewConnectionControl of the "current" connection, if there is one.
MultiConnectionListener	getListener()
List<com.streambase.liveview.internal.protocol.jaxb.Response.GetNameValue.NameValue>	getNameValue(String name, String user)
short	getNextQueryId() Get the next one sequentially.
List<QueryConfig>	getQueries(String user) Lists all QueryConfigs for the given user.
long	getRetryIntervalMillis()
SendTupleInfo	getSendTupleInfo(StreamBaseURI sbUri, String inputStreamName, String outputStreamName) Gets the schemas associated with streams, for the purposes of using SendTupleAction.
Table	getTable(String name) Retrieve a specific table from the server
long	getTimeout()
com.streambase.liveview.internal.protocol.jaxb.VersionType	getVersion()
<T extends LiveViewServerCapability> boolean	hasCapability(Class<T> typeOfCapability) Returns true if the connected server supports the given type of capability.
boolean	isConnected() A polling method to check if the connection with the server is still valid.
List<Table>	listTables() Lists the available tables for querying
List<Table>	listTables(boolean includeSystemTables) List the available tables for querying
Query	registerQuery(QueryConfig config, QueryListener listener) Registers a new query on the server based on the QueryConfig and sends query events to the specified QueryListener.
void	registerTableListListener(TableListListener listener, boolean includeSnapshot) If you want to be informed of changes to the Table List, then register a Listener with this method.
void	removeTableProvider(String id) Disconnect a previously-connected TableGenerator
long	saveQuery(QueryConfig config) Saves a QueryConfig on the server.
Tuple	sendTupleAction(StreamBaseURI sbUri, String targetInputStreamName, Tuple tuple, String responseOutputStreamName, Schema expectedResponseSchema, long timeout, TimeUnit unit) Sends a tuple to an existing StreamBase application.
com.streambase.liveview.internal.protocol.jaxb.AlertRule	setAlertRule(com.streambase.liveview.internal.protocol.jaxb.AlertRule rule)
void	setNameValue(String name, String user, String value)
void	validateAlertRule(com.streambase.liveview.internal.protocol.jaxb.AlertRule rule)

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected org.slf4j.Logger logger

Constructor Detail

LiveViewMultiConnectionImpl

public LiveViewMultiConnectionImpl(MultiConnectionConfig config)

Parameters:

config -

Method Detail

getNextQueryId

public short getNextQueryId()

Get the next one sequentially. These are guaranteed to be unique.

getRetryIntervalMillis

public long getRetryIntervalMillis()

Returns:

the retryIntervalMillis

getTimeout

public long getTimeout()

Returns:

the timeout

getListener

public MultiConnectionListener getListener()

Returns:

the listener

getCurrentConnection

public LiveViewConnectionControl getCurrentConnection()

Description copied from interface: LiveViewMultiConnection

LiveViewConnectionControl of the "current" connection, if there is one. The current connection will always have a ConnectionState of CONNECTED. (At least, it did when this method returned.) If no connection is currently connected, this will return null.

Specified by:

getCurrentConnection in interface LiveViewMultiConnection

Returns:

LiveViewConnectionControl of the "current" connection, if there is one.

getConnectionControls

public List<? extends LiveViewConnectionControl> getConnectionControls()

Description copied from interface: LiveViewMultiConnection

This list will have a one-for-one correspondence with the list of ConnectionConfigs or the list of URIs that were used to create this LiveViewMultiConnection.

Specified by:

getConnectionControls in interface LiveViewMultiConnection

Returns:

All the connections currently under consideration.

listTables

public List<Table> listTables()
                       throws LiveViewException

Description copied from interface: LiveViewConnection

Lists the available tables for querying

Specified by:

listTables in interface LiveViewConnection

Returns:

List of tables available for querying

Throws:

LiveViewException - if table list cannot be retrieved

listTables

public List<Table> listTables(boolean includeSystemTables)
                       throws LiveViewException

Description copied from interface: LiveViewConnection

List the available tables for querying

Specified by:

listTables in interface LiveViewConnection

Parameters:

includeSystemTables - - if true, system tables are included in the list

Returns:

List of tables available for querying

Throws:

LiveViewException - if table list cannot be retrieved

registerTableListListener

public void registerTableListListener(TableListListener listener,
                             boolean includeSnapshot)
                               throws LiveViewException

Description copied from interface: LiveViewConnection

If you want to be informed of changes to the Table List, then register a Listener with this method. It will be called asynchronously, so beware of thread safety issues as you use this info. Call this with null if you no longer want to listen.

Specified by:

registerTableListListener in interface LiveViewConnection

includeSnapshot - if true, your listener will get current snapshot data (plus changes); if false, only changes.

Throws:

LiveViewException

getTable

public Table getTable(String name)
               throws LiveViewException

Description copied from interface: LiveViewConnection

Retrieve a specific table from the server

Specified by:

getTable in interface LiveViewConnection

Parameters:

name - name of the table to retrieve

Returns:

An instance of the server table

Throws:

LiveViewException - if the table does not exists or another server side error occurs.

close

public void close()

Description copied from interface: LiveViewConnection

Closes all queries and open resources with the server. A connection cannot be reused after closing.

Specified by:

close in interface LiveViewConnection

isConnected

public boolean isConnected()

Description copied from interface: LiveViewConnection

A polling method to check if the connection with the server is still valid. This method may block for network activity if the server is unresponsive.

Specified by:

isConnected in interface LiveViewConnection

Returns:

true is the connection with the server is valid, false otherwise.

hasCapability

public <T extends LiveViewServerCapability> boolean hasCapability(Class<T> typeOfCapability)

Description copied from interface: LiveViewConnection

Returns true if the connected server supports the given type of capability.

Specified by:

hasCapability in interface LiveViewConnection

Parameters:

typeOfCapability - Class that represents a capability

Returns:

True if the connected server supports the given type of capability, false if it doesn't or the connection is not active

getCapability

public <T extends LiveViewServerCapability> T getCapability(Class<T> typeOfCapability)
                                                 throws NoSuchCapabilityException,
                                                        LiveViewException

Description copied from interface: LiveViewConnection

Returns the object that represents a capability of the connected server, or throws NoSuchCapabilityException if the type of capability is not supported by the server.

Specified by:

getCapability in interface LiveViewConnection

Parameters:

typeOfCapability - Class that represents a capability

Returns:

The object that represents a capability of the connected server

Throws:

NoSuchCapabilityException - if the type of capability is not supported by the server

LiveViewException - if the LiveViewConnection is not currently connected.

registerQuery

public Query registerQuery(QueryConfig config,
                  QueryListener listener)

Description copied from interface: LiveViewConnection

Registers a new query on the server based on the QueryConfig and sends query events to the specified QueryListener. Depending on the query configuration the server will return snapshot only data or snapshot followed by continuous updates.

Specified by:

registerQuery in interface LiveViewConnection

Parameters:

config - the configuration of the query

listener - specifies the listener that will receive the query events

Returns:

a query object that the client can use to manage the query lifecycle. null will be return if server does not support new delete api (server version older than 1.5.2).

describeQuery

public Query describeQuery(QueryConfig config)
                    throws LiveViewException

Description copied from interface: LiveViewConnection

Get information about a query, such as its result schema, without actually running it

Specified by:

describeQuery in interface LiveViewConnection

Parameters:

config - the configuration of query

Returns:

a Query with information about the given configuration. The query is already closed; callers do not need to call Query.close() on the return value.

Throws:

LiveViewException - if there is a problem with the query configuration or another server exception occurs

deleteRows

public void deleteRows(QueryConfig config)
                throws LiveViewException

Description copied from interface: LiveViewConnection

Delete rows based on the supplied QueryConfig. The issuer of this delete does not know how many rows were removed, or when the delete completes. Only a subset of the QueryConfig options are valid for deleteRows, you may set:

• QueryConfig.setMaxResultSetSize(int)
• QueryConfig.setPredicate(java.lang.String)
• QueryConfig.setQuery(java.lang.String, java.lang.String)
• QueryConfig.setTable(java.lang.String)

deleteRows is effectively a snapshot query where the results of the query is the data to be deleted.

Specified by:

deleteRows in interface LiveViewConnection

Parameters:

config - the configuration of the query

Throws:

LiveViewException - if there is a problem with the query configuration or another server exception occurs

saveQuery

public long saveQuery(QueryConfig config)
               throws LiveViewException

Description copied from interface: LiveViewConnection

Saves a QueryConfig on the server. Will overwrite an existing query with the same Query id.

Specified by:

saveQuery in interface LiveViewConnection

Parameters:

config - of the query

Returns:

the id of this query

Throws:

LiveViewException - if there is a problem with the query or network issue

getQueries

public List<QueryConfig> getQueries(String user)
                             throws LiveViewException

Description copied from interface: LiveViewConnection

Lists all QueryConfigs for the given user. A user name of "*" returns all users queries.

Specified by:

getQueries in interface LiveViewConnection

Parameters:

user - name

Throws:

LiveViewException - if there is a problem with the query or network issue

deleteQuery

public void deleteQuery(Long id)
                 throws LiveViewException

Description copied from interface: LiveViewConnection

deletes a QueryConfig on the server.

Specified by:

deleteQuery in interface LiveViewConnection

Parameters:

id - of the query to delete

Throws:

LiveViewException - if there is a problem with the query or network issue

executeSnapshotQuery

public SnapshotResult executeSnapshotQuery(QueryConfig config)
                                    throws LiveViewException

Description copied from interface: LiveViewConnection

This method makes it easy to run a snapshot-only query where the results come back in an object that can be iterated over to retrieve the snapshot tuples. Note that the LiveViewQueryType setting in QueryConfig will be ignored because this method is always LiveViewQueryType.SNAPSHOT This method returns as soon as the query is successfully regiestered, but before the data has arrived. However, the SnapshotResult that is returned will block appropriately in its next and hasNext methods, so you can immediately start using it as if it were an iterator.

Specified by:

executeSnapshotQuery in interface LiveViewConnection

Parameters:

config - the configuration of the query

Returns:

Iterator pattern for retrieving the snapshot tuples

Throws:

LiveViewException - if there is a problem with the query configuration or another server exception occurs

getConnectionURI

public String getConnectionURI()

Description copied from interface: LiveViewConnection

Retrieves the URI that was used to connect to the server

Specified by:

getConnectionURI in interface LiveViewConnection

Returns:

URI used to make the server connection

setNameValue

public void setNameValue(String name,
                String user,
                String value)
                  throws LiveViewException

Throws:

LiveViewException

getNameValue

public List<com.streambase.liveview.internal.protocol.jaxb.Response.GetNameValue.NameValue> getNameValue(String name,
                                                                                                String user)
                                                                                                  throws LiveViewException

Throws:

LiveViewException

getVersion

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

Throws:

LiveViewException

addTableProvider

public void addTableProvider(String id,
                    com.streambase.liveview.internal.protocol.jaxb.ExternalConnectionTypeType externalConnectionType,
                    String javaClassName,
                    com.streambase.liveview.internal.protocol.jaxb.ExternalServerConnectionType.Parameters parameters,
                    com.streambase.liveview.internal.protocol.jaxb.ExternalServerConnectionType.Mappings mappings,
                    int maxFailAttempts,
                    int waitSeconds)
                      throws LiveViewException

Description copied from interface: LiveViewConnection

Connect to a TableProvider, which then allows for remote connections as if they were LiveView Tables.

Specified by:

addTableProvider in interface LiveViewConnection

Parameters:

id - must be unique on the LiveView server.

externalConnectionType - one of CEP_QUERY_TABLES, LIVE_VIEW, CUSTOM_TABLE_PROVIDER ExternalConnectionTypeType

javaClassName - The className of a class which implements com.streambase.liveview.server.table.TableProvider. Only used if type is CUSTOM_TABLE_PROVIDER.

parameters - key-value pairs that are specific to your TableGenerator. Use utility function TableProviderAPIHelper#addMapping(Mappings, String, String) to create and extend.

mappings - Table name selector and mapping definitions. Use utility function TableProviderAPIHelper#addParameter(Parameters, String, String) to create and extend.

maxFailAttempts - Maximum failures before giving up. Anything < 1 for infinite attempts

waitSeconds - Time to wait after a failure before trying. Anything < 1 becomes the default of 120 seconds.

Throws:

LiveViewException

See Also:

LiveViewConnection.TableProviderAPIHelper

removeTableProvider

public void removeTableProvider(String id)
                         throws LiveViewException

Description copied from interface: LiveViewConnection

Disconnect a previously-connected TableGenerator

Specified by:

removeTableProvider in interface LiveViewConnection

Parameters:

id - The exact id of the TableGenerator.

Throws:

LiveViewException

getAlertRules

public List<com.streambase.liveview.internal.protocol.jaxb.AlertRule> getAlertRules(String user)
                                                                             throws LiveViewException

Throws:

LiveViewException

getAlertRule

public com.streambase.liveview.internal.protocol.jaxb.AlertRule getAlertRule(long alertID)
                                                                      throws LiveViewException

Throws:

LiveViewException

createAlertRule

public com.streambase.liveview.internal.protocol.jaxb.AlertRule createAlertRule()

setAlertRule

public com.streambase.liveview.internal.protocol.jaxb.AlertRule setAlertRule(com.streambase.liveview.internal.protocol.jaxb.AlertRule rule)
                                                                      throws LiveViewException

Throws:

LiveViewException

deleteAlertRule

public void deleteAlertRule(Long id)
                     throws LiveViewException

Throws:

LiveViewException

validateAlertRule

public void validateAlertRule(com.streambase.liveview.internal.protocol.jaxb.AlertRule rule)
                       throws LiveViewException

Throws:

LiveViewException

getAlertManager

public AlertManager getAlertManager()
                             throws LiveViewException

Specified by:

getAlertManager in interface LiveViewConnection

Returns:

An AlertManager, which provides an API to manage alerts on this server.

Throws:

LiveViewException

sendTupleAction

public Tuple sendTupleAction(StreamBaseURI sbUri,
                    String targetInputStreamName,
                    Tuple tuple,
                    String responseOutputStreamName,
                    Schema expectedResponseSchema,
                    long timeout,
                    TimeUnit unit)
                      throws LiveViewException

Description copied from interface: LiveViewConnection

Sends a tuple to an existing StreamBase application. If responseOutputStreamName and expectedResponseSchema are BOTH non-null, it will wait for a corresponding tuple to be output from the outputStream. Note that the app must be written such that the BOTH the inputStream and the OutputStream must have a String field named "__SendTupleResponseKey" or it will give an error. This field will be set by the server when sending the tuple, and the response will be checked that it has the same value. (This is to prevent one client from getting a response that was intended for a different client). If the client has not included the responseOutputStreamName, then the field is not required.

Specified by:

sendTupleAction in interface LiveViewConnection

Parameters:

sbUri - (Optional) URI of the StreamBase server. The LV server's current SB server will be used if null.

targetInputStreamName - The pathname of the input stream to which to send the tuple

tuple - The tuple to send

responseOutputStreamName - (Optional) pathname of OutputStream to listen for a response

expectedResponseSchema - (Optional) The schema that the response is expected to have, likely retrieved via getSendTupleInfo

timeout - Maximum time to wait for response. Valid range is 50 - 120000 MILLISECONDS

unit - (Optional) units for the timeout. If null, TimeUnit.MILLISECONDS will be assumed.

Returns:

null unless outputStreamName and synchFieldName are both non-null, otherwise the response Tuple

Throws:

LiveViewException

getSendTupleInfo

public SendTupleInfo getSendTupleInfo(StreamBaseURI sbUri,
                             String inputStreamName,
                             String outputStreamName)
                               throws LiveViewException

Description copied from interface: LiveViewConnection

Gets the schemas associated with streams, for the purposes of using SendTupleAction.

Specified by:

getSendTupleInfo in interface LiveViewConnection

Parameters:

sbUri - (Optional) URI of the StreamBase server. The LV server's current SB server will be used if null.

inputStreamName - The pathname of the input stream to which to send the tuple

outputStreamName - (Optional) pathname of OutputStream to listen for a response

Returns:

information about the streams, as defined on the server.

Throws:

LiveViewException

checkPermission

public boolean checkPermission(LiveViewPermission permission)
                        throws LiveViewException

Description copied from interface: LiveViewConnection

Checks whether the authenticated user has the specified permission. This method always returns true when authentication is disabled.

Specified by:

checkPermission in interface LiveViewConnection

Parameters:

permission - a single permission to check for

Returns:

a boolean with true indicating the user has the permission being checked for and false otherwise

Throws:

LiveViewException

checkPermissions

public List<Boolean> checkPermissions(List<LiveViewPermission> permissions)
                               throws LiveViewException

Description copied from interface: LiveViewConnection

Checks whether the authenticated user has the specified permissions. This method always returns true when authentication is disabled.

Specified by:

checkPermissions in interface LiveViewConnection

Parameters:

permissions - a list of permissions to check for

Returns:

a list of booleans corresponding to the permissions being checked for, with true indicating the user has the permission

Throws:

LiveViewException