Class TokenAuth
- java.lang.Object
-
- hudson.model.AbstractDescribableImpl<Auth2>
-
- io.jenkins.plugins.remote.result.trigger.auth2.Auth2
-
- io.jenkins.plugins.remote.result.trigger.auth2.TokenAuth
-
- All Implemented Interfaces:
Describable<Auth2>
,Serializable
,Cloneable
public class TokenAuth extends Auth2
- Author:
- HW
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
TokenAuth.TokenAuthDescriptor
-
Nested classes/interfaces inherited from class io.jenkins.plugins.remote.result.trigger.auth2.Auth2
Auth2.Auth2Descriptor
-
-
Field Summary
Fields Modifier and Type Field Description static Auth2.Auth2Descriptor
DESCRIPTOR
-
Constructor Summary
Constructors Constructor Description TokenAuth()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(Object obj)
Secret
getApiToken()
String
getCredentials(Item item)
Get JenkinsClient Credentials Or ApiTokenAuth2.Auth2Descriptor
getDescriptor()
String
getUserName()
int
hashCode()
void
setApiToken(Secret apiToken)
void
setUserName(String userName)
String
toString()
String
toString(Item item)
Returns a string representing the authorization.
-
-
-
Field Detail
-
DESCRIPTOR
@Extension public static final Auth2.Auth2Descriptor DESCRIPTOR
-
-
Method Detail
-
setUserName
@DataBoundSetter public void setUserName(String userName)
-
getUserName
public String getUserName()
-
setApiToken
@DataBoundSetter public void setApiToken(Secret apiToken)
-
getApiToken
public Secret getApiToken()
-
getCredentials
public String getCredentials(Item item) throws CredentialsNotFoundException
Get JenkinsClient Credentials Or ApiToken- Specified by:
getCredentials
in classAuth2
- Throws:
CredentialsNotFoundException
-
toString
public String toString(Item item)
Description copied from class:Auth2
Returns a string representing the authorization.- Specified by:
toString
in classAuth2
- 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 interfaceDescribable<Auth2>
- Overrides:
getDescriptor
in classAbstractDescribableImpl<Auth2>
-
-