com.github.dockerjava.api.command.AuthCmd Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of docker-java Show documentation

Java API Client for Docker

There is a newer version: 3.4.1

package com.github.dockerjava.api.command;

import com.github.dockerjava.api.UnauthorizedException;
import com.github.dockerjava.api.model.AuthConfig;
import com.github.dockerjava.api.model.AuthResponse;

/**
 * 
 * Authenticate with the server, useful for checking authentication.
 * 
 */
public interface AuthCmd extends DockerCmd {
	
	public AuthConfig getAuthConfig();

	public AuthCmd withAuthConfig(AuthConfig authConfig);

    /**
     * @return The status. Based on it's value you may mean you need to authorise your account, e.g.:
     *  "Account created. Please see the documentation of the registry http://localhost:5000/v1/ for instructions how to activate it."
     * @throws UnauthorizedException If you're not authorised (e.g. bad password).
     */
	@Override
	public AuthResponse exec() throws UnauthorizedException;
	
	public static interface Exec extends DockerCmdExec {
	}

}