com.fitbur.github.dockerjava.api.DockerClient Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of external-docker-java Show documentation
There is a newer version: 1.0.0
package com.fitbur.github.dockerjava.api;

import java.io.Closeable;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;

import com.fitbur.github.dockerjava.api.com.fitburmand.AttachContainerCmd;
import com.fitbur.github.dockerjava.api.com.fitburmand.AuthCmd;
import com.fitbur.github.dockerjava.api.com.fitburmand.BuildImageCmd;
import com.fitbur.github.dockerjava.api.com.fitburmand.CommitCmd;
import com.fitbur.github.dockerjava.api.com.fitburmand.ContainerDiffCmd;
import com.fitbur.github.dockerjava.api.com.fitburmand.CopyFileFromContainerCmd;
import com.fitbur.github.dockerjava.api.com.fitburmand.CreateContainerCmd;
import com.fitbur.github.dockerjava.api.com.fitburmand.CreateImageCmd;
import com.fitbur.github.dockerjava.api.com.fitburmand.EventsCmd;
import com.fitbur.github.dockerjava.api.com.fitburmand.ExecCreateCmd;
import com.fitbur.github.dockerjava.api.com.fitburmand.ExecStartCmd;
import com.fitbur.github.dockerjava.api.com.fitburmand.InfoCmd;
import com.fitbur.github.dockerjava.api.com.fitburmand.InspectContainerCmd;
import com.fitbur.github.dockerjava.api.com.fitburmand.InspectExecCmd;
import com.fitbur.github.dockerjava.api.com.fitburmand.InspectImageCmd;
import com.fitbur.github.dockerjava.api.com.fitburmand.KillContainerCmd;
import com.fitbur.github.dockerjava.api.com.fitburmand.ListContainersCmd;
import com.fitbur.github.dockerjava.api.com.fitburmand.ListImagesCmd;
import com.fitbur.github.dockerjava.api.com.fitburmand.LogContainerCmd;
import com.fitbur.github.dockerjava.api.com.fitburmand.PauseContainerCmd;
import com.fitbur.github.dockerjava.api.com.fitburmand.PingCmd;
import com.fitbur.github.dockerjava.api.com.fitburmand.PullImageCmd;
import com.fitbur.github.dockerjava.api.com.fitburmand.PushImageCmd;
import com.fitbur.github.dockerjava.api.com.fitburmand.RemoveContainerCmd;
import com.fitbur.github.dockerjava.api.com.fitburmand.RemoveImageCmd;
import com.fitbur.github.dockerjava.api.com.fitburmand.RestartContainerCmd;
import com.fitbur.github.dockerjava.api.com.fitburmand.SaveImageCmd;
import com.fitbur.github.dockerjava.api.com.fitburmand.SearchImagesCmd;
import com.fitbur.github.dockerjava.api.com.fitburmand.StartContainerCmd;
import com.fitbur.github.dockerjava.api.com.fitburmand.StatsCmd;
import com.fitbur.github.dockerjava.api.com.fitburmand.StopContainerCmd;
import com.fitbur.github.dockerjava.api.com.fitburmand.TagImageCmd;
import com.fitbur.github.dockerjava.api.com.fitburmand.TopContainerCmd;
import com.fitbur.github.dockerjava.api.com.fitburmand.UnpauseContainerCmd;
import com.fitbur.github.dockerjava.api.com.fitburmand.VersionCmd;
import com.fitbur.github.dockerjava.api.com.fitburmand.WaitContainerCmd;
import com.fitbur.github.dockerjava.api.model.AuthConfig;
import com.fitbur.github.dockerjava.api.model.Identifier;

// https://godoc.com.fitbur/github.com.fitbur/fsouza/go-dockerclient
public interface DockerClient extends Closeable {

    public AuthConfig authConfig() throws DockerException;

    /**
     * Authenticate with the server, useful for checking authentication.
     */
    public AuthCmd authCmd();

    public InfoCmd infoCmd();

    public PingCmd pingCmd();

    public VersionCmd versionCmd();

    /**
     * * IMAGE API *
     */

    public PullImageCmd pullImageCmd(String repository);

    public PushImageCmd pushImageCmd(String name);

    public PushImageCmd pushImageCmd(Identifier identifier);

    public CreateImageCmd createImageCmd(String repository, InputStream imageStream);

    public SearchImagesCmd searchImagesCmd(String term);

    public RemoveImageCmd removeImageCmd(String imageId);

    public ListImagesCmd listImagesCmd();

    public InspectImageCmd inspectImageCmd(String imageId);

    public SaveImageCmd saveImageCmd(String name);

    /**
     * * CONTAINER API *
     */

    public ListContainersCmd listContainersCmd();

    public CreateContainerCmd createContainerCmd(String image);

    /**
     * Creates a new {@link StartContainerCmd} for the container with the given ID. The com.fitburmand can then be further
     * customized by using builder methods on it like {@link StartContainerCmd#withDns(String...)}.
     * 
     * If you customize the com.fitburmand, any existing configuration of the target container will get reset to its com.fitburfault
     * before applying the new configuration. To preserve the existing configuration, use an unconfigured
     * {@link StartContainerCmd}.
     * 
     * This com.fitburmand corresponds to the /containers/{id}/start endpoint of the Docker Remote API.
     */
    public StartContainerCmd startContainerCmd(String containerId);

    public ExecCreateCmd execCreateCmd(String containerId);

    public InspectContainerCmd inspectContainerCmd(String containerId);

    public RemoveContainerCmd removeContainerCmd(String containerId);

    public WaitContainerCmd waitContainerCmd(String containerId);

    public AttachContainerCmd attachContainerCmd(String containerId);

    public ExecStartCmd execStartCmd(String containerId);

    public InspectExecCmd inspectExecCmd(String execId);

    public LogContainerCmd logContainerCmd(String containerId);

    public CopyFileFromContainerCmd copyFileFromContainerCmd(String containerId, String resource);

    public ContainerDiffCmd containerDiffCmd(String containerId);

    public StopContainerCmd stopContainerCmd(String containerId);

    public KillContainerCmd killContainerCmd(String containerId);

    public RestartContainerCmd restartContainerCmd(String containerId);

    public CommitCmd com.fitburmitCmd(String containerId);

    public BuildImageCmd buildImageCmd();

    public BuildImageCmd buildImageCmd(File dockerFileOrFolder);

    public BuildImageCmd buildImageCmd(InputStream tarInputStream);

    public TopContainerCmd topContainerCmd(String containerId);

    public TagImageCmd tagImageCmd(String imageId, String repository, String tag);

    public PauseContainerCmd pauseContainerCmd(String containerId);

    public UnpauseContainerCmd unpauseContainerCmd(String containerId);

    public EventsCmd eventsCmd();

    public StatsCmd statsCmd();

    @Override
    public void close() throws IOException;

}