Package com.streambase.liveview.client
Provides classes and interfaces fundamental to the TIBCO LiveView Java API.
-
Interface Summary Interface Description ConnectionListener A connection listener interface that can be provided toConnectionConfig
to receive connection related events on.KeyValue KeyValue represents a specific value of the primary key, as taken from the Tuple in a specific Table, including if the Table has a complex key involving multiple fields.LiveViewConnection A client connection to a LiveView server.LiveViewConnectionControl When using a LiveViewMultiConnection, this represents one of the connections.LiveViewMultiConnection Interface representing a connection to a pool of servers (retrieved viaLiveViewConnectionFactory.getConnection(MultiConnectionConfig, boolean)
.) Note that while this is aLiveViewConnection
, some operations of that interface will fail with an appropriate error codeLiveViewExceptionType.NOT_SUPPORTED_IN_MULTISERVER
.MultiConnectionListener Register your implementation of this interface if you want to be informed of all the events involved in multi-connectOrderDefinition.OrderDefinitionVisitor ProgressMonitor This interface can be used inConnectionConfig
to receive feedback onLiveViewConnectionFactory.getConnection(ConnectionConfig)
.PublisherListener PublisherStatus Query A handle to a registered query.QueryListener A query listener interface must be provided when registering a query.SnapshotResult A blocking iterator pattern for retrieving snapshot only results.Table An instance of a LiveView table.TableAdminManager TableAdminManager is used to start and stop tables and table providers on the server.TableListListener Create an instance of this if you want to be informed of changes to the Table List.TablePublisher An instance of a publisher for publishing tuples into a table. -
Class Summary Class Description AbstractBatchedQueryListener An abstract implementation of aQueryListener
that batches up multiple events and sends them to the concrete implementation.AbstractConnectionEvent Root level of client to server connection related events which are dispatched toConnectionListener
s.AbstractPublisherEvent The base type for publisher events dispatched as a result of events published to the server.AbstractPublisherListener A convenience implementation ofPublisherListener
that can be extended and the specified methods can be overridden.AbstractQueryEvent The base type for query events dispatched from server queries toQueryListener
s.AbstractQueryListener A convenience implementation ofQueryListener
that can be extended and the specified methods can be overridden.AbstractTable AbstractTupleEvent Base abstract class for TupleEventsBeginAggMarkEvent The event dispatched after which the aggregate result set may be in flux.BeginDeleteEvent The event dispatched when a query delete begins.BeginSnapshotEvent The event dispatched when a query snapshot begins.CompositeQueryListener A convenience implementation ofQueryListener
that enables notifications of zero or more listeners.ConnectionClosedEvent Event dispatched when aLiveViewConnection
closes.ConnectionConfig Connection configuration used to connect to LiveView server.DataStatus Helps to describe the details of import process.DeleteQueryListener A Convenience implementation ofQueryListener
that provides a pull based iterator pattern for iterating over snapshot queries.DynamicTableState DynamicTableState keeps track of table state while dropping or starting table in synchronous mode.EndAggMarkEvent The event dispatched when the aggregate result set sent since the last BeginAggMarkEvent is consistent and will not change again until the next BeginAggMarkEvent.EndDeleteEvent The event dispatched when a query delete ends.EndSnapshotEvent The event dispatched when a query snapshot ends.HashableTuple HashableTuple is a wrapper for Tuples from a single Query so they can be stored in a HashSet.LiveResult A live result is aQueryListener
the receives and maintains a local copy of tuples.LiveViewConnectionFactory A factory for retrieving aLiveViewConnection
based onConnectionConfig
A connection can also be retrieved by provide a simple String based URI.LiveViewPermission Class that defines LiveView permissions.LiveViewProperties.AlertActions LiveViewServerCapability An abstract class for objects that represent a capability of a LiveView server.LiveViewServerCapability.AggregateMarkGeneration LiveViewServerCapability.AlertRules LiveViewServerCapability.AlertWithClusterGroup LiveViewServerCapability.AlertWithGUID LiveViewServerCapability.AlertWithQueryString LiveViewServerCapability.AlertWithQuiescence LiveViewServerCapability.BlockingDeleteQuery LiveViewServerCapability.ClientVersionAware LiveViewServerCapability.ClosablePublisher LiveViewServerCapability.DataOnRemoveMessage LiveViewServerCapability.ExternalLiveViewHosting LiveViewServerCapability.FullSchemas LiveViewServerCapability.PluggableTableProviders LiveViewServerCapability.PublishSupportsByteOrder LiveViewServerCapability.PublishV2 LiveViewServerCapability.ReferenceTablesDirectly LiveViewServerCapability.ReliablePublisher LiveViewServerCapability.SavedWorkspaces LiveViewServerCapability.SeparatelyTransmittedExtendedKeys LiveViewServerCapability.WorkspacesWithGUID MultiConnectionConfig Used to define aLiveViewMultiConnection
.MultiConnectionListener.MultiConnectionListenerBase When implmenting MultiConnectionListener, if you extend this base class you'll have version protection.NullProgressMonitor OrderDefinition OrderDefinition is the object used to define the order in which you wish to receive dataPublisherExceptionEvent PublisherStatusEvent The event dispatched when a new publisher status is available.PubListenerConfig QueryClosedEvent Event dispatched to a listener when a query is closedQueryConfig QueryConfig is the builder object used to configure a query.QueryExceptionEvent The event dispatched when a query exception occurs.QueryListenerWrapper This class is used by LiveViewMultiConnectionImpl to wrap BOTH the queryListener that the user passes in to an execQuery, AND the Query that is passed back to him.SemanticInterpretation SendTupleInfo SnapshotQueryListener A Convenience implementation ofQueryListener
that provides a pull based iterator pattern for iterating over snapshot queries.TableAdminManager.TableProviderAPIHelper Utility methods for working with the TableProviderAPITupleAddedEvent The event dispatched when a new Tuple is added to a query result.TupleRemovedEvent The event dispatched when an existing Tuple is removed.TupleUpdatedEvent The event dispatched when an existing Tuple is updated.Version Provides information about the StreamBase LiveView Client Library. -
Enum Summary Enum Description ConnectionMode Used when creating aMultiConnectionConfig
to define how it will connect to the servers.DataStatus.STATUS Enum for possible STATUS for data import process.LiveViewClientCapability Enumerates certain capabilities that may be supported by a LiveView Client.LiveViewConnectionControl.ConnectionState The status of this connectionLiveViewExceptionType Enumeration of possible LiveView exceptions.LiveViewPermission.Action LiveViewPermission.Type LiveViewQueryLanguage Enumerates the query languages that are supported by a tableLiveViewQueryType The type of queries that can be specified in QueryConfigLiveViewTableCapability Enumerates certain capabilities that may be supported by a table.OrderDefinition.Direction The direction enum defines the legal directions available, and a reverse helper method.SemanticInterpretation.WellKnownSemantics Table.TableGroup ENUM for table groups.Table.TableStatus -
Exception Summary Exception Description LiveViewConnectionCanceledException Exception throws when the LiveView connection call is cancelled by the clientLiveViewException An exception thrown by the LiveView ServerLiveViewQuerySyntaxException Specific LiveViewException thrown when query syntax error occursNoIdException NoSuchCapabilityException Thrown byLiveViewConnection.getCapability(Class)
when a connected server does not support a particular capability.ValidationErrorsException Used to represent all errors in validating an object.