Package org.xwiki.platform.flavor

Interface FlavorManager

@Role public interface FlavorManager
Find the flavors into the repositories, applying filters according to the configuration.
Since:
7.1M2
Version:
$Id: 5d827213af6869030637a880526a31db1e295fed $

  • Method Summary

    Modifier and Type
    Method
    Description
    default org.xwiki.extension.InstalledExtension
    getFlavorExtension(org.xwiki.component.namespace.Namespace namespace)
    Get the flavor installed on a given namespace.
    org.xwiki.extension.ExtensionId
    getFlavorOfWiki(String wikiId)
    Get the flavor installed on a given wiki.
    org.xwiki.extension.repository.result.IterableResult<org.xwiki.extension.Extension>
    getFlavors(FlavorQuery query)
    Deprecated.
    since 8.0RC1, use searchFlavors(FlavorQuery) instead
    default Collection<org.xwiki.extension.ExtensionId>
    getKnownFlavors()
    Get the flavors know to be compatible with the distribution.
    default Collection<String>
    getKnownInvalidFlavors()
    Get the flavors identifiers know to be incompatible with the distribution.
    org.xwiki.extension.repository.result.IterableResult<org.xwiki.extension.Extension>
    searchFlavors(FlavorQuery query)
    Get all flavors matching a query.

  • Method Details

    • getFlavors

      @Deprecated org.xwiki.extension.repository.result.IterableResult<org.xwiki.extension.Extension> getFlavors(FlavorQuery query) throws org.xwiki.extension.repository.search.SearchException
      Deprecated.
      since 8.0RC1, use searchFlavors(FlavorQuery) instead
      Get all flavors matching a query.
      Parameters:
      query - query to execute
      Returns:
      flavors matching the query
      Throws:
      org.xwiki.extension.repository.search.SearchException - error when trying to search provided query

    • searchFlavors

      org.xwiki.extension.repository.result.IterableResult<org.xwiki.extension.Extension> searchFlavors(FlavorQuery query) throws org.xwiki.extension.repository.search.SearchException
      Get all flavors matching a query.
      Parameters:
      query - query to execute
      Returns:
      flavors matching the query
      Throws:
      org.xwiki.extension.repository.search.SearchException - error when trying to search provided query
      Since:
      8.0RC1

    • getFlavorOfWiki

      org.xwiki.extension.ExtensionId getFlavorOfWiki(String wikiId)
      Get the flavor installed on a given wiki.
      Parameters:
      wikiId - id of the wiki
      Returns:
      the id of the flavor installed on the given wiki or null if there is no flavor installed

    • getFlavorExtension

      default org.xwiki.extension.InstalledExtension getFlavorExtension(org.xwiki.component.namespace.Namespace namespace)
      Get the flavor installed on a given namespace.
      Parameters:
      namespace - the namespace where to search for the flavor
      Returns:
      the found flavor
      Since:
      9.5

    • getKnownFlavors

      default Collection<org.xwiki.extension.ExtensionId> getKnownFlavors()
      Get the flavors know to be compatible with the distribution.

      Each ExtensionId always contains the flavor id but version might be null.

      Returns:
      the already known flavors
      Since:
      8.1M1

    • getKnownInvalidFlavors

      default Collection<String> getKnownInvalidFlavors()
      Get the flavors identifiers know to be incompatible with the distribution.
      Returns:
      the already known flavors
      Since:
      9.5RC1