com.google.jenkins.plugins.source

Class GoogleRobotUsernamePassword

java.lang.Object

com.cloudbees.plugins.credentials.BaseCredentials

com.cloudbees.plugins.credentials.impl.BaseStandardCredentials

com.google.jenkins.plugins.source.GoogleRobotUsernamePassword

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=GoogleRobotUsernamePassword.NameProvider.class,
          priority=99)
public class GoogleRobotUsernamePassword
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 for use with a SCM.

BACKGROUND: For Cloud projects with a private repository, Google accepts a username/password combination that is truly email/oauth-refresh-token. For service accounts, for which a refresh token may not be readily available (e.g. with Compute Engine's metadata service) it also supports using: email/oauth-access-token.

This credential wraps a service account credential to provide it in this manner as a StandardUsernamePasswordCredentials for usage with the new Credentials-aware SCM plugins.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GoogleRobotUsernamePassword.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	GoogleRobotUsernamePassword.NameProvider Provide a name that the user will understand, in the dropdown shown by SCMs.

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
GoogleRobotUsernamePassword(String credentialsId, GoogleRobotUsernamePasswordModule module) Constructs a username and password credential wrapper around the existing credential, specified by credentialsId.

Method Summary

Modifier and Type	Method and Description
com.google.jenkins.plugins.credentials.oauth.GoogleRobotCredentials	getCredentials() Retrieve our wrapped credentials based on the above ID we store.
String	getCredentialsId() Return the unique ID of the inner GoogleRobotCredentials that this Username/Password proxy is wrapping.
String	getDescription()
com.cloudbees.plugins.credentials.CredentialsDescriptor	getDescriptor()
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 "code.google.com" and "source.developers.google.com" hosted repositories, for which we require "https".

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

GoogleRobotUsernamePassword

@DataBoundConstructor
public GoogleRobotUsernamePassword(String credentialsId,
                                                         @Nullable
                                                         GoogleRobotUsernamePasswordModule module)

Constructs a username and password credential wrapper around the existing credential, specified by credentialsId.

Method Detail

matches

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

This type of credentials only works for authenticating against "code.google.com" and "source.developers.google.com" hosted repositories, for which we require "https".

Specified by:

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

getCredentialsId

public String getCredentialsId()

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

getCredentials

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

Retrieve our wrapped credentials based on the above ID we store.

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 com.cloudbees.plugins.credentials.CredentialsDescriptor 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