## Uses of Class
com.streambase.liveview.client.LiveViewException

- Packages that use LiveViewException
  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.

- - ### Uses of LiveViewException in com.streambase.liveview.client

    Subclasses of LiveViewException in com.streambase.liveview.client
    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

    Methods in com.streambase.liveview.client that return LiveViewException
    Modifier and Type | Method and Description
    --- | ---
    `static LiveViewException` | LiveViewExceptionType.`error(Throwable cause)` Wraps any throwable into a LiveViewException of type LiveViewExceptionType.UNEXPECTED
    `LiveViewException` | DynamicTableState.`getException()`
    `LiveViewException` | QueryExceptionEvent.`getException()` Get the exception

    Methods in com.streambase.liveview.client with parameters of type LiveViewException
    Modifier and Type | Method and Description
    --- | ---
    `DynamicTableState` | DynamicTableState.`setException(LiveViewException exception)`

    Methods in com.streambase.liveview.client that throw LiveViewException
    Modifier and Type | Method and Description
    --- | ---
    `void` | TableAdminManager.`addTableProvider(String id, ExternalConnectionTypeType externalConnectionType, String javaClassName, ExternalServerConnectionType.Parameters parameters, 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.
    `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.
    `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(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> T` | 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.
    `ServerUtilityDataProvider` | LiveViewConnection.`getServerUtilityDataProvider()`
    `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` | 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.
    `ConnectionConfig` | ConnectionConfig.`setPassword(String password)` Set the password to connect with
    `ConnectionConfig` | ConnectionConfig.`setUri(String uri)` Set the uri to connect with.
    `ConnectionConfig` | ConnectionConfig.`setUsername(String username)` Set the username to connect with
    `void` | TableAdminManager.`startTables(String... tables)` This will start all the tables in the list AND any applications or elements upon which they depend.

    Constructors in com.streambase.liveview.client with parameters of type LiveViewException
    Constructor and Description
    `QueryExceptionEvent(Object source, LiveViewException exception)`

    Constructors in com.streambase.liveview.client that throw LiveViewException
    Constructor and Description
    `AbstractTable(Schema schema, List<String> keyFieldNames)`
    `AbstractTable(Schema schema, String keyFieldNamesCSV)`
    `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

    Methods in com.streambase.liveview.client.alert that throw LiveViewException
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | IExecJavaAction.`action(AlertRule actionRule, AlertRule.Actions.Action action, TupleAddedEvent event)` Deprecated. Use ExecJavaActionClass
    `void` | AlertManager.`deleteAlertRule(Long id)` Deprecated. : Use `AlertManager.deleteAlertRule(String)` instead.
    `void` | AlertManager.`deleteAlertRule(String guid)` Deletes the `AlertRule` from the server that matches the given GUID.
    `AlertRule` | AlertManager.`getAlertRule(long alertID)` Deprecated. : Use `AlertManager.getAlertRule(String)` instead.
    `AlertRule` | AlertManager.`getAlertRule(String guid)` Gets the alert rule specified by the GUID.
    `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.

  - ### Uses of LiveViewException in com.streambase.liveview.client.clientcontrol

    Methods in com.streambase.liveview.client.clientcontrol that throw LiveViewException
    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.
    `void` | ClientController.`stopNewSessions(boolean stopNewSession)` Stops accepting new sessions

  - ### Uses of LiveViewException in com.streambase.liveview.client.serverdatautility

    Methods in com.streambase.liveview.client.serverdatautility that throw LiveViewException
    Modifier and Type | Method and Description
    --- | ---
    `void` | ServerUtilityDataProvider.`exportMetadata(File file, String... resources)` utility to export LiveView metadata.
    `void` | ServerUtilityDataProvider.`exportMetadata(OutputStream outputStream, String... resources)` Utility to export LiveView metadata.
    `static ServerUtilityDataProvider.DATA_POLICY` | ServerUtilityDataProvider.DATA_POLICY.`getPolicyFromValue(String value)`
    `StreambaseStreams` | ServerUtilityDataProvider.`getStreambaseStreams(String sbUri)` Utility to get all the input streams and output streams for a given Streambase URI.
    `Map<String,DataStatus>` | ServerUtilityDataProvider.`importMetadata(File file, ServerUtilityDataProvider.DATA_POLICY dataPolicy, String... resources)` Utility to import LiveView metadata
    `Map<String,DataStatus>` | 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

    Methods in com.streambase.liveview.server.table.plugin with parameters of type LiveViewException
    Modifier and Type | Method and Description
    --- | ---
    `(package private) void` | TableProviderManager.`killQueriesAndPublishers(String tableName, LiveViewException exceptionToBeDeliveredToQueriesBeforeClosing)` Kills all queries and publishers that are attached to it.

    Methods in com.streambase.liveview.server.table.plugin that throw LiveViewException
    Modifier and Type | Method and Description
    --- | ---
    `void` | TestTableProvider.UnsupportedTable.`addListener(EventListener listener, LiveViewQueryType type, QueryModel query)`
    `void` | TableProviderManager.`addTableProvider(ExternalServerConnectionType externalServer, int retryCount)` Connect to a TableProvider, which then allows for remote connections as if they were LiveView Tables
    `Map<String,com.streambase.liveview.config.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)`
    `(package private) void` | TableProviderManager.`killQueriesAndPublishers(String tableName, LiveViewException exceptionToBeDeliveredToQueriesBeforeClosing)` Kills all queries and publishers that are attached to it.
    `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)`
    `void` | TableProviderManager.`registerDependentTables(TableType tableInfo, CatalogedTable baseCatalogedTable, boolean useDynamicStates)`
    `void` | TableProviderManager.`registerNewDynamicTable(String name, LiveviewConfiguration.DataTable dataTable, Table.TableStatus initialStatus, String statusMessage)`
    `void` | TestTableProvider.UnsupportedTable.`removeListener(EventListener listener)`
    `void` | TableProviderManager.`removeTableProvider(String id)` Disconnect a previously-connected TableProvider.
    `void` | TableProviderManager.`saveLVConf(String name, 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` | TestTableProvider.`start()`
    `void` | TableProviderManager.`startTables(List<String> tables)`
    `void` | TableProviderManager.`validateDependentTables(LiveviewConfiguration conf)`

Copyright © 2015–2018 Cloud Software Group, Inc.. All rights reserved.