hudson.scm

Class SSCMUtils

java.lang.Object

hudson.scm.SSCMUtils

public class SSCMUtils
extends Object

Class for common, shared methods used to make the Surround SCM integration function.

Constructor Summary

Constructors

Constructor and Description
SSCMUtils()

Method Summary

Modifier and Type	Method and Description
static List<? extends com.cloudbees.plugins.credentials.common.StandardUsernameCredentials>	availableCredentials(hudson.model.Job<?,?> owner, String source) Uses the CredentialsProvider to lookup StandardUsernameCredentials which will be used to populate the username // password dropdown box.
static List<? extends org.jenkinsci.plugins.plaincredentials.FileCredentials>	availableFileCredentials(hudson.model.Job<?,?> owner, String source) Uses the CredentialsProvider to lookup FileCredentials which will be used to populate the username // password dropdown box.
static hudson.util.ListBoxModel	doFillCredentialsIdItems(hudson.model.Item context, String remote) This populates the Username//Password credential dropdown on the config page.
static hudson.util.ListBoxModel	doFillCredentialsItems(hudson.model.Item context, String remote, Class credentialType)
static hudson.util.ListBoxModel	doFillRsaKeyFileIdItems(hudson.model.Item context, String remote) This populates the rsaKeyFileId dropdown with a list of 'FileCredentials' that could be used.
static String	getBranchFromURL(String URL) Parses the Surround SCM Server port from the pased in sscm:// url.
static com.cloudbees.plugins.credentials.common.StandardUsernameCredentials	getCredentials(hudson.model.Job<?,?> owner, hudson.EnvVars env, String server, String port, String credentialsId) Looks up a specific credential based on the credential ID.
static org.jenkinsci.plugins.plaincredentials.FileCredentials	getFileCredentials(hudson.model.Job<?,?> owner, hudson.EnvVars env, String server, String port, RSAKey rsaKey) Looks up a specific file credential based on its ID.
static String	getPortFromURL(String URL) Parses the Surround SCM Server port from the pased in sscm:// url.
static String	getRepositoryFromURL(String URL) Parses the Surround SCM Server port from the pased in sscm:// url.
static String	getServerFromURL(String URL) Parses the Surround SCM Server host name from the passed in sscm:// url.
static boolean	validateSSCMURL(String URL) Performs basic sscm:// url validation by attempting to match it to the URI_PATTERN variable.
static hudson.model.Node	workspaceToNode(hudson.FilePath workspace) Helper function which finds the 'Node' for a provided 'workspace'

Methods inherited from class java.lang.Object

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

Constructor Detail

SSCMUtils

public SSCMUtils()

Method Detail

getServerFromURL

public static String getServerFromURL(String URL)

Parses the Surround SCM Server host name from the passed in sscm:// url. ex. sscm://server:4900//branch//Mainline/Path/To/Repository

Parameters:

URL - ex. sscm://server:4900//branch//Mainline/Path/To/Repository

Returns:

Returns server

getPortFromURL

public static String getPortFromURL(String URL)

Parses the Surround SCM Server port from the pased in sscm:// url. ex. sscm://server:4900//branch//Mainline/Path/To/Repository

Parameters:

URL - ex. sscm://server:4900//branch//Mainline/Path/To/Repository

Returns:

returns the port (ex. 4900)

getBranchFromURL

public static String getBranchFromURL(String URL)

Parses the Surround SCM Server port from the pased in sscm:// url. ex. sscm://server:4900//branch//Mainline/Path/To/Repository

Parameters:

URL - ex. sscm://server:4900//branch//Mainline/Path/To/Repository

Returns:

returns the port (ex. 4900)

getRepositoryFromURL

public static String getRepositoryFromURL(String URL)

Parses the Surround SCM Server port from the pased in sscm:// url. ex. sscm://server:4900//branch//Mainline/Path/To/Repository

Parameters:

URL - ex. sscm://server:4900//branch//Mainline/Path/To/Repository

Returns:

returns the port (ex. 4900)

validateSSCMURL

public static boolean validateSSCMURL(String URL)

