com.compuware.jenkins.common.configuration

Class CpwrGlobalConfiguration

java.lang.Object

hudson.model.Descriptor<jenkins.model.GlobalConfiguration>

jenkins.model.GlobalConfiguration

com.compuware.jenkins.common.configuration.CpwrGlobalConfiguration

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<jenkins.model.GlobalConfiguration>, hudson.model.Saveable, jenkins.util.io.OnMaster

@Extension
public class CpwrGlobalConfiguration
extends jenkins.model.GlobalConfiguration

Class to handle Compuware global configuration settings.

Nested Class Summary

Nested classes/interfaces inherited from class hudson.model.Descriptor

hudson.model.Descriptor.FormException, hudson.model.Descriptor.PropertyType, hudson.model.Descriptor.Self

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	m_needsSaving

Fields inherited from class hudson.model.Descriptor

clazz

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor and Description
CpwrGlobalConfiguration() Constructor.

Method Summary

Modifier and Type	Method and Description
void	addHostConnection(HostConnection connection) Adds the given host connection to the list of host connections.
boolean	configure(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject json)
hudson.util.ListBoxModel	doFillCodePageItems() Fills in the Code page selection box with code pages.
hudson.util.ListBoxModel	doFillProtocolItems() Fills in the encryption protocol selection box with encryption protocols.
static CpwrGlobalConfiguration	get() Returns the singleton instance.
hudson.util.ArgumentListBuilder	getArgumentBuilder(String scriptFileArg, String cliVersion, hudson.model.Item project, String credentialsId, String connectionId) Get an argument list builder for the common arguments.
String	getCertificateString(com.cloudbees.plugins.credentials.common.StandardCertificateCredentials credentials)
String	getCredentialsUser(com.cloudbees.plugins.credentials.common.StandardCredentials credentials) Get the user identified by the given credentials.
HostConnection	getHostConnection(String connectionId) Returns a host connection for the given connection identifier.
HostConnection	getHostConnection(String hostPort, String codePage) Returns a host connection for a given host:port and code page, if one exists.
HostConnection[]	getHostConnections() Returns the list of host connections.
com.cloudbees.plugins.credentials.common.StandardCredentials	getLoginCredentials(hudson.model.Item project, String credentialsId) Retrieves login information given a credentials identifier.
String	getSubjectDN(X509Certificate x509Certificate) Get the subject distinguished name from the specified certificate.
String	getTopazCLILocation(hudson.Launcher launcher) Returns the Topaz Workbench CLI location based on node.
String	getTopazCLILocationLinux() Returns the value of the topazCLILocationLinux field.
String	getTopazCLILocationWindows() Returns the value of the topazCLILocationLinux.
X509Certificate	getX509Certificate(com.cloudbees.plugins.credentials.common.StandardCertificateCredentials credentials)
static void	jobLoaded() Perform initialization after all jobs have been loaded.
boolean	needsSaving() Return TRUE if the configuration needs saving.
void	setHostConnections(HostConnection... connections) Sets the list of host connections.
void	setTopazCLILocationLinux(String location) Sets the Topaz CLI installation location for Linux systems.
void	setTopazCLILocationWindows(String location) Sets the Topaz CLI installation location for Windows systems.

Methods inherited from class jenkins.model.GlobalConfiguration

all, getDescriptor, getGlobalConfigPage

Methods inherited from class hudson.model.Descriptor

addHelpFileRedirect, calcAutoCompleteSettings, calcFillSettings, configure, doHelp, find, find, findByDescribableClassName, findById, getCategory, getCheckMethod, getCheckUrl, getConfigFile, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getDisplayName, getGlobalPropertyType, getHelpFile, getHelpFile, getHelpFile, getId, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getPropertyTypeOrDie, getRequiredGlobalConfigPagePermission, getT, getViewPage, isInstance, isSubTypeOf, load, newInstance, newInstance, newInstancesFromHeteroList, newInstancesFromHeteroList, save, self, toArray, toList, toMap

Methods inherited from class java.lang.Object

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

Field Detail

m_needsSaving

protected transient boolean m_needsSaving

Constructor Detail

CpwrGlobalConfiguration

public CpwrGlobalConfiguration()

Constructor.

Clients should not call this - use get() instead.

Method Detail

get

public static CpwrGlobalConfiguration get()

Returns the singleton instance.

Returns:

the Jenkins managed singleton for the configuration object

needsSaving

public boolean needsSaving()

Return TRUE if the configuration needs saving.

Returns:

TRUE if the configuration needs saving.

jobLoaded

@Initializer(after=JOB_LOADED)
public static void jobLoaded()

Perform initialization after all jobs have been loaded.

getHostConnections

public HostConnection[] getHostConnections()

Returns the list of host connections.

Returns:

list of host connections

getHostConnection

public HostConnection getHostConnection(String connectionId)

Returns a host connection for the given connection identifier.

Parameters:

connectionId - a unique connection identifier

