com.github.dockerjava.api.command
Interface AuthCmd

All Superinterfaces:

DockerCmd<AuthResponse>

All Known Implementing Classes:

AuthCmdImpl

public interface AuthCmd
extends DockerCmd<AuthResponse>

Authenticate with the server, useful for checking authentication.

Nested Class Summary

static interface

AuthCmd.Exec

Method Summary

AuthResponse	exec()
AuthConfig	getAuthConfig()
AuthCmd	withAuthConfig(AuthConfig authConfig)

Method Detail

getAuthConfig

AuthConfig getAuthConfig()

withAuthConfig

AuthCmd withAuthConfig(AuthConfig authConfig)

exec

AuthResponse exec()
                  throws UnauthorizedException

Specified by:

exec in interface DockerCmd<AuthResponse>

Returns:

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).