Main Reveal API Package containing the interfaces to be implemented in order to control how Reveal BI works.
Interface Summary Interface Description IRVAuthenticationProviderThe interface that must be implemented and passed to Reveal Engine initialization, that returns credentials to be used when getting data from a given data source. IRVAuthenticationResolverOptional interface that can be implemented and will be used only when adding data sources is enabled, when verifying connections for existing credentials this interface will be used to retrieve the account given the id. IRVDashboardAuthorizationProviderAn optional interface to provide authorization control before actually asking the dashboard provider to read/save a dashboard, it must be implemented and passed to Reveal Engine initialization. IRVDashboardProviderThe interface that provides loading and saving of dashboards, it must be implemented and passed to Reveal Engine initialization. IRVDataProviderThe interface that must be implemented to return in-memory data for dashboards. IRVDataSourceCredentialBase interface representing credentials to connect to a given data source IRVDataSourceProviderThe interface that must be implemented to replace data sources. IRVInMemoryDataThe interface representing in-memory data to be returned by
IRVDataProvider, please note data is returned as an
Iterable, so there's no need to have all data loaded in memory.
IRVObjectEncoderAllows the encoding of information in DataSource or DataSourceItems, before returning those objects to the client. IRVObjectFilterAllows filtering of 'objects' (DataSource and DataSourceItems) to be returned to the client. IRVRestUrlResolverAllows resolving the URL to use for a REST data source based on the data source definition and parameters entered by the user. IRVUserContextAn interface used to identify the user, related to a particular call to the methods of
IRVDataProviderand other providers.
IRVUserContextProviderInterface that can be implemented to return current user's context when a request is being processed.
Class Summary Class Description RVAmazonWebServicesCredentialsThe class used to represent authentication for AWS, like required by data sources like Athena or S3. RVBearerTokenDataSourceCredentialThe class used to represent Bearer (aka 'Token') authentication. RVHeadersDataSourceCredentialsThe class used to represent authentication using headers (including cookies), supported only by Web Resource and REST API data sources. RVJDBCPropertiesCredentials RVUsernamePasswordDataSourceCredentialThe class used to represent domain/user/password credentials, required to connect to all data bases (MS SQL, MySQL, etc) and some other data sources (REST API for example).
Exception Summary Exception Description RVUnauthorizedExceptionException that can be thrown in the implementation of
IRVDashboardProviderto indicate the user doesn't have permission to execute the action (for example reading/writing a dashboard).