Class ExportOptions
- java.lang.Object
-
- org.apache.jackrabbit.vault.packaging.ExportOptions
-
public class ExportOptions extends Object
Holds options used for exporting.
-
-
Constructor Summary
Constructors Constructor Description ExportOptions()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
getCompressionLevel()
Returns the compression level.ProgressTrackerListener
getListener()
Returns the progress tracker listener.MetaInf
getMetaInf()
Returns the meta-infString
getMountPath()
Returns the mount pathExportPostProcessor
getPostProcessor()
Returns the post processorString
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(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(String rootPath)
Defines the root path where the mounted repository should be mapped into the vault fs.
-
-
-
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 String getRootPath()
Returns the root path.- Returns:
- the root path in repository format.
-
setRootPath
public void setRootPath(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 in repository format (not in platform format, i.e. not escaped)
-
getMountPath
public String getMountPath()
Returns the mount path- Returns:
- the mount path in repository format
-
setMountPath
public void setMountPath(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 in repository format (not in platform format, i.e. not escaped)
-
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 toDeflater.DEFAULT_COMPRESSION
- Returns:
- the compression level
- See Also:
Deflater.setLevel(int)
,Deflater.DEFAULT_COMPRESSION
,Deflater.NO_COMPRESSION
-
-