dev.galasa.docker.internal.properties.DockerRegistryCredentials Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dev.galasa.docker.manager Show documentation

A Galasa project

The newest version!

/*
 * Copyright contributors to the Galasa project
 *
 * SPDX-License-Identifier: EPL-2.0
 */
package dev.galasa.docker.internal.properties;

import dev.galasa.docker.DockerManagerException;
import dev.galasa.docker.internal.DockerRegistryImpl;
import dev.galasa.framework.spi.ConfigurationPropertyStoreException;
import dev.galasa.framework.spi.cps.CpsProperties;

/**
 * Docker Registry Credentials CPS Property
 * 
 * @galasa.cps.property
 * 
 * @galasa.name docker.registry.[ID.]credentials
 * 
 * @galasa.description Provides the credentials of a Docker Registry that is used by the Docker Manager
 * 
 * @galasa.required Yes if the registry requires authentication. 
 * 
 * @galasa.default DOCKER
 * 
 * @galasa.valid_values A valid credentials ID.
 * 
 * @galasa.examples 
 * docker.registry.LOCAL.credentials=CREDSID
 * 
 * @galasa.extra
 * If the docker.registry.ID.credentials CPS property is missing, the Docker Manager will attempt to use
 * the credentials ID that is provided in docker.registry.credentials, if that is missing, then the default credentials 
 * ID of DOCKER will be used.
 * 
 */
public class DockerRegistryCredentials extends CpsProperties {

    public static String get(DockerRegistryImpl dockerRegistry) throws DockerManagerException {
        try {
            String credentialsKey = getStringNulled(DockerPropertiesSingleton.cps(), "registry", "credentials", dockerRegistry.getId());
            //Default value
            if (credentialsKey == null) {
                return "DOCKER";
            }

            return credentialsKey;
        } catch (ConfigurationPropertyStoreException e) {
            throw new DockerManagerException("Failed to access the CPS to find the credential");
        } 
    }
}