Package org.xwiki.filemanager.job

Class PackRequest

java.lang.Object

org.xwiki.job.AbstractRequest

org.xwiki.filemanager.job.BatchPathRequest

org.xwiki.filemanager.job.PackRequest

All Implemented Interfaces:

Serializable, org.xwiki.job.Request

@Unstable
public class PackRequest
extends BatchPathRequest

Request used by PackJob to pack multiple files and folders (including the child files and sub-folders) in a single ZIP archive.

Since:

2.0M2

Version:

$Id$

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	PROPERTY_OUTPUT_FILE_REFERENCE

Fields inherited from class org.xwiki.filemanager.job.BatchPathRequest

PROPERTY_PATHS

Fields inherited from interface org.xwiki.job.Request

PROPERTY_CONTEXT, PROPERTY_INTERACTIVE, PROPERTY_REMOTE

Constructor Summary

Constructors

Constructor	Description
PackRequest()

Method Summary

Modifier and Type	Method	Description
org.xwiki.model.reference.AttachmentReference	getOutputFileReference()
void	setOutputFileReference(org.xwiki.model.reference.AttachmentReference outputFileReference)	Sets the reference to the output ZIP file that will pack the files and folders specified by BatchPathRequest.getPaths().

Methods inherited from class org.xwiki.filemanager.job.BatchPathRequest

getPaths, setPaths

Methods inherited from class org.xwiki.job.AbstractRequest

containsProperty, equals, getContext, getId, getProperties, getProperty, getProperty, getPropertyNames, hashCode, isInteractive, isRemote, isStatusLogIsolated, isStatusSerialized, isVerbose, removeProperty, setContext, setId, setId, setId, setInteractive, setProperty, setRemote, setStatusLogIsolated, setStatusSerialized, setVerbose

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_OUTPUT_FILE_REFERENCE

public static final String PROPERTY_OUTPUT_FILE_REFERENCE

See Also:

getOutputFileReference(), Constant Field Values

Constructor Detail

PackRequest

public PackRequest()

Method Detail

getOutputFileReference

public org.xwiki.model.reference.AttachmentReference getOutputFileReference()

Returns:

the reference to the output ZIP file that contains the files and folders specified by BatchPathRequest.getPaths()

setOutputFileReference

public void setOutputFileReference(org.xwiki.model.reference.AttachmentReference outputFileReference)

Sets the reference to the output ZIP file that will pack the files and folders specified by BatchPathRequest.getPaths().

The DocumentReference part of the given AttachmentReference represents the document that is going to be used to access the output ZIP file. This means that only users with view right on this document can access the output file. The name property of the given AttachmentReference will be used as the name of the output ZIP file.

The output file is a temporary file (deleted automatically when the server is stopped) that can be accessed as a temporary resource.

Parameters:

outputFileReference - the reference to the output ZIP file