content: /**
   * Copyright (c) 2018-2019, Mihai Emil Andronache
   * All rights reserved.
   * Redistribution and use in source and binary forms, with or without
   * modification, are permitted provided that the following conditions are met:
   * 1)Redistributions of source code must retain the above copyright notice,
   * this list of conditions and the following disclaimer.
   * 2)Redistributions in binary form must reproduce the above copyright notice,
   * this list of conditions and the following disclaimer in the documentation
   * and/or other materials provided with the distribution.
   * 3)Neither the name of docker-java-api nor the names of its
   * contributors may be used to endorse or promote products derived from
   * this software without specific prior written permission.
   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
   * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
   * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
   * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
   * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
   * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
   * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
   * POSSIBILITY OF SUCH DAMAGE.
   */
  package com.amihaiemil.docker;
  
  import java.io.IOException;
  import org.apache.http.client.HttpClient;
  
  /**
   * Docker API entry point.
   * @author Mihai Andronache (amihaiemil@gmail.com)
   * @version $Id: 2c5afed3a53d24c1a1bee70a4e33e018ab418548 $
   * @since 0.0.1
   */
  public interface Docker {
  
      /**
       * Ping the Docker Engine.
       * @return True if it responds with 200 OK, false otherwise.
       * @throws IOException If there's network problem.
       */
      boolean ping() throws IOException;
  
      /**
       * Entry point for the Events API.
       * @return Events.
       */
      Events events();
  
      /**
       * Entry point for the Containers API.
       * @return Containers.
       */
      Containers containers();
  
      /**
       * Entry point for the Images API.
       * @return Images.
       */
      Images images();
  
      /**
       * Entry point for the Networks API.
       * @return Networks.
       */
      Networks networks();
  
      /**
       * Entry point for the Volumes API.
       * @return Volumes.
       */
      Volumes volumes();
  
      /**
       * Entry point for the Exec API.
       * @return Execs.
       */
      Execs execs();
  
      /**
       * Entry point for the Swarm API.
       * @return Swarm.
       */
      Swarm swarm();
  
      /**
       * Entry point for the DockerSystem API.
       * @return DockerSystem.
       */
      DockerSystem system();
  
      /**
       * Entry point for the Plugins API.
       * @return Plugins.
       */
      Plugins plugins();
  
      /**
       * Version of this Docker engine.
       * @return Version.
       * @throws IOException If an I/O error occurs.
       */
      Version version() throws IOException;
  
      /**
       * Detailed information about this Docker engine, in JSON.
       * @return Info.
       * @throws IOException If an I/O problem occurs.
       */
      Info info() throws IOException;
  
      /**
       * The underlying, immutable, Apache HttpClient.<br><br>
       *
       * Use this method to fetch the underlying HttpClient and perform your own
       * HTTP requests, in case the API is missing the desired method.<br><br>
       *
       * Usage in any other scenario is discouraged. Try to find the desired
       * method before using this. Also, if the method is missing, open an
       * Issue at https://www.github.com/amihaiemil/docker-java-api, maybe
       * it can be implemented and released quickly.
       *
       * @return The underlying HttpClient.
       */
      HttpClient httpClient();
  }
  