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
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 source
IRVDataSourceProvider	The interface that must be implemented to replace data sources.
IRVInMemoryData	The 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.
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 of IRVDashboardProvider, IRVAuthenticationProvider, IRVDataProvider and other providers.
IRVUserContextProvider	Interface that can be implemented to return current user's context when a request is being processed.

Class Summary

Class	Description
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).

Exception Summary

Exception	Description
RVUnauthorizedException	Exception that can be thrown in the implementation of IRVDashboardProvider to indicate the user doesn't have permission to execute the action (for example reading/writing a dashboard).