| Package | Description |
|---|---|
| com.streambase.liveview.client |
Provides classes and interfaces fundamental to the TIBCO Live Datamart Java API.
|
| com.streambase.liveview.client.alert | |
| com.streambase.liveview.client.clientcontrol | |
| com.streambase.liveview.server.table.plugin |
| Modifier and Type | Class and Description |
|---|---|
class |
LiveViewConnectionCanceledException
Exception throws when the LiveView connection call is cancelled by the client
|
class |
LiveViewQuerySyntaxException
Specific LiveViewException thrown when query syntax error occurs
|
| Modifier and Type | Method and Description |
|---|---|
static LiveViewException |
LiveViewExceptionType.error(Throwable cause)
Wraps any throwable into a LiveViewException of type LiveViewExceptionType.UNEXPECTED
|
LiveViewException |
QueryExceptionEvent.getException()
Get the exception
|
| Modifier and Type | Method and Description |
|---|---|
void |
LiveViewConnection.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)
Deprecated.
Use
TableAdminManager, instead
Connect to a TableProvider, which then allows for remote connections as if they were LiveView Tables. |
void |
TableAdminManager.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 to behave as if they were LiveView Tables.
|
boolean |
LiveViewConnection.checkPermission(LiveViewPermission permission)
Checks whether the authenticated user has the specified permission.
|
List<Boolean> |
LiveViewConnection.checkPermissions(List<LiveViewPermission> permissions)
Checks whether the authenticated user has the specified permissions.
|
void |
TableAdminManager.createAggregateTable(String tablename,
String descripton,
QueryConfig aggregateQuery,
List<List<String>> indices)
Create a table that is based on an aggregate query against an existing table.
|
void |
TableAdminManager.createTable(String tableName,
String description,
Schema schema,
List<List<String>> indices)
Create a table on the server without any LVConf which represents it.
|
void |
TableAdminManager.createTable(String tableName,
String description,
Schema schema,
String... primaryKeyFields)
Convenience form of the previous method, used if there is only a primary key, and that key is only a single field.
|
void |
TableAdminManager.createTable(String tableName,
String description,
String schema,
List<List<String>> indices)
Create a table on the server without any LVConf which represents it.
|
void |
TableAdminManager.createTable(String tableName,
String description,
String schema,
String... primaryKeyFields)
Convenience form of the previous method, used if there is only a primary key, and that key is only a single field.
|
void |
LiveViewConnection.deleteRows(QueryConfig config)
Delete rows based on the supplied
QueryConfig. |
Query |
LiveViewConnection.describeQuery(QueryConfig config)
Get information about a query, such as its result schema, without actually running it
|
void |
TableAdminManager.dropTables(String... tables)
This will drop the tables in the list.
|
SnapshotResult |
LiveViewConnection.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.
|
void |
TablePublisher.flush()
Force the currently buffered tuples to be sent to the server.
|
AlertManager |
LiveViewConnection.getAlertManager() |
<T extends LiveViewServerCapability> |
LiveViewConnection.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.
|
ClientController |
LiveViewConnection.getClientController()
A ClientController is used to perform actions to control clients.
|
static LiveViewConnection |
LiveViewConnectionFactory.getConnection(ConnectionConfig config)
Retrieves a
LiveViewConnection based on the ConnectionConfig |
static LiveViewMultiConnection |
LiveViewConnectionFactory.getConnection(MultiConnectionConfig config,
boolean waitForConnection)
Retrieves a
LiveViewMultiConnection based on the given MultiConnectionConfig. |
static LiveViewConnection |
LiveViewConnectionFactory.getConnection(String uri)
Retrieves a
LiveViewConnection based on a valid URI. |
List<Schema.Field> |
DeleteQueryListener.getFields()
Retrieves the fields describing the tuples that will be returned.
|
List<Schema.Field> |
SnapshotQueryListener.getFields()
Retrieves the fields describing the tuples that will be returned.
|
List<Schema.Field> |
SnapshotResult.getFields()
Retrieves the fields describing the tuples that will be returned.
|
SendTupleInfo |
LiveViewConnection.getSendTupleInfo(StreamBaseURI sbUri,
String targetInputStreamName,
String responseOutputStreamName)
Gets the schemas associated with streams, for the purposes of using SendTupleAction.
|
Table |
LiveViewConnection.getTable(String name)
Retrieve a specific table from the server
|
TableAdminManager |
LiveViewConnection.getTableAdminManager()
Get the TableAdminManager, which provides an API to administer tables in the server.
|
boolean |
DeleteQueryListener.hasNext()
See if there are more tuples to retrieve.
|
boolean |
SnapshotQueryListener.hasNext()
See if there are more tuples to retrieve.
|
boolean |
SnapshotResult.hasNext()
See if there are more tuples to retrieve.
|
List<Table> |
LiveViewConnection.listTables()
Lists the available tables for querying
|
List<Table> |
LiveViewConnection.listTables(boolean includeSystemTables)
List the available tables for querying
|
Tuple |
DeleteQueryListener.next()
Retrieves the next tuple in the result.
|
Tuple |
SnapshotQueryListener.next()
Retrieves the next tuple in the result.
|
Tuple |
SnapshotResult.next()
Retrieves the next tuple in the result.
|
void |
TablePublisher.publish(long sequenceNumber,
Boolean CQSDelete,
Tuple tuple)
Publish a tuple with a sequenceNumber.
|
void |
TablePublisher.publish(long sequenceNumber,
Tuple tuple)
Publish a tuple with a sequenceNumber.
|
void |
TablePublisher.publish(Tuple tuple)
Publish a tuple without regard for recovering since no sequence number is specified.
|
void |
LiveViewConnection.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 |
LiveViewConnection.removeTableProvider(String id)
Deprecated.
Use
TableAdminManager, instead |
void |
TableAdminManager.removeTableProvider(String id)
Disconnect a previously-connected TableProvider
|
Tuple |
LiveViewConnection.sendTupleAction(StreamBaseURI sbUri,
String targetInputStreamName,
Tuple tuple,
String responseOutputStreamName,
Schema expectedResponseSchema,
long timeout,
TimeUnit unit)
Sends a tuple to an existing StreamBase application.
|
void |
TableAdminManager.startTables(String... tables)
This will start all the tables in the list AND any applications or elements upon which they depend.
|
| Constructor and Description |
|---|
QueryExceptionEvent(Object source,
LiveViewException exception) |
| Constructor and Description |
|---|
AbstractTable(Schema schema,
List<String> keyFieldNames) |
AbstractTable(Schema schema,
String keyFieldNamesCSV) |
| Modifier and Type | Method and Description |
|---|---|
boolean |
IExecJavaAction.action(com.streambase.liveview.internal.protocol.jaxb.AlertRule actionRule,
com.streambase.liveview.internal.protocol.jaxb.AlertRule.Actions.Action action,
TupleAddedEvent event)
action
|
void |
AlertManager.deleteAlertRule(Long id)
Deletes the given alert rule from the server.
|
AlertRule |
AlertManager.getAlertRule(long alertID)
Gets the alert rule specified by the id.
|
List<AlertRule> |
AlertManager.getAlertRules(String user)
Gets all available alert rules from the server for the given user.
|
AlertRule |
AlertManager.setAlertRule(AlertRule rule)
Adds if it does not previously exist, or overwrites if it does (matching by id),
the given alert rule onto the server.
|
void |
AlertManager.validateAlertRule(AlertRule rule)
Validates the given alert rule.
|
| Modifier and Type | Method and Description |
|---|---|
void |
ClientController.killPublisher(String sessionID,
String publisherID)
Kills the specific publisher based on ID from the server.
|
SnapshotResult |
ClientController.killPublishersWithPredicate(String predicate)
Kills publishers referring to the rows in the LVSessionPublishers Table that satisfy the predicate against LVSessionPublishers Table.
|
SnapshotResult |
ClientController.killQueriesWithPredicate(String predicate)
Kills queries referring to the rows in the LVSessionQueries Table that satisfy the predicate against LVSessionQueries Table.
|
void |
ClientController.killQuery(String sessionID,
String queryID)
Kills the specific query based on ID from the server.
|
void |
ClientController.killSession(String sessionID)
Kills the specific session based on ID from the server.
|
SnapshotResult |
ClientController.killSessionsWithPredicate(String predicate)
Kills sessions referring to the rows in the LVSessions Table that satisfy the predicate against LVSessions Table.
|
| Modifier and Type | Method and Description |
|---|---|
void |
TestTableProvider.UnsupportedTable.addListener(EventListener listener,
LiveViewQueryType type,
QueryModel query) |
void |
TableProviderManager.addTableProvider(com.streambase.liveview.internal.protocol.jaxb.ExternalServerConnectionType externalServer,
int retryCount)
Connect to a TableProvider, which then allows for remote connections as if they were LiveView Tables
|
Map<String,AbstractConfigObject> |
TableProviderManager.compileLVConfs(List<File> tableFiles,
boolean buildYaml) |
TablePublisher |
TestTableProvider.UnsupportedTable.createPublisher(String publisherName) |
void |
TestTableProvider.UnsupportedTable.doDelete(String id,
QueryModel query) |
void |
TableProviderManager.dropTables(List<String> tables) |
void |
TableProvider.initialize(String id,
TableProviderControl helper,
TableProviderParameters parameters,
TableNameMapper mapper)
An instance of your class will be initialized with the parameters that were defined in the LVConf.
|
void |
TestTableProvider.initialize(String id,
TableProviderControl helper,
TableProviderParameters parameters,
TableNameMapper mapper) |
File |
TableProviderControl.locateFile(String filename,
boolean required)
This will attempt to locate a file within the project.
|
File |
TableProviderControlImpl.locateFile(String filename,
boolean required) |
QueryModel |
TestTableProvider.UnsupportedTable.parseQuery(CatalogedTable catalogedTable,
String queryString,
LiveViewQueryType type,
boolean includeInternal) |
CatalogedTable |
TableProviderManager.registerFilteredTableAlias(CatalogedTable baseCatalogTable,
String predicateFilter,
String tableNameFormatter)
The method is used to register filtered tables from the base table
|
void |
TableProviderManager.registerNewTable(String name,
DataTable dataTable,
Table.TableStatus initialStatus,
String statusMessage) |
void |
TestTableProvider.UnsupportedTable.removeListener(EventListener listener) |
void |
TableProviderManager.removeTableProvider(String id)
Disconnect a previously-connected TableProvider.
|
void |
TableProviderControl.setEnabled(String tableId,
boolean enabled)
Change the enabled state of an existing table.
|
void |
TableProviderControlImpl.setEnabled(String tableId,
boolean enabled) |
void |
TableProviderManager.shutdown() |
void |
TableProvider.start()
You should connect to your server successfully before returning from this call.
|
void |
TestTableProvider.start() |
void |
TableProviderManager.startTables(List<String> tables) |