hudson.scm
Class IntegrityCheckoutTask

java.lang.Object
  hudson.scm.IntegrityCheckoutTask

All Implemented Interfaces:

hudson.FilePath.FileCallable<Boolean>, Serializable

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

See Also:

Serialized Form

Constructor Summary

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

Method Summary

APISession	createAPISession() Creates an authenticated API Session against the Integrity Server
Hashtable<String,String>	getChecksumUpdates() Returns all the changes to the checksums that were performed
void	initAPIVariables(String ipHostName, int ipPort, String hostName, int port, boolean secure, String userName, String password) Helper function to initialize all the variables needed to establish an APISession
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,
                             hudson.model.BuildListener listener)

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

listener - The Hudson build listener

Method Detail

initAPIVariables

public void initAPIVariables(String ipHostName,
                             int ipPort,
                             String hostName,
                             int port,
                             boolean secure,
                             String userName,
                             String password)

Helper function to initialize all the variables needed to establish an APISession

Parameters:

ipHostName - Integration Point Hostname

ipPort - Integration Point Port

hostName - Integrity Server Hostname

port - Integrity Server Port

secure - Toggles whether Integrity Server is SSL enabled

userName - Username to connect to the Integrity Server

password - Password for the Username connection to the Integrity Server

createAPISession

public APISession createAPISession()

Creates an authenticated API Session against the Integrity Server

Returns:

An authenticated API Session

getChecksumUpdates

public Hashtable<String,String> getChecksumUpdates()

Returns all the changes to the checksums that were performed

Returns:

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