UploadPackageJobResource (Admin Tools (Pro) - API 1.3-rc-2 API)

java.lang.Object
- com.xwiki.admintools.uploadPackageJob.UploadPackageJobResource

@Unstable
public class UploadPackageJobResource
extends Object

Store data for package upload job process.

Since:: 1.1
Version:: $Id$

Constructor Summary

Constructors
Constructor Description

UploadPackageJobResource()
Default constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`File`	`getBackupFile()`	The original file backup created before the uploading process began.
`String`	`getNewFilename()`	Get the new file name.
`File`	`getTargetFile()`	Retrieves the file that serves as the target for the update process.
`void`	`setBackupFile(File backupFile)`	See `getBackupFile()`.
`void`	`setNewFilename(String newFilename)`	See `getNewFilename()`.
`void`	`setTargetFile(File targetFile)`	See `getTargetFile()`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - UploadPackageJobResource
```
public UploadPackageJobResource()
```
    Default constructor.
- Method Detail
  - getBackupFile
```
public File getBackupFile()
```
    The original file backup created before the uploading process began. Useful when restoring a failed upload process. Will be null if the target file does not replace any files.
    
    Returns:
    
    the original file backup.
  - setBackupFile
```
public void setBackupFile(File backupFile)
```
    See getBackupFile().
    
    Parameters:
    
    backupFile - the original file backup.
  - getTargetFile
```
public File getTargetFile()
```
    Retrieves the file that serves as the target for the update process. If a file already exists at the intended location, this will return the original file. If no file exists at the location, this will return the new file being uploaded.
    
    Returns:
    
    the target file for the update process.
  - setTargetFile
```
public void setTargetFile(File targetFile)
```
    See getTargetFile().
    
    Parameters:
    
    targetFile - the update target file.
  - getNewFilename
```
public String getNewFilename()
```
    Get the new file name.
    
    Returns:
    
    the name of the new file.
  - setNewFilename
```
public void setNewFilename(String newFilename)
```
    See getNewFilename().
    
    Parameters:
    
    newFilename - the name of the new file.