Package | Description |
---|---|
com.streambase.liveview.client |
Provides classes and interfaces fundamental to the TIBCO Live Datamart Java API.
|
com.streambase.liveview.client.alert |
Provides classes and interfaces to set Alerts.
|
com.streambase.liveview.client.clientcontrol |
Provides classes and interfaces to control user's interaction with the TIBCO Live Datamart.
|
com.streambase.liveview.client.serverdatautility |
Provides classes and interfaces to fetch TIBCO Live Datamart server's utility data.
|
com.streambase.liveview.server.table.plugin |
Provides classes and interfaces to add custom table providers to TIBCO Live Datamart.
|
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(java.lang.Throwable cause)
Wraps any throwable into a LiveViewException of type LiveViewExceptionType.UNEXPECTED
|
LiveViewException |
DynamicTableState.getException() |
LiveViewException |
QueryExceptionEvent.getException()
Get the exception
|
Modifier and Type | Method and Description |
---|---|
DynamicTableState |
DynamicTableState.setException(LiveViewException exception) |
Modifier and Type | Method and Description |
---|---|
void |
LiveViewConnection.addTableProvider(java.lang.String id,
com.streambase.liveview.internal.protocol.jaxb.ExternalConnectionTypeType externalConnectionType,
java.lang.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(java.lang.String id,
com.streambase.liveview.internal.protocol.jaxb.ExternalConnectionTypeType externalConnectionType,
java.lang.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.
|
java.util.List<java.lang.Boolean> |
LiveViewConnection.checkPermissions(java.util.List<LiveViewPermission> permissions)
Checks whether the authenticated user has the specified permissions.
|
void |
TableAdminManager.createAggregateTable(java.lang.String tablename,
java.lang.String descripton,
QueryConfig aggregateQuery,
java.util.List<java.util.List<java.lang.String>> indices)
Create a table that is based on an aggregate query against an existing table.
|
void |
TableAdminManager.createTable(java.lang.String tableName,
java.lang.String description,
Schema schema,
java.util.List<java.util.List<java.lang.String>> indices)
Create a table on the server without any LVConf which represents it.
|
void |
TableAdminManager.createTable(java.lang.String tableName,
java.lang.String description,
Schema schema,
java.lang.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(java.lang.String tableName,
java.lang.String description,
java.lang.String schema,
java.util.List<java.util.List<java.lang.String>> indices)
Create a table on the server without any LVConf which represents it.
|
void |
TableAdminManager.createTable(java.lang.String tableName,
java.lang.String description,
java.lang.String schema,
java.lang.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(TableConfig tableConfig)
Create a table using a TableConfig.
|
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(java.lang.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(java.lang.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(java.lang.String uri)
Retrieves a
LiveViewConnection based on a valid URI. |
java.util.List<Schema.Field> |
DeleteQueryListener.getFields()
Retrieves the fields describing the tuples that will be returned.
|
java.util.List<Schema.Field> |
SnapshotQueryListener.getFields()
Retrieves the fields describing the tuples that will be returned.
|
java.util.List<Schema.Field> |
SnapshotResult.getFields()
Retrieves the fields describing the tuples that will be returned.
|
SendTupleInfo |
LiveViewConnection.getSendTupleInfo(StreamBaseURI sbUri,
java.lang.String targetInputStreamName,
java.lang.String responseOutputStreamName)
Gets the schemas associated with streams, for the purposes of using SendTupleAction.
|
Table |
LiveViewConnection.getTable(java.lang.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.
|
java.util.List<Table> |
LiveViewConnection.listTables()
Lists the available tables for querying
|
java.util.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,
java.lang.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(java.lang.String id)
Deprecated.
Use
TableAdminManager , instead |
void |
TableAdminManager.removeTableProvider(java.lang.String id)
Disconnect a previously-connected TableProvider.
|
Tuple |
LiveViewConnection.sendTupleAction(StreamBaseURI sbUri,
java.lang.String targetInputStreamName,
Tuple tuple,
java.lang.String responseOutputStreamName,
Schema expectedResponseSchema,
long timeout,
java.util.concurrent.TimeUnit unit)
Sends a tuple to an existing StreamBase application.
|
ConnectionConfig |
ConnectionConfig.setPassword(java.lang.String password)
Set the password to connect with
|
ConnectionConfig |
ConnectionConfig.setUri(java.lang.String uri)
Set the uri to connect with.
|
ConnectionConfig |
ConnectionConfig.setUsername(java.lang.String username)
Set the username to connect with
|
void |
TableAdminManager.startTables(java.lang.String... tables)
This will start all the tables in the list and any applications or elements upon which they depend.
|
Constructor and Description |
---|
QueryExceptionEvent(java.lang.Object source,
LiveViewException exception) |
Constructor and Description |
---|
AbstractTable(Schema schema,
java.util.List<java.lang.String> keyFieldNames) |
AbstractTable(Schema schema,
java.lang.String keyFieldNamesCSV) |
MultiConnectionConfig(java.util.List<java.lang.String> uris,
java.lang.String username,
java.lang.String password,
MultiConnectionListener listener)
Use this constructor if the servers all use the same username and password (which can be null)
|
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)
Deprecated.
Use ExecJavaActionClass
|
void |
AlertManager.deleteAlertRule(java.lang.Long id)
Deletes the given alert rule from the server.
|
AlertRule |
AlertManager.getAlertRule(long alertID)
Gets the alert rule specified by the id.
|
java.util.List<AlertRule> |
AlertManager.getAlertRules(java.lang.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(java.lang.String sessionID,
java.lang.String publisherID)
Kills the specific publisher based on ID from the server.
|
SnapshotResult |
ClientController.killPublishersWithPredicate(java.lang.String predicate)
Kills publishers referring to the rows in the LVSessionPublishers Table that satisfy the predicate against LVSessionPublishers Table.
|
SnapshotResult |
ClientController.killQueriesWithPredicate(java.lang.String predicate)
Kills queries referring to the rows in the LVSessionQueries Table that satisfy the predicate against LVSessionQueries Table.
|
void |
ClientController.killQuery(java.lang.String sessionID,
java.lang.String queryID)
Kills the specific query based on ID from the server.
|
void |
ClientController.killSession(java.lang.String sessionID)
Kills the specific session based on ID from the server.
|
SnapshotResult |
ClientController.killSessionsWithPredicate(java.lang.String predicate)
Kills sessions referring to the rows in the LVSessions Table that satisfy the predicate against LVSessions Table.
|
void |
ClientController.stopNewSessions(boolean stopNewSession)
Stops accepting new sessions
|
Modifier and Type | Method and Description |
---|---|
StreambaseStreams |
ServerUtilityDataProvider.getStreambaseStreams(java.lang.String sbUri)
Returns all the input and output streams for a given streambase URI
|
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
|
java.util.Map<java.lang.String,AbstractConfigObject> |
TableProviderManager.compileLVConfs(java.util.List<java.io.File> tableFiles,
boolean buildYaml) |
TablePublisher |
TestTableProvider.UnsupportedTable.createPublisher(java.lang.String publisherName) |
void |
TestTableProvider.UnsupportedTable.doDelete(java.lang.String id,
QueryModel query) |
void |
TableProviderManager.dropTables(java.util.List<java.lang.String> tables) |
void |
TableProvider.initialize(java.lang.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(java.lang.String id,
TableProviderControl helper,
TableProviderParameters parameters,
TableNameMapper mapper) |
java.io.File |
TableProviderControl.locateFile(java.lang.String filename,
boolean required)
This will attempt to locate a file within the project.
|
java.io.File |
TableProviderControlImpl.locateFile(java.lang.String filename,
boolean required) |
QueryModel |
TestTableProvider.UnsupportedTable.parseQuery(CatalogedTable catalogedTable,
java.lang.String queryString,
LiveViewQueryType type,
boolean includeInternal) |
void |
TableProviderManager.registerDependentTables(TableType tableInfo,
CatalogedTable baseCatalogedTable,
boolean useDynamicStates) |
void |
TableProviderManager.registerNewDynamicTable(java.lang.String name,
DataTable dataTable,
Table.TableStatus initialStatus,
java.lang.String statusMessage) |
void |
TestTableProvider.UnsupportedTable.removeListener(EventListener listener) |
void |
TableProviderManager.removeTableProvider(java.lang.String id)
Disconnect a previously-connected TableProvider.
|
void |
TableProviderManager.saveLVConf(java.lang.String name,
LiveviewConfiguration conf,
boolean saveInProject) |
void |
TableProviderControl.setEnabled(java.lang.String tableId,
boolean enabled)
Change the enabled state of an existing table.
|
void |
TableProviderControlImpl.setEnabled(java.lang.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(java.util.List<java.lang.String> tables) |
void |
TableProviderManager.validateDependentTables(LiveviewConfiguration conf) |