Package jenkins.plugins.itemstorage.local

Class LocalObjectPath

java.lang.Object

jenkins.plugins.itemstorage.ObjectPath

jenkins.plugins.itemstorage.local.LocalObjectPath

public class LocalObjectPath
extends ObjectPath

This implements the on-controller storage for object paths.

Author:

Peter Hayes

Constructor Summary

Constructors

Constructor	Description
LocalObjectPath(FilePath file)

Method Summary

Modifier and Type	Method	Description
org.kohsuke.stapler.HttpResponse	browse(org.kohsuke.stapler.StaplerRequest2 request, org.kohsuke.stapler.StaplerResponse2 response, Job<?,?> job, String name)	Support browsing the cache via UI
ObjectPath	child(String path)	Get a relative child path of this ObjectPath
void	copyFrom(FilePath source)
void	copyTo(FilePath target)
void	deleteRecursive()	Recursively delete all contents within the path
boolean	exists()	Check if this path actually exists
protected String	getPath()

Methods inherited from class java.lang.Object

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

Constructor Details

LocalObjectPath

public LocalObjectPath(FilePath file)

Method Details

child

public ObjectPath child(String path)
                 throws IOException,
InterruptedException

Description copied from class: ObjectPath

Get a relative child path of this ObjectPath

Specified by:

child in class ObjectPath

Parameters:

path - The relative path

Returns:

The child instance

Throws:

IOException

InterruptedException

copyTo

public void copyTo(FilePath target)
            throws IOException,
InterruptedException

Specified by:

copyTo in class ObjectPath

Throws:

IOException

InterruptedException

copyFrom

public void copyFrom(FilePath source)
              throws IOException,
InterruptedException

Specified by:

copyFrom in class ObjectPath

Throws:

IOException

InterruptedException

exists

public boolean exists()
               throws IOException,
InterruptedException

Description copied from class: ObjectPath

Check if this path actually exists

Specified by:

exists in class ObjectPath

Returns:

true if so, false otherwise

Throws:

IOException

InterruptedException

deleteRecursive

public void deleteRecursive()
                     throws IOException,
InterruptedException

Description copied from class: ObjectPath

Recursively delete all contents within the path

Specified by:

deleteRecursive in class ObjectPath

Throws:

IOException

InterruptedException

browse

public org.kohsuke.stapler.HttpResponse browse(org.kohsuke.stapler.StaplerRequest2 request,
 org.kohsuke.stapler.StaplerResponse2 response,
 Job<?,?> job,
 String name)

Description copied from class: ObjectPath

Support browsing the cache via UI

Specified by:

browse in class ObjectPath

Returns:

getPath

protected String getPath()