Package com.infragistics.reveal.sdk.api
Main Reveal API Package containing the interfaces to be implemented in order to control how Reveal BI works.
-
Interface Summary Interface Description ExportCallback ExportStreamCallback IDashboardExporter The interface that expose methods to allow exporting to different formats.IDashboardTheme IDocumentExportOptions IExcelExportOptions IExportOptions IRVAuthenticationProvider The 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.IRVAuthenticationResolver Optional 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.IRVDashboardAuthorizationProvider An 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.IRVDashboardProvider The interface that provides loading and saving of dashboards, it must be implemented and passed to Reveal Engine initialization.IRVDataProvider The interface that must be implemented to return in-memory data for dashboards.IRVDataSourceCredential Base interface representing credentials to connect to a given data sourceIRVDataSourceProvider The interface that must be implemented to replace data sources.IRVInMemoryData The interface representing in-memory data to be returned byIRVDataProvider, please note data is returned as anIterable, so there's no need to have all data loaded in memory.IRVObjectEncoder Allows the encoding of information in DataSource or DataSourceItems, before returning those objects to the client.IRVObjectFilter Allows filtering of 'objects' (DataSource and DataSourceItems) to be returned to the client.IRVRestUrlResolver Allows resolving the URL to use for a REST data source based on the data source definition and parameters entered by the user.IRVUserContext An interface used to identify the user, related to a particular call to the methods ofIRVDashboardProvider,IRVAuthenticationProvider,IRVDataProviderand other providers.IRVUserContextProvider Interface that can be implemented to return current user's context when a request is being processed. -
Class Summary Class Description DocumentExportOptions ExcelExportOptions Contains Excel configuration for exporting a dashboard.ExportOptions PdfExportOptions Contains Pdf configuration for exporting a dashboard.PowerPointExportOptions Contains PowerPoint configuration for exporting a dashboard.RVAmazonWebServicesCredentials The class used to represent authentication for AWS, like required by data sources like Athena or S3.RVBearerTokenDataSourceCredential The class used to represent Bearer (aka 'Token') authentication.RVHeadersDataSourceCredentials The class used to represent authentication using headers (including cookies), supported only by Web Resource and REST API data sources.RVJDBCPropertiesCredentials RVUsernamePasswordDataSourceCredential The 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).VisualizationExport -
Enum Summary Enum Description ExcelVisualizationMode ExportExcelVisualization ExportFormat -
Exception Summary Exception Description RVUnauthorizedException Exception that can be thrown in the implementation ofIRVDashboardProviderto indicate the user doesn't have permission to execute the action (for example reading/writing a dashboard).