Package io.jenkins.plugins.remote.result.trigger.auth2

Class CredentialsAuth

java.lang.Object
hudson.model.AbstractDescribableImpl<Auth2>
io.jenkins.plugins.remote.result.trigger.auth2.Auth2
io.jenkins.plugins.remote.result.trigger.auth2.CredentialsAuth
All Implemented Interfaces:
Describable<Auth2>, Serializable, Cloneable
public class CredentialsAuth extends Auth2
Author:
HW
See Also:

  • Field Details

  • Constructor Details

    • CredentialsAuth

      @DataBoundConstructor public CredentialsAuth()

  • Method Details

    • setCredentialsId

      @DataBoundSetter public void setCredentialsId(String credentialsId)

    • getCredentialsId

      public String getCredentialsId()

    • getUserName

      public String getUserName(Item item) throws CredentialsNotFoundException
      Tries to find the Jenkins Credential and returns the user name.
      Parameters:
      item - the Item (Job, Pipeline,...) we are currently running in. The item is required to also get Credentials which are defined in the items scope and not Jenkins globally. Value can be null, but Credentials e.g. configured on a Folder will not be found in this case, only globally configured Credentials.
      Returns:
      The user name configured in this Credential
      Throws:
      CredentialsNotFoundException - if credential could not be found.

    • getPassword

      public String getPassword(Item item) throws CredentialsNotFoundException
      Tries to find the Jenkins Credential and returns the password.
      Parameters:
      item - the Item (Job, Pipeline,...) we are currently running in. The item is required to also get Credentials which are defined in the items scope and not Jenkins globally. Value can be null, but Credentials e.g. configured on a Folder will not be found in this case, only globally configured Credentials.
      Returns:
      The password configured in this Credential
      Throws:
      CredentialsNotFoundException - if credential could not be found.

    • getCredentials

      public String getCredentials(Item item) throws CredentialsNotFoundException
      Get JenkinsClient Credentials
      Specified by:
      getCredentials in class Auth2
      Parameters:
      item - item
      Returns:
      Credentials
      Throws:
      CredentialsNotFoundException

    • toString

      public String toString()
      Specified by:
      toString in class Auth2

    • toString

      public String toString(Item item)
      Description copied from class: Auth2
      Returns a string representing the authorization.
      Specified by:
      toString in class Auth2
      Parameters:
      item - the Item (Job, Pipeline,...) we are currently running in. The item is required to also get Credentials which are defined in the items scope and not Jenkins globally. Value can be null, but Credentials e.g. configured on a Folder will not be found in this case, only globally configured Credentials.
      Returns:
      a string representing the authorization.

    • getDescriptor

      public Auth2.Auth2Descriptor getDescriptor()
      Specified by:
      getDescriptor in interface Describable<Auth2>
      Overrides:
      getDescriptor in class AbstractDescribableImpl<Auth2>

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object