Package | Description |
---|---|
com.streambase.liveview.client |
Provides classes and interfaces fundamental to the TIBCO Live Datamart Java API.
|
com.streambase.liveview.client.alert |
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 |
---|---|
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)
Connect to a TableProvider, which then allows for remote connections as if they were LiveView Tables.
|
void |
LiveViewMultiConnectionImpl.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) |
boolean |
LiveViewConnection.checkPermission(LiveViewPermission permission)
Checks whether the authenticated user has the specified permission.
|
boolean |
LiveViewMultiConnectionImpl.checkPermission(LiveViewPermission permission) |
List<Boolean> |
LiveViewConnection.checkPermissions(List<LiveViewPermission> permissions)
Checks whether the authenticated user has the specified permissions.
|
List<Boolean> |
LiveViewMultiConnectionImpl.checkPermissions(List<LiveViewPermission> permissions) |
void |
LiveViewMultiConnectionImpl.deleteAlertRule(Long id) |
void |
LiveViewConnection.deleteQuery(Long id)
Deprecated.
|
void |
LiveViewMultiConnectionImpl.deleteQuery(Long id) |
void |
LiveViewConnection.deleteRows(QueryConfig config)
Delete rows based on the supplied
QueryConfig . |
void |
LiveViewMultiConnectionImpl.deleteRows(QueryConfig config) |
Query |
LiveViewConnection.describeQuery(QueryConfig config)
Get information about a query, such as its result schema, without actually running it
|
Query |
LiveViewMultiConnectionImpl.describeQuery(QueryConfig config) |
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.
|
SnapshotResult |
LiveViewMultiConnectionImpl.executeSnapshotQuery(QueryConfig config) |
void |
TablePublisher.flush()
Force the currently buffered tuples to be sent to the server.
|
AlertManager |
LiveViewConnection.getAlertManager() |
AlertManager |
LiveViewMultiConnectionImpl.getAlertManager() |
com.streambase.liveview.internal.protocol.jaxb.AlertRule |
LiveViewMultiConnectionImpl.getAlertRule(long alertID) |
List<com.streambase.liveview.internal.protocol.jaxb.AlertRule> |
LiveViewMultiConnectionImpl.getAlertRules(String user) |
<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.
|
<T extends LiveViewServerCapability> |
LiveViewMultiConnectionImpl.getCapability(Class<T> typeOfCapability) |
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.
|
List<com.streambase.liveview.internal.protocol.jaxb.Response.GetNameValue.NameValue> |
LiveViewMultiConnectionImpl.getNameValue(String name,
String user) |
List<QueryConfig> |
LiveViewConnection.getQueries(String user)
Deprecated.
|
List<QueryConfig> |
LiveViewMultiConnectionImpl.getQueries(String user) |
SendTupleInfo |
LiveViewConnection.getSendTupleInfo(StreamBaseURI sbUri,
String targetInputStreamName,
String responseOutputStreamName)
Gets the schemas associated with streams, for the purposes of using SendTupleAction.
|
SendTupleInfo |
LiveViewMultiConnectionImpl.getSendTupleInfo(StreamBaseURI sbUri,
String inputStreamName,
String outputStreamName) |
Table |
LiveViewConnection.getTable(String name)
Retrieve a specific table from the server
|
Table |
LiveViewMultiConnectionImpl.getTable(String name) |
com.streambase.liveview.internal.protocol.jaxb.VersionType |
LiveViewMultiConnectionImpl.getVersion() |
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> |
LiveViewMultiConnectionImpl.listTables() |
List<Table> |
LiveViewConnection.listTables(boolean includeSystemTables)
List the available tables for querying
|
List<Table> |
LiveViewMultiConnectionImpl.listTables(boolean includeSystemTables) |
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 |
LiveViewMultiConnectionImpl.registerTableListListener(TableListListener listener,
boolean includeSnapshot) |
void |
LiveViewConnection.removeTableProvider(String id)
Disconnect a previously-connected TableGenerator
|
void |
LiveViewMultiConnectionImpl.removeTableProvider(String id) |
long |
LiveViewConnection.saveQuery(QueryConfig config)
Deprecated.
|
long |
LiveViewMultiConnectionImpl.saveQuery(QueryConfig config) |
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.
|
Tuple |
LiveViewMultiConnectionImpl.sendTupleAction(StreamBaseURI sbUri,
String targetInputStreamName,
Tuple tuple,
String responseOutputStreamName,
Schema expectedResponseSchema,
long timeout,
TimeUnit unit) |
com.streambase.liveview.internal.protocol.jaxb.AlertRule |
LiveViewMultiConnectionImpl.setAlertRule(com.streambase.liveview.internal.protocol.jaxb.AlertRule rule) |
void |
LiveViewMultiConnectionImpl.setNameValue(String name,
String user,
String value) |
void |
LiveViewConnectionControlImpl.synchronousConnect() |
void |
LiveViewMultiConnectionImpl.validateAlertRule(com.streambase.liveview.internal.protocol.jaxb.AlertRule rule) |
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.
|