jenkins.security

Class ApiTokenProperty

java.lang.Object

hudson.model.UserProperty

jenkins.security.ApiTokenProperty

All Implemented Interfaces:

ExtensionPoint, Describable<UserProperty>, ReconfigurableDescribable<UserProperty>

public class ApiTokenProperty
extends UserProperty

Remembers the API token for this user, that can be used like a password to login.

Since:

1.426

Author:

Kohsuke Kawaguchi

See Also:

ApiTokenFilter

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ApiTokenProperty.DescriptorImpl

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class hudson.model.UserProperty

user

Constructor Summary

Constructors

Constructor and Description
ApiTokenProperty()

Method Summary

Modifier and Type	Method and Description
void	changeApiToken()
String	getApiToken() Gets the API token.
boolean	matchesPassword(String password)
UserProperty	reconfigure(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject form) When a parent/owner object of a Describable gets a config form submission and instances are recreated, this method is invoked on the existing instance (meaning the 'this' reference points to the existing instance) to create a new instance to be added to the parent/owner object.

Methods inherited from class hudson.model.UserProperty

all, getDescriptor

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiTokenProperty

@DataBoundConstructor
public ApiTokenProperty()

Method Detail

getApiToken

@Nonnull
public String getApiToken()

Gets the API token. The method performs security checks. Only the current user and SYSTEM may see it. Users with Jenkins.ADMINISTER may be allowed to do it using SHOW_TOKEN_TO_ADMINS.

Returns:

API Token. Never null, but may be Messages.ApiTokenProperty_ChangeToken_TokenIsHidden() if the user has no appropriate permissions.

Since:

TODO: the method performs security checks

matchesPassword

public boolean matchesPassword(String password)

changeApiToken

public void changeApiToken()
                    throws IOException

Throws:

IOException

reconfigure

public UserProperty reconfigure(org.kohsuke.stapler.StaplerRequest req,
                                net.sf.json.JSONObject form)
                         throws Descriptor.FormException

Description copied from interface: ReconfigurableDescribable

When a parent/owner object of a Describable gets a config form submission and instances are recreated, this method is invoked on the existing instance (meaning the 'this' reference points to the existing instance) to create a new instance to be added to the parent/owner object.

The default implementation of this should be the following:

 return form==null ? null : getDescriptor().newInstance(req, form);
 

Specified by:

reconfigure in interface ReconfigurableDescribable<UserProperty>

Overrides:

reconfigure in class UserProperty

Parameters:

req - The current HTTP request being processed.

form - JSON fragment that corresponds to this describable object. If the newly submitted form doesn't include a fragment for this describable (meaning the user has de-selected your descriptor), then this argument is null.

Returns:

The new instance. To not to create an instance of a describable, return null.

Throws:

Descriptor.FormException