Package com.spotify.docker.client

Class CompressedDirectory

java.lang.Object

com.spotify.docker.client.CompressedDirectory

All Implemented Interfaces:

Closeable, AutoCloseable

class CompressedDirectory
extends Object
implements Closeable

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	Description
private static class	CompressedDirectory.DockerIgnorePathMatcher	A decorator for the PathMatcher with a type to determine if it is an exclusion pattern or an exclude to an aforementioned exclusion.
private static class	CompressedDirectory.Visitor

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor	Description
private	CompressedDirectory(Path file)

Method Summary

Modifier and Type	Method	Description
void	close()
static CompressedDirectory	create(Path directory)	This method creates a gzip tarball of the specified directory.
private static String	createPattern(String line)
Path	file()	The file for the created compressed directory archive.
private static String	getNotSeparatorPattern(String separator)
(package private) static PathMatcher	goPathMatcher(FileSystem fs, String pattern)
(package private) static com.google.common.collect.ImmutableList<CompressedDirectory.DockerIgnorePathMatcher>	parseDockerIgnore(Path dockerIgnorePath)

Methods inherited from class java.lang.Object

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

Field Details

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

file

private final Path file

Constructor Details

CompressedDirectory

private CompressedDirectory(Path file)

Method Details

file

public Path file()

The file for the created compressed directory archive.

Returns:

a Path object representing the compressed directory

create

public static CompressedDirectory 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 Files.createTempFile(String, String, java.nio.file.attribute.FileAttribute[]) method. The returned object is auto-closeable, and upon closing it, the archive file will be deleted.

Parameters:

directory - the directory to compress

Returns:

a Path object representing the compressed directory

Throws:

IOException - if the compressed directory could not be created.

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

parseDockerIgnore

static com.google.common.collect.ImmutableList<CompressedDirectory.DockerIgnorePathMatcher> parseDockerIgnore(Path dockerIgnorePath)
                                                                                                       throws IOException

Throws:

IOException

createPattern

private static String createPattern(String line)

goPathMatcher

static PathMatcher goPathMatcher(FileSystem fs,
 String pattern)

getNotSeparatorPattern

private static String getNotSeparatorPattern(String separator)