hudson.scm

Class IntegrityCheckoutTask

java.lang.Object

hudson.scm.IntegrityCheckoutTask

All Implemented Interfaces:

hudson.FilePath.FileCallable<Boolean>, Serializable, org.jenkinsci.remoting.RoleSensitive

public class IntegrityCheckoutTask
extends Object
implements hudson.FilePath.FileCallable<Boolean>

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description

IntegrityCheckoutTask(List<Hashtable<CM_PROJECT,Object>> projectMembersList, List<String> dirList, String alternateWorkspaceDir, String lineTerminator, boolean restoreTimestamp, boolean cleanCopy, boolean fetchChangedWorkspaceFiles, int checkoutThreadPoolSize, int checkoutThreadTimeout, hudson.model.TaskListener listener, IntegrityConfigurable integrityConfig) Hudson supports building on distributed machines, and the SCM plugin must be able to be executed on other machines than the master.

Method Summary

Modifier and Type	Method and Description
void	checkRoles(org.jenkinsci.remoting.RoleChecker checker) Indicates that this task can be run slaves.
ConcurrentHashMap<String,String>	getChecksumUpdates() Returns all the changes to the checksums that were performed
Boolean	invoke(File workspaceFile, hudson.remoting.VirtualChannel channel) This task wraps around the code necessary to checkout Integrity CM Members on remote machines

Methods inherited from class java.lang.Object

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

Constructor Detail

IntegrityCheckoutTask

public IntegrityCheckoutTask(List<Hashtable<CM_PROJECT,Object>> projectMembersList,
                             List<String> dirList,
                             String alternateWorkspaceDir,
                             String lineTerminator,
                             boolean restoreTimestamp,
                             boolean cleanCopy,
                             boolean fetchChangedWorkspaceFiles,
                             int checkoutThreadPoolSize,
                             int checkoutThreadTimeout,
                             hudson.model.TaskListener listener,
                             IntegrityConfigurable integrityConfig)

Hudson supports building on distributed machines, and the SCM plugin must be able to be executed on other machines than the master.

Parameters:

projectMembersList - A list of all the members that are in this Integrity SCM project

dirList - A list of all the unique directories in this Integrity SCM project

alternateWorkspaceDir - Specifies an alternate location for checkout other than the default workspace

lineTerminator - The line termination setting for this checkout operation

restoreTimestamp - Toggles whether to use the current date/time or the original date/time for the member

cleanCopy - Indicates whether or not the workspace needs to be cleaned up prior to checking out files

fetchChangedWorkspaceFiles - Toggles whether or not to calculate checksums, so if changed then it will be overwritten

checkoutThreadPoolSize - Number of parallel threads for the checkout

checkoutThreadTimeout - Timeout in minutes per checkout thread

listener - The Hudson task listener

integrityConfig - Integrity Configuration Object

Method Detail

getChecksumUpdates

public ConcurrentHashMap<String,String> getChecksumUpdates()

Returns all the changes to the checksums that were performed

Returns:

checkRoles

public void checkRoles(org.jenkinsci.remoting.RoleChecker checker)
                throws SecurityException

Indicates that this task can be run slaves.

Specified by:

checkRoles in interface org.jenkinsci.remoting.RoleSensitive

Parameters:

checker - RoleChecker

Throws:

SecurityException

invoke

public Boolean invoke(File workspaceFile,
                      hudson.remoting.VirtualChannel channel)
               throws IOException

This task wraps around the code necessary to checkout Integrity CM Members on remote machines

Specified by:

invoke in interface hudson.FilePath.FileCallable<Boolean>

Throws:

IOException