Package org.mycore.impex

Class MCRTransferPackagePacker

java.lang.Object

org.mycore.services.packaging.MCRPacker

org.mycore.impex.MCRTransferPackagePacker

public class MCRTransferPackagePacker
extends MCRPacker

Using the MCRPacker API to build a MCRTransferPackage.

Author:

Matthias Eichner, Silvio Hermann

Field Summary

Fields inherited from class org.mycore.services.packaging.MCRPacker

PACKER_CONFIGURATION_PREFIX

Constructor Summary

Constructors

Constructor	Description
MCRTransferPackagePacker()

Method Summary

Modifier and Type	Method	Description
void	checkSetup()	should check if all required parameters are set!
protected MCRObject	getSource()	Returns the source object.
Path	getTarPath(MCRTransferPackage transferPackage)	Returns the path to the tar archive where the transfer package will be stored.
void	pack()	This method will be called and the MCRPacker should start packing according to the MCRPacker.getConfiguration() and MCRPacker.getParameters()!
void	rollback()	This method can be called in case of error and the MCRPacker should clean up trash from MCRPacker.pack()

Methods inherited from class org.mycore.services.packaging.MCRPacker

getConfiguration, getParameters

Methods inherited from class java.lang.Object

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

Constructor Details

MCRTransferPackagePacker

public MCRTransferPackagePacker()

Method Details

checkSetup

public void checkSetup()
                throws MCRUsageException

Description copied from class: MCRPacker

should check if all required parameters are set!

Specified by:

checkSetup in class MCRPacker

Throws:

MCRUsageException - if parameters are illegal

getSource

protected MCRObject getSource()
                       throws MCRUsageException

Returns the source object.

Returns:

mycore object which should be packed

Throws:

MCRUsageException - something went wrong

pack

public void pack()
          throws ExecutionException

Description copied from class: MCRPacker

This method will be called and the MCRPacker should start packing according to the MCRPacker.getConfiguration() and MCRPacker.getParameters()!
WARNING: do all checks for parameters and user access in MCRPacker.checkSetup(), because the packer is already stored in the DB if pack is called and the pack JOB runs a System-User instead of the User who produces the call.

Specified by:

pack in class MCRPacker

Throws:

ExecutionException - Unable to pack

rollback

public void rollback()

Description copied from class: MCRPacker

This method can be called in case of error and the MCRPacker should clean up trash from MCRPacker.pack()

Specified by:

rollback in class MCRPacker

getTarPath

public Path getTarPath(MCRTransferPackage transferPackage)

Returns the path to the tar archive where the transfer package will be stored.

Returns:

path to the *.tar location