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

@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.
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.StandardUsernamePasswordCredentials	getLoginInformation(hudson.model.Item project, String credentialsId) Retrieves login information given a credentials identifier.
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.
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, 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

getLoginInformation

public com.cloudbees.plugins.credentials.common.StandardUsernamePasswordCredentials getLoginInformation(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:

credentials with login information