net.praqma.jenkins.configrotator.scm.clearcaseucm

Class ClearCaseUCM

java.lang.Object

net.praqma.jenkins.configrotator.AbstractConfigurationRotatorSCM

net.praqma.jenkins.configrotator.scm.clearcaseucm.ClearCaseUCM

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<AbstractConfigurationRotatorSCM>, Serializable

public class ClearCaseUCM
extends AbstractConfigurationRotatorSCM
implements Serializable

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClearCaseUCM.DescriptorImpl
class	ClearCaseUCM.UCMChangeLogWriter
class	ClearCaseUCM.UCMPerformer

Nested classes/interfaces inherited from class net.praqma.jenkins.configrotator.AbstractConfigurationRotatorSCM

AbstractConfigurationRotatorSCM.ChangeLogWriter<C extends AbstractConfigurationComponent,T extends AbstractConfiguration<C>>, AbstractConfigurationRotatorSCM.Performer<C>, AbstractConfigurationRotatorSCM.Poller<C extends AbstractConfiguration>

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field and Description
List<ClearCaseUCMTarget>	targets

Fields inherited from class net.praqma.jenkins.configrotator.AbstractConfigurationRotatorSCM

projectConfiguration

Constructor Summary

Constructors

Constructor and Description
ClearCaseUCM(net.praqma.clearcase.PVob pvob)
ClearCaseUCM(String pvobName)

Method Summary

Methods

Modifier and Type	Method and Description
ConfigRotatorChangeLogParser	createChangeLogParser()
net.praqma.clearcase.ucm.view.SnapshotView	createView(hudson.model.TaskListener listener, hudson.model.AbstractBuild<?,?> build, ClearCaseUCMConfiguration configuration, hudson.FilePath workspace, net.praqma.clearcase.PVob pvob)
AbstractConfigurationRotatorSCM.ChangeLogWriter	getChangeLogWriter(File changeLogFile, hudson.model.BuildListener listener, hudson.model.AbstractBuild<?,?> build)
List<ClearCaseUCMTarget>	getCompareTargets(hudson.model.AbstractProject<?,?> project)
String	getName() Return the name of the type
AbstractConfigurationRotatorSCM.Performer<ClearCaseUCMConfiguration>	getPerform(hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.FilePath workspace, hudson.model.BuildListener listener) Perform the actual config rotation
AbstractConfigurationRotatorSCM.Poller	getPoller(hudson.model.AbstractProject<?,?> project, hudson.Launcher launcher, hudson.FilePath workspace, hudson.model.TaskListener listener)
String	getPvobName()
List<ClearCaseUCMTarget>	getTargets() Get the configuration as targets.
AbstractConfiguration	nextConfiguration(hudson.model.TaskListener listener, AbstractConfiguration configuration, hudson.FilePath workspace) nextConfiguration is used to indicate if a new configuration exists.
void	printConfiguration(PrintStream out, AbstractConfiguration cfg)
void	reconfigure(hudson.FilePath workspace, hudson.model.TaskListener listener) Reconfigure the project configuration given the targets from the configuration page
void	setConfigurationByAction(hudson.model.AbstractProject<?,?> project, ConfigurationRotatorBuildAction action)
<TT extends AbstractTarget> void	setTargets(List<TT> targets)
void	simpleCheckOfConfiguration(AbstractConfiguration cfg) Does a simple check of the config-rotator configuration.
boolean	wasReconfigured(hudson.model.AbstractProject<?,?> project) This method only makes sense when the variable justConfigured is set.

Methods inherited from class net.praqma.jenkins.configrotator.AbstractConfigurationRotatorSCM

all, getConfiguration, getDescriptor, getDescriptors, getFeedPath, getFeedURL, getLastDieAction, getLastResult, getLastResults, getPreviousResult, setConfiguration

Methods inherited from class java.lang.Object

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

Field Detail

targets

public List<ClearCaseUCMTarget> targets

Constructor Detail

ClearCaseUCM

public ClearCaseUCM(net.praqma.clearcase.PVob pvob)

ClearCaseUCM

@DataBoundConstructor
public ClearCaseUCM(String pvobName)

Method Detail

getPvobName

public String getPvobName()

getName

public String getName()

Description copied from class: AbstractConfigurationRotatorSCM

Return the name of the type

Specified by:

getName in class AbstractConfigurationRotatorSCM

createChangeLogParser

public ConfigRotatorChangeLogParser createChangeLogParser()

Specified by:

createChangeLogParser in class AbstractConfigurationRotatorSCM

