Package com.xwiki.confluencepro

Class ConfluenceMigrationJobRequest

java.lang.Object

org.xwiki.job.AbstractRequest

com.xwiki.confluencepro.ConfluenceMigrationJobRequest

All Implemented Interfaces:

Serializable, org.xwiki.job.Request

public class ConfluenceMigrationJobRequest
extends org.xwiki.job.AbstractRequest

The request used to configure the confluence migration job.

Since:

1.0

Version:

$Id$

See Also:

Serialized Form

Field Summary

Fields inherited from interface org.xwiki.job.Request

PROPERTY_CONTEXT, PROPERTY_INTERACTIVE, PROPERTY_REMOTE

Constructor Summary

Constructors

Constructor	Description
ConfluenceMigrationJobRequest(InputStream confluencePackage, org.xwiki.model.reference.DocumentReference statusDocumentReference, Map<String,Object> inputProperties, Map<String,Object> outputProperties)

Method Summary

Modifier and Type	Method	Description
InputStream	getConfluencePackage()
Map<String,Object>	getInputProperties()
static List<String>	getJobId(org.xwiki.model.reference.DocumentReference statusDocumentReference)
Map<String,Object>	getOutputProperties()
org.xwiki.model.reference.DocumentReference	getStatusDocumentReference()

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

Constructor Detail

ConfluenceMigrationJobRequest

public ConfluenceMigrationJobRequest(InputStream confluencePackage,
                                     org.xwiki.model.reference.DocumentReference statusDocumentReference,
                                     Map<String,Object> inputProperties,
                                     Map<String,Object> outputProperties)

Parameters:

confluencePackage - the input stream of the confluence zip package.

statusDocumentReference - see getStatusDocumentReference().

inputProperties - see getInputProperties().

outputProperties - see getOutputProperties().

Method Detail

getJobId

public static List<String> getJobId(org.xwiki.model.reference.DocumentReference statusDocumentReference)

Parameters:

statusDocumentReference - the migration document for which to get the job id

Returns:

the job id of a migration document

getConfluencePackage

public InputStream getConfluencePackage()

Returns:

the InputStream of the confluence package that will be used for the migration.

getStatusDocumentReference

public org.xwiki.model.reference.DocumentReference getStatusDocumentReference()

Returns:

the reference to the document where this job was started.

getInputProperties

public Map<String,Object> getInputProperties()

Returns:

the input properties for the confluence filter stream.

getOutputProperties

public Map<String,Object> getOutputProperties()

Returns:

the output properties for the instance filter stream.