Class DockerHost


  • public class DockerHost
    extends java.lang.Object
    Represents a dockerd endpoint. A codified DOCKER_HOST.
    • Field Detail

      • DEFAULT_UNIX_ENDPOINT

        private static final java.lang.String DEFAULT_UNIX_ENDPOINT
        See Also:
        Constant Field Values
      • host

        private final java.lang.String host
      • uri

        private final java.net.URI uri
      • bindUri

        private final java.net.URI bindUri
      • address

        private final java.lang.String address
      • port

        private final int port
      • certPath

        private final java.lang.String certPath
    • Constructor Detail

      • DockerHost

        private DockerHost​(java.lang.String endpoint,
                           java.lang.String certPath)
    • Method Detail

      • host

        public java.lang.String host()
        Get a Docker endpoint usable for instantiating a new DockerHost with DockerHost.from(endpoint).
        Returns:
        A unix socket path or, in the case of a TCP socket, the hostname and port which represents a Docker endpoint.
      • uri

        public java.net.URI uri()
        Get the Docker rest uri.
        Returns:
        The uri of the Docker endpoint.
      • bindUri

        public java.net.URI bindUri()
        Get the Docker rest bind uri.
        Returns:
        The uri of the host for binding ports (or setting $DOCKER_HOST).
      • port

        public int port()
        Get the Docker endpoint port.
        Returns:
        The port.
      • address

        public java.lang.String address()
        Get the Docker ip address or hostname.
        Returns:
        The ip address or hostname.
      • dockerCertPath

        public java.lang.String dockerCertPath()
        Get the path to certificate and key for connecting to Docker via HTTPS.
        Returns:
        The path to the certificate.
      • restoreSystemDelegate

        static void restoreSystemDelegate()
      • fromEnv

        public static DockerHost fromEnv()
        Create a DockerHost from DOCKER_HOST and DOCKER_PORT env vars.
        Returns:
        The DockerHost object.
      • from

        public static DockerHost from​(java.lang.String endpoint,
                                      java.lang.String certPath)
        Create a DockerHost from an explicit address or uri.
        Parameters:
        endpoint - The Docker endpoint.
        certPath - The certificate path.
        Returns:
        The DockerHost object.
      • defaultDockerEndpoint

        static java.lang.String defaultDockerEndpoint()
      • endpointFromEnv

        static java.lang.String endpointFromEnv()
      • defaultUnixEndpoint

        public static java.lang.String defaultUnixEndpoint()
      • defaultAddress

        public static java.lang.String defaultAddress()
      • defaultPort

        public static int defaultPort()
      • portFromEnv

        static int portFromEnv()
      • defaultCertPath

        static java.lang.String defaultCertPath()
      • certPathFromEnv

        static java.lang.String certPathFromEnv()
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object