Field Detail

• NUM_RETRIES_FOR_COPYING

  public static final int NUM_RETRIES_FOR_COPYING

  Number of attempts when copying a file to a remote server.

  See Also:

  Constant Field Values

Constructor Detail

• ArchiveUtils

  public ArchiveUtils()

Method Detail

• installCommands

  public static java.util.List<java.lang.String> installCommands(java.lang.String fileName)

  Returns the list of commands used to install support for an archive with the given name.

• extractCommands

  public static java.util.List<java.lang.String> extractCommands(java.lang.String fileName,
                                                 java.lang.String sourceDir,
                                                 java.lang.String targetDir,
                                                 boolean extractJar)

  Returns the list of commands used to extract the contents of the archive with the given name.

  Optionally, Java archives of type

  See Also:

  extractCommands(String, String)

• extractCommands

  public static java.util.List<java.lang.String> extractCommands(java.lang.String fileName,
                                                 java.lang.String sourceDir,
                                                 java.lang.String targetDir,
                                                 boolean extractJar,
                                                 boolean keepOriginal)

  as extractCommands(String, String, String, boolean), but also with option to keep the original

• extractCommands

  public static java.util.List<java.lang.String> extractCommands(java.lang.String fileName,
                                                 java.lang.String sourceDir)

  Returns the list of commands used to extract the contents of the archive with the given name.

  The archive will be extracted in its current directory unless it is a Java archive of type .jar, .war or .ear, which will be left as is.

  See Also:

  extractCommands(String, String, String, boolean)

• deploy

  public static void deploy(java.lang.String archiveUrl,
            SshMachineLocation machine,
            java.lang.String destDir)

  Deploys an archive file to a remote machine and extracts the contents.

• deploy

  public static void deploy(java.util.Map<java.lang.String,?> props,
            java.lang.String archiveUrl,
            SshMachineLocation machine,
            java.lang.String destDir)

  Deploys an archive file to a remote machine and extracts the contents.

  Copies the archive file from the given URL to the destination directory and extracts the contents. If the URL is a local directory, the contents are packaged as a Zip archive first.

  See Also:

  deploy(String, SshMachineLocation, String, String), deploy(Map, String, SshMachineLocation, String, String, String)

• deploy

  public static void deploy(java.lang.String archiveUrl,
            SshMachineLocation machine,
            java.lang.String destDir,
            java.lang.String destFile)

  Deploys an archive file to a remote machine and extracts the contents.

  Copies the archive file from the given URL to a file in the destination directory and extracts the contents.

  See Also:

  deploy(String, SshMachineLocation, String), deploy(Map, String, SshMachineLocation, String, String, String)

• deploy

  public static void deploy(java.util.Map<java.lang.String,?> props,
            java.lang.String archiveUrl,
            SshMachineLocation machine,
            java.lang.String destDir,
            java.lang.String destFile)

• deploy

  public static void deploy(java.util.Map<java.lang.String,?> props,
            java.lang.String archiveUrl,
            SshMachineLocation machine,
            java.lang.String tmpDir,
            java.lang.String destDir,
            java.lang.String destFile)

• deploy

  public static boolean deploy(ResourceUtils resolver,
               java.util.Map<java.lang.String,?> props,
               java.lang.String archiveUrl,
               SshMachineLocation machine,
               java.lang.String destDir,
               boolean keepArchiveAfterUnpacking,
               java.lang.String optionalTmpDir,
               java.lang.String optionalDestFile)

  Deploys an archive file to a remote machine and extracts the contents.

  Copies the archive file from the given URL to a file in a temporary directory and extracts the contents in the destination directory. For Java archives of type .jar, .war or .ear the file is simply copied.

  Returns:

  true if the archive is downloaded AND unpacked; false if it is downloaded but not unpacked; throws if there was an error downloading or, for known archive types, unpacking.

  See Also:

  deploy(String, SshMachineLocation, String), deploy(Map, String, SshMachineLocation, String, String, String), #install(SshMachineLocation, String, String, int)

• install

  public static int install(SshMachineLocation machine,
            java.lang.String urlToInstall,
            java.lang.String target)

  Installs a URL onto a remote machine.

  See Also:

  install(Map, SshMachineLocation, String, String, int)

• install

  public static int install(java.util.Map<java.lang.String,?> props,
            SshMachineLocation machine,
            java.lang.String urlToInstall,
            java.lang.String target,
            int numAttempts)

  Installs a URL onto a remote machine.

  See Also:

  install(SshMachineLocation, String, String), SshMachineLocation.installTo(Map, String, String)

• install

  public static int install(ResourceUtils resolver,
            java.util.Map<java.lang.String,?> props,
            SshMachineLocation machine,
            java.lang.String urlToInstall,
            java.lang.String target,
            int numAttempts)

• readFullyString

  public static java.lang.String readFullyString(java.io.File sourceFile)

  Copies the entire contents of a file to a String.

  See Also:

  Files.toString(File, java.nio.charset.Charset)