com.spotify.docker.client.auth

Class MultiRegistryAuthSupplier

java.lang.Object

com.spotify.docker.client.auth.MultiRegistryAuthSupplier

All Implemented Interfaces:

RegistryAuthSupplier

public class MultiRegistryAuthSupplier
extends Object
implements RegistryAuthSupplier

A RegistryAuthSupplier that combines authentication info from multiple RegistryAuthSupplier instances.

The order of the suppliers matters: RegistryAuthSuppliers earlier in the list are checked first to see if they can handle authentication for the given operation before trying later RegistryAuthSuppliers in the list (a RegistryAuthSupplier signals that it can't handle the operation by returning null).

Constructor Summary

Constructors

Constructor and Description
MultiRegistryAuthSupplier(List<RegistryAuthSupplier> suppliers)

Method Summary

Modifier and Type	Method and Description
RegistryAuth	authFor(String imageName) Returns a RegistryAuth object that works with a given registry's API [e.g.
RegistryConfigs	authForBuild() Authentication info to pass in the X-Registry-Config header when building an image.
RegistryAuth	authForSwarm() Returns a RegistryAuth object that is valid for a Docker Swarm context [i.e.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MultiRegistryAuthSupplier

public MultiRegistryAuthSupplier(List<RegistryAuthSupplier> suppliers)

Method Detail

authFor

public RegistryAuth authFor(String imageName)
                     throws DockerException

Description copied from interface: RegistryAuthSupplier

Returns a RegistryAuth object that works with a given registry's API [e.g. GCR].

Specified by:

authFor in interface RegistryAuthSupplier

Returns:

the RegistryAuth to use when working with the image, or else null if no authentication info applies for this image

Throws:

DockerException

authForSwarm

public RegistryAuth authForSwarm()
                          throws DockerException

Description copied from interface: RegistryAuthSupplier

Returns a RegistryAuth object that is valid for a Docker Swarm context [i.e. not tied to specific image]. It's unnecessary if it's not planned to use this AuthSupplier to pull images for Swarm.

Specified by:

authForSwarm in interface RegistryAuthSupplier

Returns:

the RegistryAuth to use in Swarn, or else null for no authentication info

Throws:

DockerException

authForBuild

public RegistryConfigs authForBuild()
                             throws DockerException

Description copied from interface: RegistryAuthSupplier

Authentication info to pass in the X-Registry-Config header when building an image.

Specified by:

authForBuild in interface RegistryAuthSupplier

Throws:

DockerException