Interface IRVDashboardProvider


  • public interface IRVDashboardProvider
    The interface that provides loading and saving of dashboards, it must be implemented and passed to Reveal Engine initialization.
    • Method Detail

      • getDashboard

        InputStream getDashboard​(IRVUserContext userContext,
                                 String dashboardId)
                          throws IOException
        Loads the dashboard with the given dashboardId for the given user. Returns null if such dashboard does not exist.
        Parameters:
        userContext - The user context of the user loading the dashboard, as returned by IRVUserContextProvider.getUserContext().
        dashboardId - The ID of the dashboard to return.
        Returns:
        The stream containing the dashboard definition in "rdash" format.
        Throws:
        IOException
      • saveDashboard

        void saveDashboard​(IRVUserContext userContext,
                           String dashboardId,
                           InputStream dashboardStream)
                    throws IOException
        Saves the dashboard with the given dashboardId for the given user.
        Parameters:
        userContext - The user context of the user saving the dashboard, as returned by IRVUserContextProvider.getUserContext().
        dashboardId - The ID of the dashboard to be saved.
        dashboardStream - The contents of the dashboard, in "rdash" format.
        Throws:
        IOException