org.testcontainers.utility

Class MountableFile

java.lang.Object

org.testcontainers.utility.MountableFile

All Implemented Interfaces:

Transferable

public class MountableFile
extends java.lang.Object
implements Transferable

An abstraction over files and classpath resources aimed at encapsulating all the complexity of generating a path that the Docker daemon is about to create a volume mount for.

Field Summary

Fields inherited from interface org.testcontainers.images.builder.Transferable

DEFAULT_DIR_MODE, DEFAULT_FILE_MODE

Constructor Summary

Constructors

Constructor and Description
MountableFile()

Method Summary

Modifier and Type	Method and Description
static MountableFile	forClasspathResource(@NotNull java.lang.String resourceName) Obtains a MountableFile corresponding to a resource on the classpath (including resources in JAR files)
static MountableFile	forClasspathResource(@NotNull java.lang.String resourceName, java.lang.Integer mode) Obtains a MountableFile corresponding to a resource on the classpath (including resources in JAR files)
static MountableFile	forHostPath(java.nio.file.Path path) Obtains a MountableFile corresponding to a file on the docker host filesystem.
static MountableFile	forHostPath(java.nio.file.Path path, java.lang.Integer mode) Obtains a MountableFile corresponding to a file on the docker host filesystem.
static MountableFile	forHostPath(@NotNull java.lang.String path) Obtains a MountableFile corresponding to a file on the docker host filesystem.
static MountableFile	forHostPath(@NotNull java.lang.String path, java.lang.Integer mode) Obtains a MountableFile corresponding to a file on the docker host filesystem.
java.lang.String	getDescription()
int	getFileMode() Get file mode.
long	getSize() Size of an object.
void	transferTo(org.apache.commons.compress.archivers.tar.TarArchiveOutputStream outputStream, java.lang.String destinationPathInTar) transfer content of this Transferable to the output stream.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.testcontainers.images.builder.Transferable

getBytes, of, of

Constructor Detail

MountableFile

public MountableFile()

Method Detail

forClasspathResource

public static MountableFile forClasspathResource(@NotNull
                                                 @NotNull java.lang.String resourceName)

Obtains a MountableFile corresponding to a resource on the classpath (including resources in JAR files)

Parameters:

resourceName - the classpath path to the resource

Returns:

a MountableFile that may be used to obtain a mountable path

forHostPath

public static MountableFile forHostPath(@NotNull
                                        @NotNull java.lang.String path)

Obtains a MountableFile corresponding to a file on the docker host filesystem.

Parameters:

path - the path to the resource

Returns:

a MountableFile that may be used to obtain a mountable path

forHostPath

public static MountableFile forHostPath(java.nio.file.Path path)

Obtains a MountableFile corresponding to a file on the docker host filesystem.

Parameters:

path - the path to the resource

Returns:

a MountableFile that may be used to obtain a mountable path

forClasspathResource

public static MountableFile forClasspathResource(@NotNull
                                                 @NotNull java.lang.String resourceName,
                                                 java.lang.Integer mode)

Obtains a MountableFile corresponding to a resource on the classpath (including resources in JAR files)

Parameters:

resourceName - the classpath path to the resource

mode - octal value of posix file mode (000..777)

Returns:

a MountableFile that may be used to obtain a mountable path

forHostPath

public static MountableFile forHostPath(@NotNull
                                        @NotNull java.lang.String path,
                                        java.lang.Integer mode)

Obtains a MountableFile corresponding to a file on the docker host filesystem.

Parameters:

path - the path to the resource

mode - octal value of posix file mode (000..777)

Returns:

a MountableFile that may be used to obtain a mountable path

forHostPath

public static MountableFile forHostPath(java.nio.file.Path path,
                                        java.lang.Integer mode)

Obtains a MountableFile corresponding to a file on the docker host filesystem.

Parameters:

path - the path to the resource

mode - octal value of posix file mode (000..777)

Returns:

a MountableFile that may be used to obtain a mountable path

transferTo

public void transferTo(org.apache.commons.compress.archivers.tar.TarArchiveOutputStream outputStream,
                       java.lang.String destinationPathInTar)

transfer content of this Transferable to the output stream. Must not close the stream.

Specified by:

transferTo in interface Transferable

Parameters:

outputStream - stream to output

getSize

public long getSize()

Description copied from interface: Transferable

Size of an object.

Specified by:

getSize in interface Transferable

Returns:

size in bytes

getDescription

public java.lang.String getDescription()

Specified by:

getDescription in interface Transferable

getFileMode

public int getFileMode()

Description copied from interface: Transferable

Get file mode. Default is 0100644.

Specified by:

getFileMode in interface Transferable

Returns:

file mode

See Also:

Transferable.DEFAULT_FILE_MODE