com.spotify.docker.client

Class CompressedDirectory

java.lang.Object

com.spotify.docker.client.CompressedDirectory

 class CompressedDirectory
extends Object

This helper class is used during the docker build command to create a gzip tarball of a directory containing a Dockerfile.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	CompressedDirectory.Visitor

Field Summary

Fields

Modifier and Type	Field and Description
private static int	DEFAULT_FILE_MODE Default mode to be applied to tar file entries if detailed Posix-compliant mode cannot be obtained.
private static org.slf4j.Logger	log
private static String	POSIX_FILE_VIEW Identifier used to indicate the OS supports a Posix compliant view of the file system.

Constructor Summary

Constructors

Constructor and Description
CompressedDirectory()

Method Summary

Methods

Modifier and Type	Method and Description
static File	create(Path directory) This method creates a gzip tarball of the specified directory.
static File	create(String directory) This method creates a gzip tarball of the specified directory.
static boolean	delete(File file) Convenience method for deleting files.

Methods inherited from class java.lang.Object

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

Field Detail

log

private static final org.slf4j.Logger log

DEFAULT_FILE_MODE

private static final int DEFAULT_FILE_MODE

Default mode to be applied to tar file entries if detailed Posix-compliant mode cannot be obtained.

See Also:

Constant Field Values

POSIX_FILE_VIEW

private static final String POSIX_FILE_VIEW

Identifier used to indicate the OS supports a Posix compliant view of the file system.

See Also:

PosixFileAttributeView.name(), Constant Field Values

Constructor Detail

CompressedDirectory

CompressedDirectory()

Method Detail

create

public static File create(String directory)
                   throws IOException

This method creates a gzip tarball of the specified directory. File permissions will be retained. The file will be created in a temporary directory using the File.createTempFile(String, String) method. If the method returns successfully, it is the caller's responsibility to delete the file.

Parameters:

directory - the directory to compress

Returns:

a File object representing the compressed directory

Throws:

IOException

create

public static File create(Path directory)
                   throws IOException

This method creates a gzip tarball of the specified directory. File permissions will be retained. The file will be created in a temporary directory using the File.createTempFile(String, String) method. If the method returns successfully, it is the caller's responsibility to delete the file.

Parameters:

directory - the directory to compress

Returns:

a File object representing the compressed directory

Throws:

IOException

delete

public static boolean delete(File file)

Convenience method for deleting files. This method safely handles null values, and will never throw an exception.

Parameters:

file - the file to delete.

Returns:

true if file was deleted successfully, otherwise false.