com.google.jenkins.plugins.googlecontainerregistryauth

Class GoogleContainerRegistryCredential

java.lang.Object

com.cloudbees.plugins.credentials.BaseCredentials

com.cloudbees.plugins.credentials.impl.BaseStandardCredentials

com.google.jenkins.plugins.googlecontainerregistryauth.GoogleContainerRegistryCredential

All Implemented Interfaces:

com.cloudbees.plugins.credentials.common.IdCredentials, com.cloudbees.plugins.credentials.common.PasswordCredentials, com.cloudbees.plugins.credentials.common.StandardCredentials, com.cloudbees.plugins.credentials.common.StandardUsernameCredentials, com.cloudbees.plugins.credentials.common.StandardUsernamePasswordCredentials, com.cloudbees.plugins.credentials.common.UsernameCredentials, com.cloudbees.plugins.credentials.common.UsernamePasswordCredentials, com.cloudbees.plugins.credentials.Credentials, com.cloudbees.plugins.credentials.domains.DomainRestrictedCredentials, hudson.ExtensionPoint, hudson.model.Describable<com.cloudbees.plugins.credentials.Credentials>, Serializable

@NameWith(value=GoogleContainerRegistryCredential.NameProvider.class,
          priority=99)
public class GoogleContainerRegistryCredential
extends com.cloudbees.plugins.credentials.impl.BaseStandardCredentials
implements com.cloudbees.plugins.credentials.domains.DomainRestrictedCredentials, com.cloudbees.plugins.credentials.common.StandardUsernamePasswordCredentials

This new kind of credential provides an embedded GoogleRobotCredentials as a username and password when a credential for Google Container Registry end point is needed.

BACKGROUND: Google Container Registry accepts a username/password combination that is truly "_token:<oauth_token>". This credential wraps a service account credential to provide it in this manner as a StandardUsernamePasswordCredentials for usage with the new Credentials-aware or DockerRegistryToken -aware plugins.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GoogleContainerRegistryCredential.DescriptorImpl Descriptor class for its global configuration.
static class	GoogleContainerRegistryCredential.EnclosingDomainRequirementProvider We do not have a descriptor, so that we won't show up in the user interface as a credential that can be explicitly created, so we will not be discovered by the DescribableDomainRequirementProvider.
static class	GoogleContainerRegistryCredential.NameProvider Provide a name that the user will understand, in the credential selection drop-down shown by plugins that requires Docker registry credentials.

Nested classes/interfaces inherited from class com.cloudbees.plugins.credentials.impl.BaseStandardCredentials

com.cloudbees.plugins.credentials.impl.BaseStandardCredentials.BaseStandardCredentialsDescriptor

Nested classes/interfaces inherited from interface com.cloudbees.plugins.credentials.common.IdCredentials

com.cloudbees.plugins.credentials.common.IdCredentials.Helpers

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
GoogleContainerRegistryCredential(String credentialsId, GoogleContainerRegistryCredentialModule module)

Method Summary

Modifier and Type	Method and Description
com.google.jenkins.plugins.credentials.oauth.GoogleRobotCredentials	getCredentials()
String	getCredentialsId()
String	getDescription()
GoogleContainerRegistryCredential.DescriptorImpl	getDescriptor()
String	getEmail()
hudson.util.Secret	getPassword()
String	getUsername()
boolean	matches(List<com.cloudbees.plugins.credentials.domains.DomainRequirement> requirements) This type of credentials only works for authenticating against registry's server.

Methods inherited from class com.cloudbees.plugins.credentials.impl.BaseStandardCredentials

equals, getId, hashCode

Methods inherited from class com.cloudbees.plugins.credentials.BaseCredentials

getScope

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.cloudbees.plugins.credentials.common.IdCredentials

getId

Methods inherited from interface com.cloudbees.plugins.credentials.Credentials

getScope

Constructor Detail

GoogleContainerRegistryCredential

@DataBoundConstructor
public GoogleContainerRegistryCredential(String credentialsId,
                                                               @Nullable
                                                               GoogleContainerRegistryCredentialModule module)

Method Detail

getCredentialsId

public String getCredentialsId()

Returns:

the unique ID of the inner GoogleRobotCredentials that this Username/Password proxy is wrapping.

getEmail

public String getEmail()

Returns:

"not@val.id", this is an hard coded value that Google Container Registry expects.

getCredentials

@Nullable
public com.google.jenkins.plugins.credentials.oauth.GoogleRobotCredentials getCredentials()

Returns:

the wrapped credentials based on the ID returned by getCredentialsId()

matches

public boolean matches(List<com.cloudbees.plugins.credentials.domains.DomainRequirement> requirements)

This type of credentials only works for authenticating against registry's server. For production server, it is "gcr.io".

Specified by:

matches in interface com.cloudbees.plugins.credentials.domains.DomainRestrictedCredentials

getDescription

public String getDescription()

Specified by:

getDescription in interface com.cloudbees.plugins.credentials.common.StandardCredentials

Overrides:

getDescription in class com.cloudbees.plugins.credentials.impl.BaseStandardCredentials

getDescriptor

public GoogleContainerRegistryCredential.DescriptorImpl getDescriptor()

Specified by:

getDescriptor in interface com.cloudbees.plugins.credentials.Credentials

Specified by:

getDescriptor in interface hudson.model.Describable<com.cloudbees.plugins.credentials.Credentials>

Overrides:

getDescriptor in class com.cloudbees.plugins.credentials.BaseCredentials

getUsername

public String getUsername()

Specified by:

getUsername in interface com.cloudbees.plugins.credentials.common.UsernameCredentials

getPassword

public hudson.util.Secret getPassword()

Specified by:

getPassword in interface com.cloudbees.plugins.credentials.common.PasswordCredentials