Package jenkins.plugins.itemstorage

Class ObjectPath

java.lang.Object

jenkins.plugins.itemstorage.ObjectPath

Direct Known Subclasses:

LocalObjectPath, S3ObjectPath

public abstract class ObjectPath
extends Object

The abstraction to interact with a particular object path

Author:

Peter Hayes

Constructor Summary

Constructors

Constructor	Description
ObjectPath()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

ObjectPath

public ObjectPath()

Method Detail

child

public abstract ObjectPath child(String path)
                          throws IOException,
                                 InterruptedException

Get a relative child path of this ObjectPath

Parameters:

path - The relative path

Returns:

The child instance

Throws:

IOException

InterruptedException

copyTo

public abstract void copyTo(FilePath target)
                     throws IOException,
                            InterruptedException

Throws:

IOException

InterruptedException

copyFrom

public abstract void copyFrom(FilePath source)
                       throws IOException,
                              InterruptedException

Throws:

IOException

InterruptedException

exists

public abstract boolean exists()
                        throws IOException,
                               InterruptedException

Check if this path actually exists

Returns:

true if so, false otherwise

Throws:

IOException

InterruptedException

deleteRecursive

public abstract void deleteRecursive()
                              throws IOException,
                                     InterruptedException

Recursively delete all contents within the path

Throws:

IOException

InterruptedException

browse

public abstract org.kohsuke.stapler.HttpResponse browse(org.kohsuke.stapler.StaplerRequest request,
                                                        org.kohsuke.stapler.StaplerResponse response,
                                                        Job<?,?> job,
                                                        String name)
                                                 throws IOException

Support browsing the cache via UI

Parameters:

job -

Returns:

Throws:

IOException