Package hudson.scm.subversion

Class WorkspaceUpdater.UpdateTask

java.lang.Object

hudson.scm.subversion.WorkspaceUpdater.UpdateTask

All Implemented Interfaces:

Serializable, org.jenkinsci.remoting.SerializableOnlyOverRemoting

Direct Known Subclasses:

NoopUpdater.TaskImpl, UpdateUpdater.TaskImpl

Enclosing class:

WorkspaceUpdater

public abstract static class WorkspaceUpdater.UpdateTask
extends Object
implements org.jenkinsci.remoting.SerializableOnlyOverRemoting

This object gets instantiated on the controller and then sent to the agent via remoting, then used to perform the actual checkout activity.

A number of contextual objects are defined as fields, to be used by the perform() method. These fields are set by SubversionSCM before the invocation.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
org.tmatesoft.svn.core.auth.ISVNAuthenticationProvider	authProvider	Encapusulates the authentication.
SvnClientManager	clientManager	Factory for various subversion commands.
TaskListener	listener	Connected to build console.
SubversionSCM.ModuleLocation	location	Modules to check out.
org.tmatesoft.svn.core.wc.SVNClientManager	manager	Deprecated. as of 1.40 Use clientManager
boolean	quietOperation	--quiet for subversion operations.
RevisionParameterAction	revisions	If the build parameter is specified with specific version numbers, this field captures that.
Date	timestamp	In the absence of a revision-specific check out, we want to check out by this timestamp, not just the latest to ensure consistency.
File	ws	Build workspace.

Constructor Summary

Constructors

Constructor	Description
UpdateTask()

Method Summary

Modifier and Type	Method	Description
protected List<SubversionSCM.External>	delegateTo(WorkspaceUpdater.UpdateTask t)
protected final List<SubversionSCM.External>	delegateTo(WorkspaceUpdater wu, int workspaceFormat)	Delegates the execution to another updater.
protected org.tmatesoft.svn.core.wc.SVNRevision	getRevision(SubversionSCM.ModuleLocation l)	Determines the revision to check out for the given location.
protected static org.tmatesoft.svn.core.SVNDepth	getSvnDepth(String name)	Deprecated. as of 2.10 Use SubversionSCM.ModuleLocation.getSVNDepthFor* functions to correctly interpret module location depth options or SVNDepth.fromString directly if you've taken the depth from another source.
abstract List<SubversionSCM.External>	perform()	Performs the checkout/update.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jenkinsci.remoting.SerializableOnlyOverRemoting

getChannelForSerialization

Field Details

manager

public org.tmatesoft.svn.core.wc.SVNClientManager manager

Deprecated.

as of 1.40 Use clientManager

clientManager

public SvnClientManager clientManager

Factory for various subversion commands.

authProvider

public org.tmatesoft.svn.core.auth.ISVNAuthenticationProvider authProvider

Encapusulates the authentication. Connected back to Jenkins controller. Never null.

timestamp

public Date timestamp

In the absence of a revision-specific check out, we want to check out by this timestamp, not just the latest to ensure consistency. Never null.

listener

public TaskListener listener

Connected to build console. Never null.

location

public SubversionSCM.ModuleLocation location

Modules to check out. Never null.

ws

public File ws

Build workspace. Never null.

quietOperation

public boolean quietOperation

--quiet for subversion operations. Default = false.

revisions

public RevisionParameterAction revisions

If the build parameter is specified with specific version numbers, this field captures that. Can be null.

Constructor Details

UpdateTask

public UpdateTask()

Method Details

perform

public abstract List<SubversionSCM.External> perform()
                                              throws IOException,
InterruptedException

Performs the checkout/update.

Use the fields defined in this class that defines the parameters of the check out.

Returns:

Where svn:external mounting happened. Can be empty but never null.

Throws:

IOException

InterruptedException

delegateTo

protected List<SubversionSCM.External> delegateTo(WorkspaceUpdater.UpdateTask t)
                                           throws IOException,
InterruptedException

Throws:

IOException

InterruptedException

delegateTo

protected final List<SubversionSCM.External> delegateTo(WorkspaceUpdater wu,
 int workspaceFormat)
                                                 throws IOException,
InterruptedException

Delegates the execution to another updater. This is most often useful to fall back to the fresh check out by using CheckoutUpdater.

Throws:

IOException

InterruptedException

getRevision

protected org.tmatesoft.svn.core.wc.SVNRevision getRevision(SubversionSCM.ModuleLocation l)

Determines the revision to check out for the given location.

getSvnDepth

@Deprecated
protected static org.tmatesoft.svn.core.SVNDepth getSvnDepth(String name)

Deprecated.

as of 2.10 Use SubversionSCM.ModuleLocation.getSVNDepthFor* functions to correctly interpret module location depth options or SVNDepth.fromString directly if you've taken the depth from another source.

Returns SVNDepth by string value.

Returns:

SVNDepth value.