io.fabric8.maven.docker.util

Class AuthConfigFactory

java.lang.Object

io.fabric8.maven.docker.util.AuthConfigFactory

public class AuthConfigFactory
extends Object

Factory for creating docker specific authentication configuration

Since:

29.07.14

Author:

roland

Field Summary

Fields

Modifier and Type	Field and Description
static String[]	DEFAULT_REGISTRIES

Constructor Summary

Constructors

Constructor and Description
AuthConfigFactory(org.codehaus.plexus.PlexusContainer container) Constructor which should be used during startup phase of a plugin

Method Summary

Modifier and Type

Method and Description

AuthConfig

createAuthConfig(boolean isPush, Map authConfigMap, org.apache.maven.settings.Settings settings, String user, String registry) Create an authentication config object which can be used for communication with a Docker registry The authentication information is looked up at various places (in this order): From system properties From the provided map which can contain key-value pairs From the Maven settings stored typically in ~/.m2/settings.xml The following properties (prefix with 'docker.') and config key are evaluated: username: User to authenticate password: Password to authenticate.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_REGISTRIES

public static final String[] DEFAULT_REGISTRIES

Constructor Detail

AuthConfigFactory

public AuthConfigFactory(org.codehaus.plexus.PlexusContainer container)

Constructor which should be used during startup phase of a plugin

Parameters:

container - the container used for do decrytion of passwords

Method Detail

createAuthConfig

public AuthConfig createAuthConfig(boolean isPush,
                                   Map authConfigMap,
                                   org.apache.maven.settings.Settings settings,
                                   String user,
                                   String registry)
                            throws org.apache.maven.plugin.MojoExecutionException

Create an authentication config object which can be used for communication with a Docker registry The authentication information is looked up at various places (in this order):

• From system properties
• From the provided map which can contain key-value pairs
• From the Maven settings stored typically in ~/.m2/settings.xml

The following properties (prefix with 'docker.') and config key are evaluated:

• username: User to authenticate
• password: Password to authenticate. Can be encrypted
• email: Optional EMail address which is send to the registry, too

Parameters:

isPush - if true this authconfig is created for a push, if false its for a pull

authConfigMap - String-String Map holding configuration info from the plugin's configuration. Can be null in which case the settings are consulted.

settings - the global Maven settings object

user - user to check for

registry - registry to use, might be null in which case a default registry is checked,

Returns:

the authentication configuration or null if none could be found

Throws:

org.apache.maven.plugin.MojoFailureException

org.apache.maven.plugin.MojoExecutionException