Package jenkins.slaves

Class WorkspaceLocator

java.lang.Object

jenkins.slaves.WorkspaceLocator

All Implemented Interfaces:

ExtensionPoint

public abstract class WorkspaceLocator
extends Object
implements ExtensionPoint

Allow extensions to override workspace locations on given agents or projects.

Since:

1.501

Author:

ryan.campbell@gmail.com

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
WorkspaceLocator()

Method Summary

Modifier and Type	Method	Description
static ExtensionList<WorkspaceLocator>	all()	All registered WorkspaceLocators.
abstract FilePath	locate(TopLevelItem item, Node node)	Allows extensions to customize the workspace path.

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkspaceLocator

public WorkspaceLocator()

Method Detail

locate

public abstract FilePath locate(TopLevelItem item,
                                Node node)

Allows extensions to customize the workspace path. The first non-null response will determine the path to the workspace on that agent.

Parameters:

item - The toplevel item

node - The agent node

Returns:

The absolute FilePath to the workspace on the agent. Will be created if it doesn't exist.

all

public static ExtensionList<WorkspaceLocator> all()

All registered WorkspaceLocators.