com.cloudbees.clickstack.util

Class Files2

java.lang.Object

com.cloudbees.clickstack.util.Files2

public class Files2
extends Object

Author:

Cyrille Le Clerc

Constructor Summary

Constructors

Constructor and Description
Files2()

Method Summary

Methods

Modifier and Type	Method and Description
static void	addFileToZip(InputStream sourceFile, Path destZipFile, String destFile, CopyOption... copyOptions)
static void	addFileToZip(Path sourceStream, Path destZipFile, String destFile, CopyOption... copyOptions)
static void	chmodAddReadExecute(Path path)
static void	chmodAddReadWrite(Path path)
static void	chmodReadExecute(Path path) Deprecated. use chmodAddReadExecute(java.nio.file.Path)
static void	chmodReadOnly(Path path)
static void	chmodReadWrite(Path path) Deprecated. use chmodAddReadWrite(java.nio.file.Path)
static void	chmodSetReadOnly(Path path)
static Path	copyArtifactToDirectory(Path sourceDir, String artifactId, Path dest)
static void	copyDirectoryContent(Path srcDir, Path destDir) Copy content for srcDir to destDir
static Path	copyToDirectory(Path srcFile, Path destDir) Copy given srcFile to given destDir.
static void	deleteDirectory(Path dir) Delete given dir and its content (rm -rf).
static void	dump(Path path) For debugging purpose.
static Path	findArtifact(Path srcDir, String artifactId) Find jar file with name beginning with given artifactId in given srcDir.
static Path	findArtifact(Path srcDir, String artifactId, String type) Find a file matching $artifactId*$type in the given srcDir.
static Path	findUniqueChildDirectory(Path srcDir)
static Path	findUniqueDirectoryBeginningWith(Path srcDir, String pattern)
static Path	findUniqueFolderBeginningWith(Path source, String pattern) Deprecated. use findUniqueDirectoryBeginningWith(java.nio.file.Path, String)
static void	untgz(Path tgzFile, Path destDir) TODO recopy file permissions Uncompress the specified tgz file to the specified destination directory.
static void	untgz(String tgzFilename, String destDirname) Uncompress the specified tgz file to the specified destination directory.
static void	unzip(Path zipFile, Path destDir)
static void	unzip(String zipFilename, String destDirname) Unzips the specified zip file to the specified destination directory.
static void	unzipSubDirectoryIfExists(Path zipFile, String zipSubPath, Path destDir) Copy every file of given zipFile beginning with given zipSubPath to destDir
static Path	unzipSubFileIfExists(Path zipFile, String zipSubFilePath, Path destDir) Copy the given zipSubFilePath of the given zipFile into the destDir if this sub file exists.
static Path	unzipSubFileIfExists(Path zipFile, String zipSubFilePath, Path destDir, boolean trimSourcePath) Copy the given zipSubFilePath of the given zipFile into the destDir if this sub file exists.

Methods inherited from class java.lang.Object

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

Constructor Detail

Files2

public Files2()

Method Detail

deleteDirectory

public static void deleteDirectory(@Nonnull
                   Path dir)
                            throws RuntimeIOException

Delete given dir and its content (rm -rf).

Parameters:

dir -

Throws:

RuntimeIOException

chmodReadOnly

public static void chmodReadOnly(@Nonnull
                 Path path)
                          throws RuntimeIOException

Throws:

RuntimeIOException

chmodSetReadOnly

public static void chmodSetReadOnly(@Nonnull
                    Path path)
                             throws RuntimeIOException

Throws:

RuntimeIOException

chmodAddReadExecute

public static void chmodAddReadExecute(@Nonnull
                       Path path)
                                throws RuntimeIOException

Throws:

RuntimeIOException

chmodAddReadWrite

public static void chmodAddReadWrite(@Nonnull
                     Path path)
                              throws RuntimeIOException

Throws:

RuntimeIOException

chmodReadExecute

@Deprecated
public static void chmodReadExecute(Path path)
                             throws RuntimeIOException

Deprecated. use chmodAddReadExecute(java.nio.file.Path)

Throws:

RuntimeIOException

chmodReadWrite

@Deprecated
public static void chmodReadWrite(Path path)
                           throws RuntimeIOException

Deprecated. use chmodAddReadWrite(java.nio.file.Path)

Throws:

RuntimeIOException

unzip

public static void unzip(String zipFilename,
         String destDirname)
                  throws RuntimeIOException

Unzips the specified zip file to the specified destination directory. Replaces any files in the destination, if they already exist.

Parameters:

zipFilename - the name of the zip file to extract

destDirname - the directory to unzip to

Throws:

RuntimeIOException

unzipSubFileIfExists

@Nullable
public static Path unzipSubFileIfExists(@Nonnull
                                 Path zipFile,
                                 @Nonnull
                                 String zipSubFilePath,
                                 @Nonnull
                                 Path destDir)
                                 throws RuntimeIOException

Copy the given zipSubFilePath of the given zipFile into the destDir if this sub file exists.

Parameters:

