jenkins.plugins.hipchat.utils

Class CredentialUtils

java.lang.Object

jenkins.plugins.hipchat.utils.CredentialUtils

@Singleton
public class CredentialUtils
extends Object

This class is here to help with credential related tasks, such as credential lookup and migration of insecurely stored credentials.

Constructor Summary

Constructors

Constructor and Description
CredentialUtils()

Method Summary

Methods

Modifier and Type	Method and Description
hudson.util.ListBoxModel	getAvailableCredentials(hudson.model.Item item, String globalCredentialId, String server) Retrieves the UI model object containing all acceptable credentials.
void	migrateGlobalCredential(HipChatNotifier.DescriptorImpl descriptor) Migrates the credential stored in global config from the old insecure format to the Credential system.
void	migrateJobCredential(HipChatNotifier.DescriptorImpl descriptor, hudson.model.Item item, HipChatNotifier notifier) Migrates the credential stored in a job config from the old insecure format to the Credential system.
org.jenkinsci.plugins.plaincredentials.StringCredentials	resolveCredential(hudson.model.Item context, String credentialId, String server) Finds the credential with the given credentialId in the CredentialStore.

Methods inherited from class java.lang.Object

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

Constructor Detail

CredentialUtils

public CredentialUtils()

Method Detail

resolveCredential

public org.jenkinsci.plugins.plaincredentials.StringCredentials resolveCredential(hudson.model.Item context,
                                                                         @CheckForNull
                                                                         String credentialId,
                                                                         String server)

Finds the credential with the given credentialId in the CredentialStore.

Parameters:

context - The context (job) to be used to find the right credential.

credentialId - The ID of the credential.

server - The URL to the HipChat server to ensure that we find the credential under the right security domain.

Returns:

The found credential, or null if the credential cannot be found.

getAvailableCredentials

public hudson.util.ListBoxModel getAvailableCredentials(@CheckForNull
                                               hudson.model.Item item,
                                               String globalCredentialId,
                                               String server)

Retrieves the UI model object containing all acceptable credentials. This method can operate in two modes essentially:

• When item is null: in this case the credentials will be looked up globally. In this case the assumption is that we are displaying the credential dropdown on the global config page.
• When item is not null: in this case the credentials will be looked up within the context of the job. In this case the assumption is that we are displaying the credential dropdown on the job config page.

Parameters:

item - The context (job) to use to find the the credentials. May be null. In job config mode, the current value of the credential setting will be extracted from this item.

globalCredentialId - In global config mode, use this as the currently selected credential.

server - The URL to the HipChat server to ensure that we find the credentials under the right security domain.

Returns:

The UI model containing all matching credentials, or only the current selection if the user does not have the right set of permissions.

migrateGlobalCredential

public void migrateGlobalCredential(HipChatNotifier.DescriptorImpl descriptor)
                             throws IOException

Migrates the credential stored in global config from the old insecure format to the Credential system.

Parameters:

descriptor - The descriptor of this plugin.

Throws:

IOException - If there was an error whilst migrating the credential.

migrateJobCredential

public void migrateJobCredential(HipChatNotifier.DescriptorImpl descriptor,
                        hudson.model.Item item,
                        HipChatNotifier notifier)
                          throws IOException

Migrates the credential stored in a job config from the old insecure format to the Credential system.

Parameters:

descriptor - The descriptor of this plugin.

item - The job where the plugin is configured.

notifier - The plugin instance corresponding to this job.

Throws:

IOException - If there was an error whilst migrating the credential.