com.compuware.jenkins.scm

Class IspwConfiguration

java.lang.Object

hudson.scm.SCM

com.compuware.jenkins.scm.AbstractConfiguration

com.compuware.jenkins.scm.AbstractIspwConfiguration

com.compuware.jenkins.scm.IspwConfiguration

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<hudson.scm.SCM>

public class IspwConfiguration
extends AbstractIspwConfiguration

Captures the configuration information for a ISPW SCM.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IspwConfiguration.DescriptorImpl DescriptorImpl is used to create instances of IspwConfiguration.

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class com.compuware.jenkins.scm.AbstractConfiguration

m_codePage, m_connectionId, m_hostPort, m_isMigrated

Fields inherited from class hudson.scm.SCM

PERMISSIONS, TAG

Constructor Summary

Constructors

Constructor and Description
IspwConfiguration(String connectionId, String credentialsId, String serverConfig, String serverStream, String serverApplication, String serverLevel, String levelOption, String componentType, String folderName, boolean ispwDownloadAll, String targetFolder) Gets the data from the configuration page.

Method Summary

Modifier and Type	Method and Description
String	getComponentType() Gets the value of the 'Component type'
String	getFilterFiles() Gets the value of the 'Components' checkbox
String	getFilterFolders() Gets the value of the 'Folders' checkbox
String	getFolderName() Gets the value of the 'Folder Name'
boolean	getIspwDownloadAll() This field indicates whether to clear unmatched items from the workspace as well as whether to only download items when the update date has changed.
String	getLevelOption() Gets the value of the 'Level Option'
String	getServerApplication() Gets the value of the 'Application'
String	getServerLevel() Gets the value of the 'Level'
String	getServerStream() Gets the value of the 'Stream'
String	getTargetFolder() Gets the value of the targetFolder
void	validateFilterParameters(hudson.Launcher launcher, hudson.model.TaskListener listener, hudson.model.Item project) Validates the filter configuration parameters.
void	validateParameters(hudson.Launcher launcher, hudson.model.TaskListener listener, hudson.model.Item project) Validates the configuration parameters.

Methods inherited from class com.compuware.jenkins.scm.AbstractIspwConfiguration

calcRevisionsFromBuild, checkout, createChangeLogParser, getConnectionId, getCredentialsId, getLoginInformation, getServerConfig, getTrimmedValue, supportsPolling, validateCliLocation, validateServerParameters

Methods inherited from class com.compuware.jenkins.scm.AbstractConfiguration

isMigrated, jobLoaded, readResolve

Methods inherited from class hudson.scm.SCM

_calcRevisionsFromBuild, _for, _for, all, buildEnvironment, buildEnvVars, calcRevisionsFromBuild, checkout, compareRemoteRevisionWith, compareRemoteRevisionWith, createEmptyChangeLog, createEmptyChangeLog, getApi, getBrowser, getDescriptor, getEffectiveBrowser, getKey, getModuleRoot, getModuleRoot, getModuleRoots, getModuleRoots, getType, guessBrowser, nullify, poll, pollChanges, postCheckout, postCheckout, processWorkspaceBeforeDeletion, processWorkspaceBeforeDeletion, requiresWorkspaceForPolling

Methods inherited from class java.lang.Object

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

Constructor Detail

IspwConfiguration

@DataBoundConstructor
public IspwConfiguration(String connectionId,
                                                String credentialsId,
                                                String serverConfig,
                                                String serverStream,
                                                String serverApplication,
                                                String serverLevel,
                                                String levelOption,
                                                String componentType,
                                                String folderName,
                                                boolean ispwDownloadAll,
                                                String targetFolder)

Gets the data from the configuration page. The parameter names must match the field names set by config.jelly.

Parameters:

connectionId - - a unique host connection identifier

credentialsId - - unique id of the selected credential

serverConfig - - runtime configuration

serverStream - - selected ispw stream

serverApplication - - selected ispw application

serverLevel - - selected ispw level

levelOption - - 0 (all in selected level only) or 1 (all in selected level and above)

componentType - - The component type to filter for

folderName - - comma-delimited folder names to filter on

ispwDownloadAll - - whether to keep files in sync within the specified target Folder

targetFolder - - source download location

Method Detail

getServerStream

public String getServerStream()

Gets the value of the 'Stream'

Returns:

String value of m_serverStream

getServerApplication

public String getServerApplication()

Gets the value of the 'Application'

Returns:

String value of m_serverApplication

getServerLevel

public String getServerLevel()

Gets the value of the 'Level'

Returns:

String value of m_serverLevel

getLevelOption

public String getLevelOption()

Gets the value of the 'Level Option'

Returns:

String value of m_levelOption

getComponentType

public String getComponentType()

Gets the value of the 'Component type'

Returns:

String value of m_componentType

getFolderName

public String getFolderName()

Gets the value of the 'Folder Name'

Returns:

String value of m_folderName

getFilterFiles

public String getFilterFiles()

Gets the value of the 'Components' checkbox

Returns:

String value of m_filterFiles

getFilterFolders

public String getFilterFolders()

Gets the value of the 'Folders' checkbox

Returns:

String value of m_filterFolders

getIspwDownloadAll

public boolean getIspwDownloadAll()

This field indicates whether to clear unmatched items from the workspace as well as whether to only download items when the update date has changed.

Returns:

the ispwDownloadAll

getTargetFolder

public String getTargetFolder()

Gets the value of the targetFolder

Returns:

string containing the targetFolder location

validateParameters

public void validateParameters(hudson.Launcher launcher,
                               hudson.model.TaskListener listener,
                               hudson.model.Item project)

Validates the configuration parameters.

Specified by:

validateParameters in class AbstractIspwConfiguration

Parameters:

launcher - The machine that the files will be checked out.

listener - Build listener

project - the Jenkins project

validateFilterParameters

public void validateFilterParameters(hudson.Launcher launcher,
                                     hudson.model.TaskListener listener,
                                     hudson.model.Item project)

Description copied from class: AbstractIspwConfiguration

Validates the filter configuration parameters.

Specified by:

validateFilterParameters in class AbstractIspwConfiguration

Parameters:

launcher - The machine that the files will be checked out.

listener - Build listener

project - the Jenkins project