org.apache.jackrabbit.vault.packaging

Class ExportOptions

java.lang.Object

org.apache.jackrabbit.vault.packaging.ExportOptions

public class ExportOptions
extends java.lang.Object

Holds options used for exporting.

Constructor Summary

Constructors

Constructor and Description
ExportOptions()

Method Summary

Modifier and Type	Method and Description
int	getCompressionLevel() Returns the compression level.
ProgressTrackerListener	getListener() Returns the progress tracker listener.
MetaInf	getMetaInf() Returns the meta-inf
java.lang.String	getMountPath() Returns the mount path
ExportPostProcessor	getPostProcessor() Returns the post processor
java.lang.String	getRootPath() Returns the root path.
void	setCompressionLevel(int compressionLevel) Defines the compression level for the export.
void	setListener(ProgressTrackerListener listener) Sets the progress tracker listener for an export.
void	setMetaInf(MetaInf metaInf) Sets the meta-inf to be included in an exported archive.
void	setMountPath(java.lang.String mountPath) Defines the root path where the repository should be mounted for the export.
void	setPostProcessor(ExportPostProcessor postProcessor) Sets the export post processor for an export.
void	setRootPath(java.lang.String rootPath) Defines the root path where the mounted repository should be mapped into the vault fs.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExportOptions

public ExportOptions()

Method Detail

getListener

public ProgressTrackerListener getListener()

Returns the progress tracker listener.

Returns:

the progress tracker listener.

setListener

public void setListener(ProgressTrackerListener listener)

Sets the progress tracker listener for an export. The listener receives progress messages from the progress tracker and can use them to provide feedback.

Parameters:

listener - the listener

getPostProcessor

public ExportPostProcessor getPostProcessor()

Returns the post processor

Returns:

the post processor

setPostProcessor

public void setPostProcessor(ExportPostProcessor postProcessor)

Sets the export post processor for an export. The post processor is called after the actual export is performed but before the archive is closed.

Parameters:

postProcessor - the post processor

getMetaInf

public MetaInf getMetaInf()

Returns the meta-inf

Returns:

the meta-inf

setMetaInf

public void setMetaInf(MetaInf metaInf)

Sets the meta-inf to be included in an exported archive.

Parameters:

metaInf - the meta inf

getRootPath

public java.lang.String getRootPath()

Returns the root path.

Returns:

the root path.

setRootPath

public void setRootPath(java.lang.String rootPath)

Defines the root path where the mounted repository should be mapped into the vault fs. this can be used to generate packages that have a virtual root. If a root path different than '/' is set, the workspace filter will be adjusted accordingly, if possible.

Parameters:

rootPath - the root path

getMountPath

public java.lang.String getMountPath()

Returns the mount path

Returns:

the mount path

setMountPath

public void setMountPath(java.lang.String mountPath)

Defines the root path where the repository should be mounted for the export. this can be used to generate packages that are not "rooted" at '/'. If a mount path different than '/' is set, the workspace filter will be adjusted accordingly, if possible

Parameters:

mountPath - the mount path

setCompressionLevel

public void setCompressionLevel(int compressionLevel)

Defines the compression level for the export.

Parameters:

compressionLevel - the compression level

See Also:

Deflater.setLevel(int), Deflater.DEFAULT_COMPRESSION, Deflater.NO_COMPRESSION

getCompressionLevel

public int getCompressionLevel()

Returns the compression level. Defaults to Deflater.DEFAULT_COMPRESSION

Returns:

the compression level

See Also:

Deflater.setLevel(int), Deflater.DEFAULT_COMPRESSION, Deflater.NO_COMPRESSION