com.compuware.jenkins.scm

Class IspwContainerConfiguration

java.lang.Object

hudson.scm.SCM

com.compuware.jenkins.scm.AbstractConfiguration

com.compuware.jenkins.scm.AbstractIspwConfiguration

com.compuware.jenkins.scm.IspwContainerConfiguration

All Implemented Interfaces:

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

public class IspwContainerConfiguration
extends AbstractIspwConfiguration

Captures the configuration information for a ISPW SCM.

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class com.compuware.jenkins.scm.AbstractConfiguration

AbstractConfiguration.AbstractConfigurationImpl<T extends hudson.scm.SCM>

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
IspwContainerConfiguration(String connectionId, String credentialsId, String serverConfig, String containerName, String containerType, String serverLevel, String componentType, boolean ispwDownloadAll, String targetFolder, boolean ispwDownloadIncl, boolean cpCategorizeOnComponentType, boolean cpCategorizeOnSubAppl) 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	getContainerName() Gets the value of the 'Container name'
String	getContainerType() Gets the value of the 'Container type'
boolean	getCpCategorizeOnComponentType() Categorize the source files to different folders according to Component Type
boolean	getCpCategorizeOnSubAppl() Categorize the source files to different folders according to Sub Appl
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.
boolean	getIspwDownloadIncl() This field determines whether or not to download the INCL impacts
String	getServerLevel() Gets the value of the 'Level'
String	getTargetFolder() Gets the value of the targetFolder
void	validateFilterParameters(hudson.Launcher launcher, hudson.model.TaskListener listener, hudson.model.Item project) Validates the configuration filter parameters.
void	validateParameters(hudson.Launcher launcher, hudson.model.TaskListener listener, hudson.model.Item project) Validates the configuration parameters
static void	xStreamCompatibility()

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

calcRevisionsFromBuild, checkout, createChangeLogParser, getConnectionId, getCredentialsId, 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

IspwContainerConfiguration

@DataBoundConstructor
public IspwContainerConfiguration(String connectionId,
                                                         String credentialsId,
                                                         String serverConfig,
                                                         String containerName,
                                                         String containerType,
                                                         String serverLevel,
                                                         String componentType,
                                                         boolean ispwDownloadAll,
                                                         String targetFolder,
                                                         boolean ispwDownloadIncl,
                                                         boolean cpCategorizeOnComponentType,
                                                         boolean cpCategorizeOnSubAppl)

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

containerName - - selected ispw container name

containerType - - selected ispw container type (assignment, release...)

serverLevel - - selected ispw level

componentType - - The component type to filter for

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

targetFolder - - source download location

ispwDownloadIncl - - whether to download the INCL impacts

cpCategorizeOnComponentType - - whether to categorize the source files to different folders according to Component Type

Method Detail

getContainerName

public String getContainerName()

Gets the value of the 'Container name'

Returns:

String value of containerName

getContainerType

public String getContainerType()

Gets the value of the 'Container type'

Returns:

String value of containerType

getServerLevel

public String getServerLevel()

Gets the value of the 'Level'

Returns:

String value of serverLevel

getComponentType

public String getComponentType()

Gets the value of the 'Component type'

Returns:

String value of componentType

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

getIspwDownloadIncl

public boolean getIspwDownloadIncl()

This field determines whether or not to download the INCL impacts

Returns:

the ispwDownloadAll

getCpCategorizeOnComponentType

public boolean getCpCategorizeOnComponentType()

Categorize the source files to different folders according to Component Type

Returns:

true if categorize on component type

getCpCategorizeOnSubAppl

public boolean getCpCategorizeOnSubAppl()

Categorize the source files to different folders according to Sub Appl

Returns:

true if categorize on sub appl

validateParameters

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

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

Throws:

hudson.AbortException - if an error occurs validating the parameters

validateFilterParameters

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

Validates the configuration filter 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

xStreamCompatibility

@Initializer(before=PLUGINS_STARTED)
public static void xStreamCompatibility()