com.github.dockerjava.api.command

Interface AuthCmd

All Superinterfaces:

AutoCloseable, Closeable, DockerCmd<AuthResponse>, SyncDockerCmd<AuthResponse>

All Known Implementing Classes:

AuthCmdImpl

public interface AuthCmd
extends SyncDockerCmd<AuthResponse>

Authenticate with the server, useful for checking authentication.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	AuthCmd.Exec

Method Summary

Modifier and Type	Method and Description
AuthResponse	exec()
AuthConfig	getAuthConfig()
AuthCmd	withAuthConfig(AuthConfig authConfig)

Methods inherited from interface com.github.dockerjava.api.command.DockerCmd

close

Method Detail

getAuthConfig

@CheckForNull
AuthConfig getAuthConfig()

withAuthConfig

AuthCmd withAuthConfig(@Nonnull
                       AuthConfig authConfig)

exec

AuthResponse exec()
           throws UnauthorizedException

Specified by:

exec in interface SyncDockerCmd<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).