Package org.xwiki.livedata

Interface LiveDataSourceManager

  • @Role
public interface LiveDataSourceManager
    The interface used to access the available live data sources.
    Since:
    12.10
    Version:
    $Id: 09b8341309722ef896668853b09187b7dea391c8 $

    • Method Detail

      • get

        Optional<LiveDataSource> get​(LiveDataQuery.Source source,
                             String namespace)
        Looks for a live data source in the specified namespace.
        Parameters:
        source - indicates the live data source to return
        namespace - the namespace where to look for the specified live data source
        Returns:
        the specified live data source, if found

      • get

        default Optional<LiveDataSource> get​(LiveDataQuery.Source source)
        Looks for a live data source in the current namespace.
        Parameters:
        source - indicates the live data source to return
        Returns:
        the specified live data source, if found

      • get

        default Optional<LiveDataSource> get​(String sourceHint,
                                     String namespace)
        Looks for a live data source in the specified namespace.
        Parameters:
        sourceHint - indicates the live data source to return
        namespace - the namespace where to look for the specified live data source
        Returns:
        the specified live data source, if found

      • get

        default Optional<LiveDataSource> get​(String sourceHint)
        Looks for a live data source in the current namespace.
        Parameters:
        sourceHint - indicates the live data source to return
        Returns:
        the specified live data source, if found

      • getAvailableSources

        Optional<Collection<String>> getAvailableSources​(String namespace)
        Parameters:
        namespace - the namespace where to look for live data sources
        Returns:
        the list of live data sources available in the specified namespace, if the namespace exists

      • getAvailableSources

        default Collection<String> getAvailableSources()
        Returns:
        the list of live data sources available in the current namespace