getCompareTargets

public List<ClearCaseUCMTarget> getCompareTargets(hudson.model.AbstractProject<?,?> project)

wasReconfigured

public boolean wasReconfigured(hudson.model.AbstractProject<?,?> project)

Description copied from class: AbstractConfigurationRotatorSCM

This method only makes sense when the variable justConfigured is set. Meaning the configuration was just saved.

Specified by:

wasReconfigured in class AbstractConfigurationRotatorSCM

Returns:

getPoller

public AbstractConfigurationRotatorSCM.Poller getPoller(hudson.model.AbstractProject<?,?> project,
                                               hudson.Launcher launcher,
                                               hudson.FilePath workspace,
                                               hudson.model.TaskListener listener)

Specified by:

getPoller in class AbstractConfigurationRotatorSCM

Parameters:

project -

launcher -

workspace -

listener -

Returns:

a poller for the scm.

getPerform

public AbstractConfigurationRotatorSCM.Performer<ClearCaseUCMConfiguration> getPerform(hudson.model.AbstractBuild<?,?> build,
                                                                              hudson.Launcher launcher,
                                                                              hudson.FilePath workspace,
                                                                              hudson.model.BuildListener listener)
                                                                                throws IOException

Description copied from class: AbstractConfigurationRotatorSCM

Perform the actual config rotation

Specified by:

getPerform in class AbstractConfigurationRotatorSCM

Returns:

Throws:

IOException

reconfigure

public void reconfigure(hudson.FilePath workspace,
               hudson.model.TaskListener listener)
                 throws IOException

Reconfigure the project configuration given the targets from the configuration page

Parameters:

workspace - A FilePath

listener - A TaskListener

Throws:

IOException

printConfiguration

public void printConfiguration(PrintStream out,
                      AbstractConfiguration cfg)

Overrides:

printConfiguration in class AbstractConfigurationRotatorSCM

simpleCheckOfConfiguration

public void simpleCheckOfConfiguration(AbstractConfiguration cfg)
                                throws ConfigurationRotatorException

Does a simple check of the config-rotator configuration. We do implicitly assume the configuration can be loaded and clear case objects exists. The checks is done only with regards to configuration rotation, eg. not using the same component twice. 1) is a Clear Case UCM component used more than once in the configuration?

Parameters:

cfg - config rotator configuration

Throws:

hudson.AbortException

ConfigurationRotatorException

nextConfiguration

public AbstractConfiguration nextConfiguration(hudson.model.TaskListener listener,
                                      AbstractConfiguration configuration,
                                      hudson.FilePath workspace)
                                        throws ConfigurationRotatorException

nextConfiguration is used to indicate if a new configuration exists. Essentially the 'poll' operation.

Specified by:

nextConfiguration in class AbstractConfigurationRotatorSCM

Parameters:

listener -

configuration -

workspace -

Returns:

A new configuration when there are SCM changes, null when no changes.

Throws:

ConfigurationRotatorException

createView

public net.praqma.clearcase.ucm.view.SnapshotView createView(hudson.model.TaskListener listener,
                                                    hudson.model.AbstractBuild<?,?> build,
                                                    ClearCaseUCMConfiguration configuration,
                                                    hudson.FilePath workspace,
                                                    net.praqma.clearcase.PVob pvob)
                                                      throws IOException,
                                                             InterruptedException

Throws:

IOException

InterruptedException

setTargets

public <TT extends AbstractTarget> void setTargets(List<TT> targets)

Specified by:

setTargets in class AbstractConfigurationRotatorSCM

getTargets

public List<ClearCaseUCMTarget> getTargets()

Get the configuration as targets. If the project configuration is null, the last targets defined by the configuration page is returned otherwise the current project configuration is returned as targets

Specified by:

getTargets in class AbstractConfigurationRotatorSCM

Returns:

A list of targets

setConfigurationByAction

public void setConfigurationByAction(hudson.model.AbstractProject<?,?> project,
                            ConfigurationRotatorBuildAction action)
                              throws IOException

Specified by:

setConfigurationByAction in class AbstractConfigurationRotatorSCM

Throws:

IOException

getChangeLogWriter

public AbstractConfigurationRotatorSCM.ChangeLogWriter getChangeLogWriter(File changeLogFile,
                                                                 hudson.model.BuildListener listener,
                                                                 hudson.model.AbstractBuild<?,?> build)

Specified by:

getChangeLogWriter in class AbstractConfigurationRotatorSCM

Returns:

Change log writer