Package com.suse.salt.netapi.calls.modules

Class Pkg

  • public class Pkg
extends java.lang.Object
    salt.modules.pkg

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Pkg.Info
      Information about a package as returned by pkg.info_installed and pkg.info_available
      static class  Pkg.PackageDict
      Package dictionary as returned by "pkg.file_dict".
      static class  Pkg.PackageInfo
      Information about a package as returned by "pkg.search".

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private Pkg()  

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static LocalCall<Pkg.PackageDict> fileDict​(java.lang.String... packages)  
      static LocalCall<java.util.Map<java.lang.String,​Pkg.Info>> infoAvailable​(java.lang.String... packages)  
      static LocalCall<java.util.Map<java.lang.String,​Pkg.Info>> infoInstalled​(java.util.List<java.lang.String> attributes, boolean reportErrors, java.lang.String... packages)
      Call 'pkg.info_installed' API.
      static LocalCall<java.util.Map<java.lang.String,​Xor<Pkg.Info,​java.util.List<Pkg.Info>>>> infoInstalledAllVersions​(java.util.List<java.lang.String> attributes, boolean reportErrors, java.lang.String... packages)
      Call 'pkg.info_installed' API.
      static LocalCall<java.util.Map<java.lang.String,​java.lang.Object>> install​(boolean refresh, java.util.List<java.lang.String> pkgs)
      Call 'pkg.install' API.
      static LocalCall<java.util.Map<java.lang.String,​Change<Xor<java.lang.String,​java.util.List<Pkg.Info>>>>> install​(boolean refresh, java.util.List<java.lang.String> pkgs, java.util.List<java.lang.String> attributes)
      Call 'pkg.install' API.
      static LocalCall<java.util.Map<java.lang.String,​java.lang.Object>> install​(boolean refresh, java.util.Map<java.lang.String,​java.lang.String> pkgs)  
      static LocalCall<java.util.Map<java.lang.String,​Change<Xor<java.lang.String,​java.util.List<Pkg.Info>>>>> install​(boolean refresh, java.util.Map<java.lang.String,​java.lang.String> pkgs, java.util.List<java.lang.String> attributes)
      Call 'pkg.install' API.
      static LocalCall<java.lang.String> latestVersion​(java.lang.String packageName)  
      static LocalCall<java.util.Map<java.lang.String,​java.lang.String>> latestVersion​(java.lang.String firstPackageName, java.lang.String secondPackageName, java.lang.String... packages)  
      static LocalCall<java.util.Optional<java.util.Map<java.lang.String,​PatternInfo>>> listPatterns​(boolean refresh)
      Call 'pkg.list_patterns' via Salt API.
      static LocalCall<java.util.Map<java.lang.String,​java.util.List<java.lang.String>>> listPkgs()  
      static LocalCall<java.util.Map<java.lang.String,​java.util.List<Xor<java.lang.String,​Pkg.Info>>>> listPkgs​(java.util.List<java.lang.String> attributes)
      Call 'pkg.list_pkgs'
      private static java.util.List<java.util.Map<java.lang.String,​java.lang.String>> preparePkgs​(java.util.Map<java.lang.String,​java.lang.String> pkgs)
      From a given map (package name -> version), create a list of maps with just one element each.
      static LocalCall<java.util.Map<java.lang.String,​java.lang.Object>> remove​(java.util.Map<java.lang.String,​java.lang.String> pkgs)  
      static LocalCall<java.util.Map<java.lang.String,​Pkg.PackageInfo>> search​(java.lang.String criteria)  
      static LocalCall<java.lang.Boolean> upgradeAvailable​(java.lang.String packageName)  

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • Pkg

        private Pkg()

    • Method Detail

      • search

        public static LocalCall<java.util.Map<java.lang.String,​Pkg.PackageInfo>> search​(java.lang.String criteria)

      • listPkgs

        public static LocalCall<java.util.Map<java.lang.String,​java.util.List<java.lang.String>>> listPkgs()

      • listPkgs

        public static LocalCall<java.util.Map<java.lang.String,​java.util.List<Xor<java.lang.String,​Pkg.Info>>>> listPkgs​(java.util.List<java.lang.String> attributes)
        Call 'pkg.list_pkgs'
        Parameters:
        attributes - list of attributes that should be included in the result
        Returns:
        the call. For each package, the map can contain a String (only the version) or an Info object containing specified attributes depending on Salt version and minion support

      • infoInstalled

        public static LocalCall<java.util.Map<java.lang.String,​Pkg.Info>> infoInstalled​(java.util.List<java.lang.String> attributes,
                                                                                      boolean reportErrors,
                                                                                      java.lang.String... packages)
        Call 'pkg.info_installed' API.
        Parameters:
        attributes - list of attributes that should be included in the result
        reportErrors - if true will return an error message instead of corrupted text
        packages - optional give package names, otherwise return info about all packages
        Returns:
        the call

      • infoInstalledAllVersions

        public static LocalCall<java.util.Map<java.lang.String,​Xor<Pkg.Info,​java.util.List<Pkg.Info>>>> infoInstalledAllVersions​(java.util.List<java.lang.String> attributes,
                                                                                                                                     boolean reportErrors,
                                                                                                                                     java.lang.String... packages)
        Call 'pkg.info_installed' API.
        Parameters:
        attributes - list of attributes that should be included in the result
        reportErrors - if true will return an error message instead of corrupted text
        packages - optional give package names, otherwise return info about all packages
        Returns:
        the call

      • infoAvailable

        public static LocalCall<java.util.Map<java.lang.String,​Pkg.Info>> infoAvailable​(java.lang.String... packages)

      • install

        public static LocalCall<java.util.Map<java.lang.String,​java.lang.Object>> install​(boolean refresh,
                                                                                        java.util.List<java.lang.String> pkgs)
        Call 'pkg.install' API.
        Parameters:
        refresh - refresh repos before installation
        pkgs - list of packages
        Returns:
        the call

      • install

        public static LocalCall<java.util.Map<java.lang.String,​Change<Xor<java.lang.String,​java.util.List<Pkg.Info>>>>> install​(boolean refresh,
                                                                                                                                    java.util.List<java.lang.String> pkgs,
                                                                                                                                    java.util.List<java.lang.String> attributes)
        Call 'pkg.install' API.
        Parameters:
        refresh - refresh repos before installation
        pkgs - list of packages
        attributes - list of attributes that should be included in the result
        Returns:
        the call. For each package, a change of old and new value. Those can contain an empty String, or a package version String, or an Info object containing specified attributes. They exact type depends on the Salt version depending on Salt version used and minion support

      • install

        public static LocalCall<java.util.Map<java.lang.String,​java.lang.Object>> install​(boolean refresh,
                                                                                        java.util.Map<java.lang.String,​java.lang.String> pkgs)
        Parameters:
        refresh - set true to perform a refresh before the installation
        pkgs - map of packages (name to version) to be installed
        Returns:
        the LocalCall object

      • install

        public static LocalCall<java.util.Map<java.lang.String,​Change<Xor<java.lang.String,​java.util.List<Pkg.Info>>>>> install​(boolean refresh,
                                                                                                                                    java.util.Map<java.lang.String,​java.lang.String> pkgs,
                                                                                                                                    java.util.List<java.lang.String> attributes)
        Call 'pkg.install' API.
        Parameters:
        refresh - refresh repos before installation
        pkgs - map of packages (name to version) to be installed
        attributes - list of attributes that should be included in the result
        Returns:
        the call. For each package, a change of old and new value. Those can contain an empty String, or a package version String, or an Info object containing specified attributes. They exact type depends on the Salt version depending on Salt version used and minion support

      • remove

        public static LocalCall<java.util.Map<java.lang.String,​java.lang.Object>> remove​(java.util.Map<java.lang.String,​java.lang.String> pkgs)
        Parameters:
        pkgs - map of packages (name to version) to be removed
        Returns:
        the LocalCall object

      • upgradeAvailable

        public static LocalCall<java.lang.Boolean> upgradeAvailable​(java.lang.String packageName)

      • latestVersion

        public static LocalCall<java.lang.String> latestVersion​(java.lang.String packageName)

      • latestVersion

        public static LocalCall<java.util.Map<java.lang.String,​java.lang.String>> latestVersion​(java.lang.String firstPackageName,
                                                                                              java.lang.String secondPackageName,
                                                                                              java.lang.String... packages)

      • listPatterns

        public static LocalCall<java.util.Optional<java.util.Map<java.lang.String,​PatternInfo>>> listPatterns​(boolean refresh)
        Call 'pkg.list_patterns' via Salt API.
        Parameters:
        refresh - refresh repos
        Returns:
        the call. Only returns a populated map for SUSE-based distros using zypper

      • preparePkgs

        private static java.util.List<java.util.Map<java.lang.String,​java.lang.String>> preparePkgs​(java.util.Map<java.lang.String,​java.lang.String> pkgs)
        From a given map (package name -> version), create a list of maps with just one element each. This is how Salt requires us to send the 'pkgs' argument when multiple packages should be installed or removed.
        Parameters:
        pkgs - map with packages (name -> version)
        Returns:
        list of maps with one element each