Returns:

a HostConnection; can be null

setHostConnections

public void setHostConnections(HostConnection... connections)

Sets the list of host connections.

Parameters:

connections - one or more host connections

getHostConnection

public HostConnection getHostConnection(String hostPort,
                                        String codePage)

Returns a host connection for a given host:port and code page, if one exists.

Parameters:

hostPort - the host and port in the form of 'host:port'

codePage - the code page

Returns:

a host connection; can be null

addHostConnection

public void addHostConnection(HostConnection connection)

Adds the given host connection to the list of host connections.

Parameters:

connection - connection to add

configure

public boolean configure(org.kohsuke.stapler.StaplerRequest req,
                         net.sf.json.JSONObject json)

Overrides:

configure in class jenkins.model.GlobalConfiguration

doFillProtocolItems

public hudson.util.ListBoxModel doFillProtocolItems()

Fills in the encryption protocol selection box with encryption protocols.

Returns:

encryption protocol selections

doFillCodePageItems

public hudson.util.ListBoxModel doFillCodePageItems()

Fills in the Code page selection box with code pages.

Returns:

code page selections

getTopazCLILocation

public String getTopazCLILocation(hudson.Launcher launcher)

Returns the Topaz Workbench CLI location based on node.

Parameters:

launcher - launcher for starting a process

Returns:

the CLI location

getTopazCLILocationWindows

public String getTopazCLILocationWindows()

Returns the value of the topazCLILocationLinux. Used for databinding.

Returns:

CLI location - Windows

getTopazCLILocationLinux

public String getTopazCLILocationLinux()

Returns the value of the topazCLILocationLinux field. Used for databinding.

Returns:

CLI location - Linux

setTopazCLILocationWindows

public void setTopazCLILocationWindows(String location)

Sets the Topaz CLI installation location for Windows systems.

Parameters:

location - the install directory

setTopazCLILocationLinux

public void setTopazCLILocationLinux(String location)

Sets the Topaz CLI installation location for Linux systems.

Parameters:

location - the install directory

getLoginCredentials

public com.cloudbees.plugins.credentials.common.StandardCredentials getLoginCredentials(hudson.model.Item project,
                                                                                        String credentialsId)

Retrieves login information given a credentials identifier.

Parameters:

project - the Jenkins project

credentialsId - the String identifier of the credentials to obtain

Returns:

StandardCredentials object contains the credentials with login information this object can be of type UsernamePasswordCredentialsImpl or CertificateCredentialsImpl.

getCredentialsUser

public String getCredentialsUser(com.cloudbees.plugins.credentials.common.StandardCredentials credentials)
                          throws hudson.AbortException

Get the user identified by the given credentials.

Parameters:

credentials - a Jenkins StandardCredentials instance

Returns:

String containing the user identified by the credentials

Throws:

hudson.AbortException - if there is a problem with the credentials

getSubjectDN

public String getSubjectDN(X509Certificate x509Certificate)

Get the subject distinguished name from the specified certificate.

Parameters:

x509Certificate - The instance of X509Certificate from which the subject distinguished name is to be returned.

Returns:

The subject distinguished name or null if the name could not be retrieved

getX509Certificate

public X509Certificate getX509Certificate(com.cloudbees.plugins.credentials.common.StandardCertificateCredentials credentials)
                                   throws KeyStoreException

Parameters:

credentials - An instance of StandardCertificateCredentials.

Returns:

a string of Base64 encoded representation of the X509Certificate. if we found this certificate in certificateChain using the keystore null is return if no X509Certificate founded.

Throws:

KeyStoreException - ~ unable to find an X509Certificate from a StandardCertificateCredentials

getCertificateString

public String getCertificateString(com.cloudbees.plugins.credentials.common.StandardCertificateCredentials credentials)
                            throws KeyStoreException,
                                   CertificateEncodingException

Parameters:

credentials - An instance of StandardCertificateCredentials.

Returns:

a string of Base64 encoded representation of the X509Certificate. if we found this certificate in certificateChain using the keystore null is return if no X509Certificate founded.

Throws:

KeyStoreException - ~ unable to create an encoded certifcate string from a StandardCertificateCredentials

CertificateEncodingException - ~ unable to encode a certifcate obtained from a StandardCertificateCredentials

getArgumentBuilder

public hudson.util.ArgumentListBuilder getArgumentBuilder(String scriptFileArg,
                                                          String cliVersion,
                                                          hudson.model.Item project,
                                                          String credentialsId,
                                                          String connectionId)
                                                   throws hudson.AbortException

Get an argument list builder for the common arguments.

Parameters:

scriptFileArg - the name of the application script used to start the CLI

cliVersion - the CLI version for testing compatibility

project - the jenkins project

credentialsId - the identifier of credentials to use

connectionId - the identifier of the host connection to use

Returns:

a new argument list builder initialized with common arguments

Throws:

hudson.AbortException - if unable to initialize the argument builder