|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjenkins.plugins.shiningpanda.workspace.Workspace
public abstract class Workspace
Field Summary | |
---|---|
static String |
BASENAME
Base name of the workspace under the node. |
protected static String |
BOOTSTRAP
Name of the BUILDOUT bootstrap module. |
static String |
PACKAGES
Base name of the folder containing the packages. |
protected static String |
VIRTUALENV
Name of the VIRTUALENV module. |
Constructor Summary | |
---|---|
Workspace(hudson.FilePath home)
Constructor using fields. |
Method Summary | |
---|---|
protected void |
delete()
Delete this workspace without throwing exceptions on error. |
static void |
delete(hudson.model.Item item)
Clean item related workspaces. |
static void |
delete(hudson.model.Item item,
String name)
Clean item related workspaces. |
static Workspace |
fromBuild(hudson.model.AbstractBuild<?,?> build)
Create a workspace from the build. |
static Workspace |
fromHome(hudson.FilePath home)
Create the workspace from its home folder. |
static Workspace |
fromNode(hudson.model.Node node,
hudson.model.AbstractProject<?,?> project,
String name)
Create a workspace from the node and the project. |
static Workspace |
fromProject(hudson.model.Project<?,?> project,
String name)
Get a workspace from a project. |
abstract hudson.FilePath |
getBootstrapPy()
Get the BUILDOUT bootstrap module file on executor. |
hudson.FilePath |
getBuildoutHome(String name)
Get the VIRTUALENV home dedicated to BUILDOUT for the provided PYTHON installation name. |
hudson.FilePath |
getHome()
Get the home folder of this workspace. |
hudson.FilePath |
getMasterBootstrapPy()
Get the BUILDOUT bootstrap file on master. |
hudson.FilePath |
getMasterPackagesDir()
Get the folder on master where user can put some packages to avoid downloads when creating a VIRTUALENV. |
hudson.FilePath |
getMasterVirtualenvPy()
Get the VIRTUALENV module file on master. |
abstract hudson.FilePath |
getPackagesDir()
Get the folder on executor containing the packages provided by user to avoid downloads when creating a VIRTUALENV. |
hudson.FilePath |
getToolsHome()
Get the VIRTUALENV home for this workspace, where TOX (or other tools) can be installed for instance. |
hudson.FilePath |
getVirtualenvHome(String name)
Get the VIRTUALENV home for the provided VIRTUALENV name. |
abstract hudson.FilePath |
getVirtualenvPy()
Get the VIRTUALENV module file on executor. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static String BASENAME
public static String PACKAGES
protected static String VIRTUALENV
protected static String BOOTSTRAP
Constructor Detail |
---|
public Workspace(hudson.FilePath home)
home
- The home folder of the workspace.Method Detail |
---|
public hudson.FilePath getHome()
public hudson.FilePath getMasterVirtualenvPy()
public abstract hudson.FilePath getVirtualenvPy() throws IOException, InterruptedException
IOException
InterruptedException
public hudson.FilePath getMasterBootstrapPy()
public abstract hudson.FilePath getBootstrapPy() throws IOException, InterruptedException
IOException
InterruptedException
public hudson.FilePath getMasterPackagesDir() throws IOException, InterruptedException
IOException
InterruptedException
public abstract hudson.FilePath getPackagesDir() throws IOException, InterruptedException
IOException
InterruptedException
public hudson.FilePath getToolsHome()
public hudson.FilePath getVirtualenvHome(String name)
name
- The name of the VIRTUALENV
public hudson.FilePath getBuildoutHome(String name)
name
- The name of the PYTHON installation
protected void delete()
public static Workspace fromHome(hudson.FilePath home)
home
- The home folder
public static Workspace fromBuild(hudson.model.AbstractBuild<?,?> build)
build
- The build
public static Workspace fromProject(hudson.model.Project<?,?> project, String name)
project
- The projectname
- Base name used to compute the workspace location. If null then
use the name of the project
public static Workspace fromNode(hudson.model.Node node, hudson.model.AbstractProject<?,?> project, String name)
node
- The nodeproject
- The projectname
- Base name used to compute the workspace location. If null then
use the name of the project
public static void delete(hudson.model.Item item)
item
- The itempublic static void delete(hudson.model.Item item, String name)
item
- The itemname
- The name to use to compute the workspace location
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |