Class Docker

java.lang.Object
org.springframework.boot.maven.Docker
public class Docker extends Object
Docker configuration options.
Since:
2.4.0
Author:
Wei Jiang, Scott Frederick

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    Docker.DockerRegistry
    Encapsulates Docker registry authentication configuration options.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Docker()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    @Nullable String
    getCertPath()
    The path to TLS certificate and key files required for TLS communication with the Docker daemon.
    @Nullable String
    getContext()
    The Docker context to use to retrieve host configuration.
    @Nullable String
    getHost()
    The host address of the Docker daemon.
    boolean
    isBindHostToBuilder()
    Whether to use the configured Docker host in the builder container.
    boolean
    isTlsVerify()
    Whether the Docker daemon requires TLS communication.
    void
    setContext(@Nullable String context)
     

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • Docker

      public Docker()

  • Method Details

    • getHost

      public @Nullable String getHost()
      The host address of the Docker daemon.
      Returns:
      the Docker host

    • getContext

      public @Nullable String getContext()
      The Docker context to use to retrieve host configuration.
      Returns:
      the Docker context

    • setContext

      public void setContext(@Nullable String context)

    • isTlsVerify

      public boolean isTlsVerify()
      Whether the Docker daemon requires TLS communication.
      Returns:
      true to enable TLS

    • getCertPath

      public @Nullable String getCertPath()
      The path to TLS certificate and key files required for TLS communication with the Docker daemon.
      Returns:
      the TLS certificate path

    • isBindHostToBuilder

      public boolean isBindHostToBuilder()
      Whether to use the configured Docker host in the builder container.
      Returns:
      true to use the configured Docker host in the builder container