Package org.mycore.impex

Class MCRTransferPackageCommands

java.lang.Object

org.mycore.impex.MCRTransferPackageCommands

@MCRCommandGroup(name="Transfer Package Commands")
public class MCRTransferPackageCommands
extends Object

Constructor Summary

Constructors

Constructor	Description
MCRTransferPackageCommands()

Method Summary

Modifier and Type	Method	Description
static void	cleanUp(String targetDirectoryPath)
static void	create(String query)
static List<String>	fromDirectory(String sourceDirectory, String mycoreTargetId)
static void	importDerivate(String derivateId, String targetDirectoryPath)
static void	importObject(String pathToClassification)
static List<String>	importObject(String objectId, String targetDirectoryPath, String parentId)
static List<String>	importTransferPackageFromTar(String pathToTar, String mycoreTargetId)
static List<String>	importTransferPackagesFromDirectory(String directory)
static void	untar(String pathToTar)

Methods inherited from class java.lang.Object

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

Constructor Details

MCRTransferPackageCommands

public MCRTransferPackageCommands()

Method Details

create

@MCRCommand(help="Creates multiple transfer packages which matches the solr query in {0}.",
            syntax="create transfer package for objects matching {0}")
public static void create(String query)
                   throws Exception

Throws:

Exception

importTransferPackagesFromDirectory

@MCRCommand(help="Imports all transfer packages located in the directory {0}.",
            syntax="import transfer packages from directory {0}")
public static List<String> importTransferPackagesFromDirectory(String directory)
                                                        throws Exception

Throws:

Exception

importTransferPackageFromTar

@MCRCommand(help="Imports a transfer package located at {0}. Where {0} is the absolute path to the tar file. The parameter {1} is optional and can be omitted. You can specify a mycore id where the first object of import.xml should be attached.",
            syntax="import transfer package from tar {0} to {1}")
public static List<String> importTransferPackageFromTar(String pathToTar,
 String mycoreTargetId)
                                                 throws Exception

Throws:

Exception

untar

@MCRCommand(syntax="_import transfer package untar {0}")
public static void untar(String pathToTar)
                  throws Exception

Throws:

Exception

fromDirectory

@MCRCommand(syntax="_import transfer package from directory {0} to {1}")
public static List<String> fromDirectory(String sourceDirectory,
 String mycoreTargetId)
                                  throws Exception

Throws:

Exception

importObject

@MCRCommand(syntax="_import transfer package classification from {0}")
public static void importObject(String pathToClassification)
                         throws Exception

Throws:

Exception

importObject

@MCRCommand(syntax="_import transfer package object {0} from {1} to {2}")
public static List<String> importObject(String objectId,
 String targetDirectoryPath,
 String parentId)
                                 throws Exception

Throws:

Exception

importDerivate

@MCRCommand(syntax="_import transfer package derivate {0} from {1}")
public static void importDerivate(String derivateId,
 String targetDirectoryPath)
                           throws Exception

Throws:

Exception

cleanUp

@MCRCommand(syntax="_import transfer package clean up {0}")
public static void cleanUp(String targetDirectoryPath)
                    throws Exception

Throws:

Exception