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

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 final Auth2.Auth2Descriptor	DESCRIPTOR

Constructor Summary

Constructors

Constructor	Description
TokenAuth()

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
String	getCredentials(Item item)	Get JenkinsClient Credentials Or ApiToken
Auth2.Auth2Descriptor	getDescriptor()
int	hashCode()
void	setApiToken(Secret apiToken)
void	setUserName(String userName)
String	toString()
String	toString(Item item)	Returns a string representing the authorization.

Methods inherited from class io.jenkins.plugins.remote.result.trigger.auth2.Auth2

all, clone

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

DESCRIPTOR

@Extension
public static final Auth2.Auth2Descriptor DESCRIPTOR

Constructor Details

TokenAuth

@DataBoundConstructor
public TokenAuth()

Method Details

setUserName

@DataBoundSetter
public void setUserName(String userName)

setApiToken

@DataBoundSetter
public void setApiToken(Secret apiToken)

getCredentials

public String getCredentials(Item item)
                      throws CredentialsNotFoundException

Get JenkinsClient Credentials Or ApiToken

Specified by:

getCredentials in class Auth2

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