Package org.apache.karaf.kar

Interface KarService

  • All Known Implementing Classes:
    KarServiceImpl
    public interface KarService
    The service managing KAR.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void create​(String repoName, List<String> features, PrintStream console)
      Create a kar from the given feature and repo names.
      void install​(URI karUri)
      Install KAR from a given URI Resources will be copied to the karaf base dir Repository contents will be copied to a subdir in the karaf data directory
      void install​(URI karUri, boolean noAutoStartBundles)
      Install KAR from a given URI
      void install​(URI karUri, boolean noAutoStartBundles, boolean noAutoRefreshBundles)
      Install KAR from a given URI
      void install​(URI karUri, File repoDir, File resourceDir)
      Install a kar with manually given repository and resource directories.
      void install​(URI karUri, File repoDir, File resourceDir, boolean noAutoStartBundles)
      Install a kar with manually given repository and resource directories.
      void install​(URI karUri, File repoDir, File resourceDir, boolean noAutoStartBundles, boolean noAutoRefreshBundles)
      Install a kar with manually given repository and resource directories.
      List<String> list()
      List the KAR stored in the data folder.
      void uninstall​(String name)
      Uninstall the given KAR
      void uninstall​(String name, boolean noAutoRefreshBundles)
      Uninstall the given KAR

    • Method Detail

      • install

        void install​(URI karUri)
      throws Exception
        Install KAR from a given URI Resources will be copied to the karaf base dir Repository contents will be copied to a subdir in the karaf data directory
        Parameters:
        karUri - Uri of the kar to be installed
        Throws:
        Exception - in case of installation failure.

      • install

        void install​(URI karUri,
             boolean noAutoStartBundles)
      throws Exception
        Install KAR from a given URI
        Parameters:
        karUri - URI of the kar to install
        noAutoStartBundles - true to not start automatically the bundles, false else
        Throws:
        Exception - in case of installation failure

      • install

        void install​(URI karUri,
             boolean noAutoStartBundles,
             boolean noAutoRefreshBundles)
      throws Exception
        Install KAR from a given URI
        Parameters:
        karUri - URI of the kar to install
        noAutoStartBundles - true to not start automatically the bundles, false else
        noAutoRefreshBundles - true to not refresh automatically the bundles, false else
        Throws:
        Exception - in case of installation failure

      • install

        void install​(URI karUri,
             File repoDir,
             File resourceDir)
      throws Exception
        Install a kar with manually given repository and resource directories.
        Parameters:
        karUri - Uri of the kar to be installed
        repoDir - destination for the repository contents of the kar
        resourceDir - destination for the resource contents of the kar
        Throws:
        Exception - in case of installation failure

      • install

        void install​(URI karUri,
             File repoDir,
             File resourceDir,
             boolean noAutoStartBundles)
      throws Exception
        Install a kar with manually given repository and resource directories.
        Parameters:
        karUri - Uri of the kar to be installed.
        repoDir - destination for the repository contents of the kar
        resourceDir - destination for the resource contents of the kar
        noAutoStartBundles - true to not start automatically the bundles, false else
        Throws:
        Exception - in case of installation failure

      • install

        void install​(URI karUri,
             File repoDir,
             File resourceDir,
             boolean noAutoStartBundles,
             boolean noAutoRefreshBundles)
      throws Exception
        Install a kar with manually given repository and resource directories.
        Parameters:
        karUri - Uri of the kar to be installed.
        repoDir - destination for the repository contents of the kar
        resourceDir - destination for the resource contents of the kar
        noAutoStartBundles - true to not start automatically the bundles, false else
        noAutoRefreshBundles - true to not refresh automatically the bundles, false else
        Throws:
        Exception - in case of installation failure

      • uninstall

        void uninstall​(String name)
        throws Exception
        Uninstall the given KAR
        Parameters:
        name - the name of the KAR
        Throws:
        Exception - in case of failure

      • uninstall

        void uninstall​(String name,
               boolean noAutoRefreshBundles)
        throws Exception
        Uninstall the given KAR
        Parameters:
        name - the name of the KAR
        noAutoRefreshBundles - true to not automatically refresh bundles, false else.
        Throws:
        Exception - in case of failure

      • list

        List<String> list()
           throws Exception
        List the KAR stored in the data folder.
        Returns:
        the list of KAR stored.
        Throws:
        Exception - in case of listing failure.

      • create

        void create​(String repoName,
            List<String> features,
            PrintStream console)
        Create a kar from the given feature and repo names. Each named feature including all transitive deps will be added. For each named repo all features in the repo and their transitive deps will be added.
        Parameters:
        repoName - the feature repository to use to create the kar.
        features - the list of features to include in the created kar.
        console - the console stream where to print details.