Uses of Class
com.streambase.liveview.client.LiveViewException
Package
Description
Provides classes and interfaces fundamental to the LiveView Java API.
Provides classes and interfaces to set Alerts.
Provides classes and interfaces to control user's interaction with LiveView.
Provides classes and interfaces to fetch LiveView server's utility data.
Provides classes and interfaces to add custom table providers for LiveView.
-
Uses of LiveViewException in com.streambase.liveview.client
Modifier and TypeClassDescriptionfinal class
Exception throws when the LiveView connection call is cancelled by the clientfinal class
Specific LiveViewException thrown when query syntax error occursModifier and TypeMethodDescriptionstatic LiveViewException
Wraps any throwable into a LiveViewException of type LiveViewExceptionType.UNEXPECTEDDynamicTableState.getException()
PublisherExceptionEvent.getException()
Get the correspondingLiveViewException
.QueryExceptionEvent.getException()
Get the exceptionModifier and TypeMethodDescriptionvoid
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.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
(TableConfig tableConfig) Create a table using a TableConfigvoid
TableAdminManager.createTable
(String tableName, String description, Schema schema, String... primaryKeyFields) Convenience form of the previous method, used if there is only a primary key.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, String schema, String... primaryKeyFields) Convenience form of the previous method, used if there is only a primary key.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
LiveViewConnection.deleteRows
(QueryConfig config) Delete rows based on the suppliedQueryConfig
.LiveViewConnection.describeQuery
(QueryConfig config) Get information about a query, such as its result schema, without actually running itvoid
TableAdminManager.dropTables
(String... tables) This will drop the tables in the list.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.static ConnectionConfig
ConnectionConfig.fromTcdsAuthUri
(String uri, LiveViewAuth lvauth) Creates a connection config from a TCDS URI and authentication (optional).LiveViewConnection.getAlertManager()
<T extends LiveViewServerCapability>
TLiveViewConnection.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.LiveViewConnection.getClientController()
A ClientController is used to perform actions to control clients.static LiveViewConnection
LiveViewConnectionFactory.getConnection
(ConnectionConfig config) Retrieves aLiveViewConnection
based on theConnectionConfig
static LiveViewMultiConnection
LiveViewConnectionFactory.getConnection
(MultiConnectionConfig config, boolean waitForConnection) Retrieves aLiveViewMultiConnection
based on the givenMultiConnectionConfig
.static LiveViewConnection
LiveViewConnectionFactory.getConnection
(String uri) Retrieves aLiveViewConnection
based on a valid URI.DeleteQueryListener.getFields()
Retrieves the fields describing the tuples that will be returned.SnapshotQueryListener.getFields()
Retrieves the fields describing the tuples that will be returned.SnapshotResult.getFields()
Retrieves the fields describing the tuples that will be returned.TablePublisher.getPublisherListener()
Gets thePublisherListener
associated with thisTablePublisher
LiveViewConnection.getSendTupleInfo
(StreamBaseURI sbUri, String targetInputStreamName, String responseOutputStreamName) Gets the schemas associated with streams, for the purposes of using SendTupleAction.LiveViewConnection.getServerUtilityDataProvider()
TablePublisher.getStatus()
Gets the latestPublisherStatus
for the currentTablePublisher
Retrieve a specific table from the serverLiveViewConnection.getTableAdminManager()
Get the TableAdminManager, which provides an API to administer tables in the server.Table.getTablePublisher
(String publisherName, int bufferSize, long flushInterval, TimeUnit flushIntervalUnit, PublisherListener pubListener, PubListenerConfig pubListenerConfig) Retrieve aTablePublisher
publisher instance allowing the client to publish data to the table.Table.getTablePublisher
(String publisherName, PublisherListener pubListener, PubListenerConfig pubListenerConfig) Retrieve aTablePublisher
instance allowing a client to publish data to this table with the default buffer sizeTablePublisher.PUBLISH_BUFFER_SIZE_DEFAULT
and flush intervalTablePublisher.PUBLISH_INTERVAL_DEFAULT
.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.LiveViewConnection.listTables()
Lists the available tables for queryingLiveViewConnection.listTables
(boolean includeSystemTables) List the available tables for queryingDeleteQueryListener.next()
Retrieves the next tuple in the result.SnapshotQueryListener.next()
Retrieves the next tuple in the result.SnapshotResult.next()
Retrieves the next tuple in the result.void
Publish a tuple with a sequenceNumber.void
Publish a tuple with a sequenceNumber.void
Publish a tuple without regard for recovering since no sequence number is specified.void
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
TableAdminManager.removeTableProvider
(String id) Disconnect a previously-connected TableProviderLiveViewConnection.sendTupleAction
(StreamBaseURI sbUri, String targetInputStreamName, Tuple tuple, String responseOutputStreamName, Schema expectedResponseSchema, long timeout, TimeUnit unit) Sends a tuple to an existing StreamBase application.ConnectionConfig.setPassword
(String password) Deprecated.Use get/setAuthentication instead.Set the uri to connect with.ConnectionConfig.setUsername
(String username) Deprecated.Use get/setAuthentication instead.void
TableAdminManager.startTables
(String... tables) This will start all the tables in the list AND any applications or elements upon which they depend.ModifierConstructorDescriptionPublisherExceptionEvent
(Object source, LiveViewException exception) QueryExceptionEvent
(Object source, LiveViewException exception) ModifierConstructorDescriptionAbstractTable
(Schema schema, String keyFieldNamesCSV) AbstractTable
(Schema schema, List<String> keyFieldNames) MultiConnectionConfig
(List<String> uris, String username, String password, MultiConnectionListener listener) Use this constructor if the servers all use the same username and password (which can be null) -
Uses of LiveViewException in com.streambase.liveview.client.alert
Modifier and TypeMethodDescriptionboolean
IExecJavaAction.action
(com.streambase.liveview.internal.protocol.jaxb.AlertRule actionRule, com.streambase.liveview.internal.protocol.jaxb.AlertRule.Actions.Action action, TupleAddedEvent event) Deprecated.Use ExecJavaActionClassvoid
AlertManager.deleteAlertRule
(String guid) Deletes theAlertRule
from the server that matches the given GUID.AlertManager.getAlertRule
(String guid) Gets the alert rule specified by the GUID.AlertManager.getAlertRules
(String user) Gets all available alert rules from the server for the given user.AlertManager.getKnownSettableAlertGroups()
Gets all the alert groups that the server knows about that you have permission to setAlertManager.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. -
Uses of LiveViewException in com.streambase.liveview.client.clientcontrol
Modifier and TypeMethodDescriptionvoid
ClientController.killPublisher
(String sessionID, String publisherID) Kills the specific publisher based on ID from the server.ClientController.killPublishersWithPredicate
(String predicate) Kills publishers referring to the rows in the LVSessionPublishers Table that satisfy the predicate against LVSessionPublishers Table.ClientController.killQueriesWithPredicate
(String predicate) Kills queries referring to the rows in the LVSessionQueries Table that satisfy the predicate against LVSessionQueries Table.void
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.ClientController.killSessionsWithPredicate
(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 -
Uses of LiveViewException in com.streambase.liveview.client.serverdatautility
Modifier and TypeMethodDescriptionvoid
ServerUtilityDataProvider.exportMetadata
(File file, String... resources) utility to export LiveView metadata.void
ServerUtilityDataProvider.exportMetadata
(OutputStream outputStream, String... resources) Utility to export LiveView metadata.ServerUtilityDataProvider.DATA_POLICY.getPolicyFromValue
(String value) ServerUtilityDataProvider.getStreambaseStreams
(String sbUri) Utility to get all the input streams and output streams for a given Streambase URI.ServerUtilityDataProvider.importMetadata
(File file, ServerUtilityDataProvider.DATA_POLICY dataPolicy, String... resources) Utility to import LiveView metadata.ServerUtilityDataProvider.importMetadata
(InputStream inputstream, ServerUtilityDataProvider.DATA_POLICY dataPolicy, String... resources) Utility to import LiveView metadata. -
Uses of LiveViewException in com.streambase.liveview.server.table.plugin
Modifier and TypeMethodDescription(package private) void
TableProviderManager.killQueriesAndPublishers
(String tableName, LiveViewException exForQueries, LiveViewException exForPublishers) Kills all queries and publishers that are attached to it.Modifier and TypeMethodDescriptionvoid
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 TablesTableProviderManager.compileLVConfs
(List<File> tableFiles, boolean buildYaml) 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.(package private) void
TableProviderManager.killQueriesAndPublishers
(String tableName, LiveViewException exForQueries, LiveViewException exForPublishers) Kills all queries and publishers that are attached to it.TableProviderControl.locateFile
(String filename, boolean required) This will attempt to locate a file within the project.TableProviderControlImpl.locateFile
(String filename, boolean required) void
TableProviderManager.registerDependentTables
(com.streambase.liveview.config.model.lvconf.TableType tableInfo, com.streambase.liveview.server.table.CatalogedTable baseCatalogedTable, boolean useDynamicStates) void
TableProviderManager.registerNewDynamicTable
(String name, com.streambase.liveview.config.model.lvconf.LiveviewConfiguration.DataTable dataTable, Table.TableStatus initialStatus, String statusMessage) void
TableProviderManager.removeTableProvider
(String id) Disconnect a previously-connected TableProvider.void
TableProviderManager.saveLVConf
(String name, com.streambase.liveview.config.model.lvconf.LiveviewConfiguration conf, boolean saveInProject) 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
TableProviderManager.startTables
(List<String> tables) void
TableProviderManager.validateDependentTables
(com.streambase.liveview.config.model.lvconf.LiveviewConfiguration conf)