zipFile - the source zip file (e.g. path/to/app.war

zipSubFilePath - sub file path in the zip file (e.g. /WEB-INF/web.xml

destDir -

Throws:

RuntimeIOException

unzipSubFileIfExists

@Nullable
public static Path unzipSubFileIfExists(@Nonnull
                                 Path zipFile,
                                 @Nonnull
                                 String zipSubFilePath,
                                 @Nonnull
                                 Path destDir,
                                 boolean trimSourcePath)
                                 throws RuntimeIOException

Copy the given zipSubFilePath of the given zipFile into the destDir if this sub file exists.

Parameters:

zipFile - the source zip file (e.g. path/to/app.war

zipSubFilePath - sub file path in the zip file (e.g. /WEB-INF/web.xml

destDir -

trimSourcePath - indicates if the source path should be trimmed creating the dest file (e.g. should WEB-INF/web.xml be copied as dest-dir/WEB-INF/web.xml or as dest-dir/web.xml)

Throws:

RuntimeIOException

unzipSubDirectoryIfExists

public static void unzipSubDirectoryIfExists(@Nonnull
                             Path zipFile,
                             @Nonnull
                             String zipSubPath,
                             @Nonnull
                             Path destDir)
                                      throws RuntimeIOException

Copy every file of given zipFile beginning with given zipSubPath to destDir

Parameters:

zipFile -

zipSubPath - must start with a "/"

destDir -

Throws:

RuntimeIOException

addFileToZip

public static void addFileToZip(@Nonnull
                Path sourceStream,
                @Nonnull
                Path destZipFile,
                @Nonnull
                String destFile,
                CopyOption... copyOptions)

addFileToZip

public static void addFileToZip(@Nonnull
                InputStream sourceFile,
                @Nonnull
                Path destZipFile,
                @Nonnull
                String destFile,
                CopyOption... copyOptions)

unzip

public static void unzip(@Nonnull
         Path zipFile,
         @Nonnull
         Path destDir)
                  throws RuntimeIOException

Throws:

RuntimeIOException

untgz

public static void untgz(String tgzFilename,
         String destDirname)
                  throws RuntimeIOException

Uncompress the specified tgz file to the specified destination directory. Replaces any files in the destination, if they already exist.

Parameters:

tgzFilename - the name of the zip file to extract

destDirname - the directory to unzip to

Throws:

RuntimeIOException

untgz

public static void untgz(@Nonnull
         Path tgzFile,
         @Nonnull
         Path destDir)
                  throws RuntimeIOException

TODO recopy file permissions

Uncompress the specified tgz file to the specified destination directory. Replaces any files in the destination, if they already exist.

Parameters:

tgzFile - the name of the zip file to extract

destDir - the directory to unzip to

Throws:

RuntimeIOException

dump

public static void dump(@Nonnull
        Path path)
                 throws RuntimeIOException

For debugging purpose. Dump the tree view of the dir in stderr

Parameters:

path -

Throws:

IOException

RuntimeIOException

copyDirectoryContent

public static void copyDirectoryContent(@Nonnull
                        Path srcDir,
                        @Nonnull
                        Path destDir)
                                 throws RuntimeIOException

Copy content for srcDir to destDir

Parameters:

srcDir -

destDir -

Throws:

RuntimeIOException

copyToDirectory

@Nonnull
public static Path copyToDirectory(@Nonnull
                           Path srcFile,
                           @Nonnull
                           Path destDir)
                            throws RuntimeIOException

Copy given srcFile to given destDir.

Parameters:

srcFile -

destDir - destination directory, must exist

Returns:

Throws:

RuntimeIOException

copyArtifactToDirectory

@Nonnull
public static Path copyArtifactToDirectory(@Nonnull
                                   Path sourceDir,
                                   @Nonnull
                                   String artifactId,
                                   @Nonnull
                                   Path dest)
                                    throws RuntimeIOException

Throws:

RuntimeIOException

findArtifact

@Nonnull
public static Path findArtifact(@Nonnull
                        Path srcDir,
                        @Nonnull
                        String artifactId)
                         throws RuntimeIOException,
                                IllegalStateException

Find jar file with name beginning with given artifactId in given srcDir.

Parameters:

srcDir -

artifactId -

Returns:

Throws:

RuntimeIOException

IllegalStateException

See Also:

findArtifact(java.nio.file.Path, String, String)

findUniqueFolderBeginningWith

@Deprecated
@Nonnull
public static Path findUniqueFolderBeginningWith(@Nonnull
                                                    Path source,
                                                    @Nullable
                                                    String pattern)
                                          throws RuntimeIOException,
                                                 IllegalStateException

Deprecated. use findUniqueDirectoryBeginningWith(java.nio.file.Path, String)

Throws:

RuntimeIOException

IllegalStateException

findUniqueDirectoryBeginningWith

@Nonnull
public static Path findUniqueDirectoryBeginningWith(@Nonnull
                                            Path srcDir,
                                            @Nonnull
                                            String pattern)
                                             throws RuntimeIOException,
                                                    IllegalStateException

Parameters:

srcDir -

pattern -

Returns:

Throws:

RuntimeIOException

IllegalStateException - More or less than 1 child dir found

findUniqueChildDirectory

@Nonnull
public static Path findUniqueChildDirectory(@Nonnull
                                    Path srcDir)
                                     throws RuntimeIOException,
                                            IllegalStateException

Parameters:

srcDir -

Returns:

Throws:

RuntimeIOException

IllegalStateException - More or less than 1 child dir found

findArtifact

@Nonnull
public static Path findArtifact(@Nonnull
                        Path srcDir,
                        @Nonnull
                        String artifactId,
                        @Nonnull
                        String type)
                         throws RuntimeIOException,
                                IllegalStateException

Find a file matching $artifactId*$type in the given srcDir.

Parameters:

srcDir -

artifactId -

type -

Returns:

Throws:

IllegalStateException - More or less than 1 matching artifact found

RuntimeIOException