org.mandas.docker.client.auth.RegistryAuthSupplier Maven / Gradle / Ivy
/*-
* -\-\-
* docker-client
* --
* Copyright (C) 2016 Spotify AB
* Copyright (C) 9/2019 - 2020 Dimitris Mandalidis
* --
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
* -/-/-
*/
package org.mandas.docker.client.auth;
import org.mandas.docker.client.exceptions.DockerException;
import org.mandas.docker.client.messages.RegistryAuth;
import org.mandas.docker.client.messages.RegistryConfigs;
public interface RegistryAuthSupplier {
/**
* Returns a RegistryAuth object that works with a given registry's API [e.g. GCR].
* @param imageName
*
* @return the RegistryAuth to use when working with the image, or else {@code null} if no
* authentication info applies for this image
* @throws DockerException
*/
RegistryAuth authFor(String imageName) throws DockerException;
/**
* 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.
*
* @return the RegistryAuth to use in Swarn, or else {@code null} for no authentication info
* @throws DockerException
*/
RegistryAuth authForSwarm() throws DockerException;
/** Authentication info to pass in the X-Registry-Config header when building an image.
* @return the registry configs
* @throws DockerException */
RegistryConfigs authForBuild() throws DockerException;
}