Performs basic sscm:// url validation by attempting to match it to the URI_PATTERN variable.

Parameters:

URL - URL to test to see if it is valid.

Returns:

Returns true if the URL is valid, false if not.

workspaceToNode

public static hudson.model.Node workspaceToNode(hudson.FilePath workspace)

Helper function which finds the 'Node' for a provided 'workspace'

Parameters:

workspace - A 'workspace' that was provided by Jenkins

Returns:

The 'Node' that the workspace exists on. Defaults to the primary Jenkins instance.

doFillCredentialsItems

public static hudson.util.ListBoxModel doFillCredentialsItems(@AncestorInPath
                                                              hudson.model.Item context,
                                                              @QueryParameter
                                                              String remote,
                                                              @Nonnull
                                                              Class credentialType)

Parameters:

context - - Context

remote - - Remote path

credentialType - - Type of credentials

Returns:

- Returns a properly populated listbox based on the current context

doFillCredentialsIdItems

public static hudson.util.ListBoxModel doFillCredentialsIdItems(@AncestorInPath
                                                                hudson.model.Item context,
                                                                @QueryParameter
                                                                String remote)

This populates the Username//Password credential dropdown on the config page.

Parameters:

context - - Owner

remote - - Source

Returns:

Returns a list of credentials to populate the combobox with.

doFillRsaKeyFileIdItems

public static hudson.util.ListBoxModel doFillRsaKeyFileIdItems(@AncestorInPath
                                                               hudson.model.Item context,
                                                               @QueryParameter
                                                               String remote)

This populates the rsaKeyFileId dropdown with a list of 'FileCredentials' that could be used.

Parameters:

context - - Owner

remote - - Source

Returns:

Returns a list of FileCredential objects that have been configured.

availableCredentials

public static List<? extends com.cloudbees.plugins.credentials.common.StandardUsernameCredentials> availableCredentials(hudson.model.Job<?,?> owner,
                                                                                                                        String source)

Uses the CredentialsProvider to lookup StandardUsernameCredentials which will be used to populate the username // password dropdown box.

Parameters:

owner - Job that this is being performed for

source - A.... source?

Returns:

Returns a list of StandardUsernameCredentials which can be thrown into a StandardUsernameListBoxModel

availableFileCredentials

public static List<? extends org.jenkinsci.plugins.plaincredentials.FileCredentials> availableFileCredentials(hudson.model.Job<?,?> owner,
                                                                                                              String source)

Uses the CredentialsProvider to lookup FileCredentials which will be used to populate the username // password dropdown box.

Parameters:

owner - A.... Jobish object?

source - A.... source?

Returns:

Returns a list of FileCredentials which can be thrown into a StandardListBoxModel

getCredentials

@CheckForNull
public static com.cloudbees.plugins.credentials.common.StandardUsernameCredentials getCredentials(hudson.model.Job<?,?> owner,
                                                                                                                 hudson.EnvVars env,
                                                                                                                 String server,
                                                                                                                 String port,
                                                                                                                 String credentialsId)

Looks up a specific credential based on the credential ID.

Parameters:

owner - Used during credential lookup from the CredentialProvider

env - Used to generate a 'Source' string

server - Used to generate the source string

port - Used to generate the source string

credentialsId - ID string of the credential to lookup.

Returns:

Returns the StandardUsernameCredentials matching the specified credentialsID, or null

getFileCredentials

@CheckForNull
public static org.jenkinsci.plugins.plaincredentials.FileCredentials getFileCredentials(hudson.model.Job<?,?> owner,
                                                                                                       hudson.EnvVars env,
                                                                                                       String server,
                                                                                                       String port,
                                                                                                       RSAKey rsaKey)

Looks up a specific file credential based on its ID.

Parameters:

owner - Used during credential lookup from the CredentialProvider

env - Used to generate a 'Source' string

server - Used to generate the source string

port - Used to generate the source string

rsaKey - This will only work if this is an rsaKey with a RSAKey.Type of "ID"

Returns:

Returns the fileCredential specified in the RSAKey 'value', or null