com.google.cloud.tools.jib.registry

Class RegistryAuthenticator

java.lang.Object

com.google.cloud.tools.jib.registry.RegistryAuthenticator

public class RegistryAuthenticator
extends Object

Authenticates push/pull access with a registry service.

See Also:

https://docs.docker.com/registry/spec/auth/token/

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RegistryAuthenticator.Initializer Initializer for RegistryAuthenticator.

Method Summary

Modifier and Type	Method and Description
Authorization	authenticatePull() Authenticates permissions to pull.
Authorization	authenticatePush() Authenticates permission to pull and push.
static RegistryAuthenticator.Initializer	initializer(JibLogger buildLogger, String serverUrl, String repository) Gets a new initializer for RegistryAuthenticator.
RegistryAuthenticator	setAuthorization(Authorization authorization) Sets an Authorization header to authenticate with.

Methods inherited from class java.lang.Object

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

Method Detail

initializer

public static RegistryAuthenticator.Initializer initializer(JibLogger buildLogger,
                                                            String serverUrl,
                                                            String repository)

Gets a new initializer for RegistryAuthenticator.

Parameters:

buildLogger - the build logger used for printing messages

serverUrl - the server URL for the registry (for example, gcr.io)

repository - the image/repository name (also known as, namespace)

Returns:

the new RegistryAuthenticator.Initializer

setAuthorization

public RegistryAuthenticator setAuthorization(@Nullable
                                              Authorization authorization)

Sets an Authorization header to authenticate with.

Parameters:

authorization - the authorization header

Returns:

this

authenticatePull

public Authorization authenticatePull()
                               throws RegistryAuthenticationFailedException

Authenticates permissions to pull.

Returns:

an Authorization authenticating the pull

Throws:

RegistryAuthenticationFailedException - if authentication fails

authenticatePush

public Authorization authenticatePush()
                               throws RegistryAuthenticationFailedException

Authenticates permission to pull and push.

Returns:

an Authorization authenticating the push

Throws:

RegistryAuthenticationFailedException - if authentication fails