Package dasniko.testcontainers.keycloak

Class KeycloakContainer

java.lang.Object

org.testcontainers.containers.GenericContainer<SELF>

dasniko.testcontainers.keycloak.ExtendableKeycloakContainer<KeycloakContainer>

dasniko.testcontainers.keycloak.KeycloakContainer

All Implemented Interfaces:

AutoCloseable, org.testcontainers.containers.Container<KeycloakContainer>, org.testcontainers.containers.ContainerState, org.testcontainers.containers.traits.LinkableContainer, org.testcontainers.containers.wait.strategy.WaitStrategyTarget, org.testcontainers.lifecycle.Startable

public class KeycloakContainer
extends ExtendableKeycloakContainer<KeycloakContainer>

Author:

Niko Köbler, https://www.n-k.de, @dasniko

Nested Class Summary

Nested classes/interfaces inherited from interface org.testcontainers.containers.Container

org.testcontainers.containers.Container.ExecResult

Field Summary

Fields inherited from class dasniko.testcontainers.keycloak.ExtendableKeycloakContainer

ADMIN_CLI_CLIENT, LOG_WAIT_STRATEGY, MASTER_REALM

Fields inherited from class org.testcontainers.containers.GenericContainer

CONTAINER_RUNNING_TIMEOUT_SEC, dependencies, dockerClient, INTERNAL_HOST_HOSTNAME, waitStrategy

Fields inherited from interface org.testcontainers.containers.ContainerState

STATE_HEALTHY

Constructor Summary

Constructors

Constructor	Description
KeycloakContainer()	Deprecated. use KeycloakContainer(String dockerImageName) or KeycloakContainer(DockerImageName dockerImageName) instead.
KeycloakContainer(String dockerImageName)	Create a KeycloakContainer by passing the full docker image name
KeycloakContainer(org.testcontainers.utility.DockerImageName dockerImageName)	Create a KeycloakContainer by passing the full docker image name

Method Summary

Methods inherited from class dasniko.testcontainers.keycloak.ExtendableKeycloakContainer

configure, createKeycloakExtensionDeployment, createKeycloakExtensionProvider, disableLightweightAccessTokenForAdminCliClient, getAdminPassword, getAdminUsername, getAuthServerUrl, getContextPath, getDebugPort, getHttpMgmtPort, getHttpPort, getHttpsPort, getKeycloakAdminClient, getKeycloakDefaultVersion, getMgmtServerUrl, getProtocol, getStartupTimeout, resolveExtensionClassLocation, useMutualTls, useTls, useTls, useTlsKeystore, waitingFor, withAdminPassword, withAdminUsername, withBootstrapAdminDisabled, withCommand, withCommand, withContextPath, withCustomCommand, withDebug, withDebugFixedPort, withDefaultProviderClasses, withDisabledCaching, withEnabledMetrics, withFeaturesDisabled, withFeaturesEnabled, withHttpsClientAuth, withImagePullPolicy, withNightly, withOptimizedFlag, withProductionMode, withProviderClassesFrom, withProviderLibsFrom, withRamPercentage, withRealmImportFile, withRealmImportFiles, withStartupTimeout, withTrustedCertificates, withVerboseOutput

Methods inherited from class org.testcontainers.containers.GenericContainer

addEnv, addExposedPort, addExposedPorts, addFileSystemBind, addFixedExposedPort, addFixedExposedPort, addLink, canBeReused, containerIsCreated, containerIsStarted, containerIsStarted, containerIsStarting, containerIsStarting, containerIsStopped, containerIsStopping, copyFileFromContainer, createVolumeDirectory, dependsOn, dependsOn, dependsOn, doStart, equals, getBinds, getCommandParts, getContainerId, getContainerInfo, getContainerName, getCopyToFileContainerPathMap, getCreateContainerCmdModifiers, getDependencies, getDockerClient, getDockerImageName, getEnv, getEnvMap, getExposedPorts, getExtraHosts, getImage, getIpAddress, getLabels, getLinkedContainers, getLivenessCheckPort, getLivenessCheckPortNumbers, getLivenessCheckPorts, getLogConsumers, getNetwork, getNetworkAliases, getNetworkMode, getPortBindings, getShmSize, getStartupAttempts, getStartupCheckStrategy, getTestHostIpAddress, getTmpFsMapping, getVolumesFroms, getWaitStrategy, getWorkingDirectory, hashCode, isHostAccessible, isPrivilegedMode, isShouldBeReused, logger, setBinds, setCommand, setCommand, setCommandParts, setContainerDef, setCopyToFileContainerPathMap, setDockerImageName, setEnv, setExposedPorts, setExtraHosts, setHostAccessible, setImage, setLabels, setLinkedContainers, setLogConsumers, setNetwork, setNetworkAliases, setNetworkMode, setPortBindings, setPrivilegedMode, setShmSize, setStartupAttempts, setStartupCheckStrategy, setTmpFsMapping, setVolumesFroms, setWaitStrategy, setWorkingDirectory, start, stop, toString, waitUntilContainerStarted, withAccessToHost, withClasspathResourceMapping, withClasspathResourceMapping, withCopyFileToContainer, withCopyToContainer, withCreateContainerCmdModifier, withEnv, withEnv, withExposedPorts, withExtraHost, withFileSystemBind, withLabel, withLabels, withLogConsumer, withMinimumRunningDuration, withNetwork, withNetworkAliases, withNetworkMode, withPrivilegedMode, withReuse, withSharedMemorySize, withStartupAttempts, withStartupCheckStrategy, withTmpFs, withVolumesFrom, withWorkingDirectory

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.testcontainers.containers.Container

addFileSystemBind, followOutput, followOutput, self, withEnv, withFileSystemBind

Methods inherited from interface org.testcontainers.containers.ContainerState

copyFileFromContainer, copyFileToContainer, copyFileToContainer, execInContainer, execInContainer, execInContainer, execInContainer, execInContainerWithUser, execInContainerWithUser, getBoundPortNumbers, getContainerIpAddress, getCurrentContainerInfo, getFirstMappedPort, getHost, getLogs, getLogs, getMappedPort, isCreated, isHealthy, isRunning

Methods inherited from interface org.testcontainers.lifecycle.Startable

close

Constructor Details

KeycloakContainer

@Deprecated(since="4.2.0")
public KeycloakContainer()

Deprecated.

use KeycloakContainer(String dockerImageName) or KeycloakContainer(DockerImageName dockerImageName) instead. The behavior of this constructor will change in the future!

Create a KeycloakContainer with the default image and version tag

KeycloakContainer

public KeycloakContainer(String dockerImageName)

Create a KeycloakContainer by passing the full docker image name

Parameters:

dockerImageName - Full docker image name, e.g. quay.io/keycloak/keycloak:25.0

KeycloakContainer

public KeycloakContainer(org.testcontainers.utility.DockerImageName dockerImageName)

Create a KeycloakContainer by passing the full docker image name

Parameters:

dockerImageName - Full docker image name as DockerImageName object, e.g. DockerImageName.parse("quay.io/keycloak/keycloak:25.0")