public class TestcontainersConfiguration
extends java.lang.Object
Configuration may be provided in:
.testcontainers.properties
testcontainers.properties
Note that, if using environment variables, property names are in upper case separated by underscores, preceded by
TESTCONTAINERS_
.
Modifier and Type | Method and Description |
---|---|
protected boolean |
canEqual(java.lang.Object other) |
boolean |
environmentSupportsReuse() |
boolean |
equals(java.lang.Object o) |
java.lang.String |
getAmbassadorContainerImage()
Deprecated.
|
java.util.Properties |
getClasspathProperties() |
java.lang.Integer |
getClientPingTimeout() |
java.lang.String |
getDockerClientStrategyClassName() |
java.lang.String |
getDockerComposeContainerImage()
Deprecated.
|
java.util.Map<java.lang.String,java.lang.String> |
getEnvironment() |
java.lang.String |
getEnvVarOrProperty(@NotNull java.lang.String propertyName,
@Nullable java.lang.String defaultValue)
Gets a configured setting from an environment variable (if present) or a configuration file property otherwise.
|
java.lang.String |
getEnvVarOrUserProperty(@NotNull java.lang.String propertyName,
@Nullable java.lang.String defaultValue)
Gets a configured setting from an environment variable (if present) or a configuration file property otherwise.
|
java.lang.Integer |
getImagePullPauseTimeout() |
java.lang.String |
getImageSubstitutorClassName() |
static TestcontainersConfiguration |
getInstance() |
java.lang.String |
getKafkaImage()
Deprecated.
|
java.lang.String |
getLocalStackImage()
Deprecated.
|
java.lang.String |
getOracleImage()
Deprecated.
|
java.util.Properties |
getProperties()
Deprecated.
usages should be removed ASAP. See
getEnvVarOrProperty(String, String) ,
getEnvVarOrUserProperty(String, String) or getUserProperty(String, String)
for suitable replacements. |
java.lang.String |
getPulsarImage()
Deprecated.
|
java.lang.String |
getRyukImage()
Deprecated.
|
java.lang.Integer |
getRyukTimeout() |
java.lang.String |
getSocatContainerImage()
Deprecated.
|
java.lang.String |
getSSHdImage()
Deprecated.
|
java.lang.String |
getTinyImage()
Deprecated.
|
java.lang.String |
getTransportType() |
java.util.Properties |
getUserProperties() |
java.lang.String |
getUserProperty(@NotNull java.lang.String propertyName,
@Nullable java.lang.String defaultValue)
Gets a configured setting from an environment variable.
|
java.lang.String |
getVncRecordedContainerImage()
Deprecated.
|
int |
hashCode() |
boolean |
isDisableChecks() |
boolean |
isRyukPrivileged() |
java.lang.String |
toString() |
boolean |
updateGlobalConfig(@NonNull java.lang.String prop,
@NonNull java.lang.String value)
Deprecated.
|
boolean |
updateUserConfig(@NonNull java.lang.String prop,
@NonNull java.lang.String value) |
@Deprecated public java.lang.String getAmbassadorContainerImage()
@Deprecated public java.lang.String getSocatContainerImage()
@Deprecated public java.lang.String getVncRecordedContainerImage()
@Deprecated public java.lang.String getDockerComposeContainerImage()
@Deprecated public java.lang.String getTinyImage()
public boolean isRyukPrivileged()
@Deprecated public java.lang.String getRyukImage()
@Deprecated public java.lang.String getSSHdImage()
public java.lang.Integer getRyukTimeout()
@Deprecated public java.lang.String getKafkaImage()
@Deprecated public java.lang.String getOracleImage()
@Deprecated public java.lang.String getPulsarImage()
@Deprecated public java.lang.String getLocalStackImage()
public boolean isDisableChecks()
@UnstableAPI public boolean environmentSupportsReuse()
public java.lang.String getDockerClientStrategyClassName()
public java.lang.String getTransportType()
public java.lang.Integer getImagePullPauseTimeout()
public java.lang.String getImageSubstitutorClassName()
public java.lang.Integer getClientPingTimeout()
@Contract(value="_, !null -> !null") public java.lang.String getEnvVarOrProperty(@NotNull @NotNull java.lang.String propertyName, @Nullable @Nullable java.lang.String defaultValue)
.testcontainers.properties
file in the user's home directory or
a testcontainers.properties
found on the classpath.
Note that when searching environment variables, the prefix `TESTCONTAINERS_` will usually be applied to the property name, which will be converted to upper-case with underscore separators. This prefix will not be added if the property name begins `docker.`.
propertyName
- name of configuration file property (dot-separated lower case)@Contract(value="_, !null -> !null") public java.lang.String getEnvVarOrUserProperty(@NotNull @NotNull java.lang.String propertyName, @Nullable @Nullable java.lang.String defaultValue)
.testcontainers.properties
file in the user's home directory.
Note that when searching environment variables, the prefix `TESTCONTAINERS_` will usually be applied to the property name, which will be converted to upper-case with underscore separators. This prefix will not be added if the property name begins `docker.`.
propertyName
- name of configuration file property (dot-separated lower case)@Contract(value="_, !null -> !null") public java.lang.String getUserProperty(@NotNull @NotNull java.lang.String propertyName, @Nullable @Nullable java.lang.String defaultValue)
Note that when searching environment variables, the prefix `TESTCONTAINERS_` will usually be applied to the property name, which will be converted to upper-case with underscore separators. This prefix will not be added if the property name begins `docker.`.
propertyName
- name of configuration file property (dot-separated lower case)@Deprecated public java.util.Properties getProperties()
getEnvVarOrProperty(String, String)
,
getEnvVarOrUserProperty(String, String)
or getUserProperty(String, String)
for suitable replacements.@Deprecated public boolean updateGlobalConfig(@NonNull @NonNull java.lang.String prop, @NonNull @NonNull java.lang.String value)
public boolean updateUserConfig(@NonNull @NonNull java.lang.String prop, @NonNull @NonNull java.lang.String value)
public java.util.Properties getUserProperties()
public java.util.Properties getClasspathProperties()
public java.util.Map<java.lang.String,java.lang.String> getEnvironment()
public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
protected boolean canEqual(java.lang.Object other)
public int hashCode()
hashCode
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object
public static TestcontainersConfiguration getInstance()