org.dspace.app.itemimport.service

Interface ItemImportService

All Known Implementing Classes:

ItemImportServiceImpl

public interface ItemImportService

Import items into DSpace. The conventional use is upload files by copying them. DSpace writes the item's bitstreams into its assetstore. Metadata is also loaded to the DSpace database.

A second use assumes the bitstream files already exist in a storage resource accessible to DSpace. In this case the bitstreams are 'registered'. That is, the metadata is loaded to the DSpace database and DSpace is given the location of the file which is subsumed into DSpace.

The distinction is controlled by the format of lines in the 'contents' file. See comments in processContentsFile() below.

Modified by David Little, UCSD Libraries 12/21/04 to allow the registration of files (bitstreams) into DSpace.

Method Summary

Methods

Modifier and Type	Method and Description
void	addBTEItems(Context c, List<Collection> mycollections, String sourcedir, String mapfile, boolean template, String bteInputType, String workingDir)
void	addItems(Context c, List<Collection> mycollections, String sourceDir, String mapFile, boolean template)
void	addItemsAtomic(Context c, List<Collection> mycollections, String sourceDir, String mapFile, boolean template)
void	cleanupZipTemp()
void	deleteBatchUpload(Context c, String uploadId)
void	deleteItems(Context c, String mapfile)
void	emailErrorMessage(EPerson eperson, String error) Since the BTE batch import is done in a new thread we are unable to communicate with calling method about success or failure.
void	emailSuccessMessage(Context context, EPerson eperson, String fileName) Since the BTE batch import is done in a new thread we are unable to communicate with calling method about success or failure.
List<BatchUpload>	getImportsAvailable(EPerson eperson)
String	getImportUploadableDirectory(EPerson ePerson)
String	getTempWorkDir()
File	getTempWorkDirFile()
void	processUIImport(String url, Collection owningCollection, String[] collections, String resumeDir, String inputType, Context context, boolean template) Given a public URL to a zip file that has the Simple Archive Format, this method imports the contents to DSpace
void	replaceItems(Context c, List<Collection> mycollections, String sourcedir, String mapfile, boolean template)
void	setQuiet(boolean isQuiet)
void	setResume(boolean isResume)
void	setTest(boolean isTest)
void	setUseWorkflow(boolean useWorkflow)
void	setUseWorkflowSendEmail(boolean useWorkflow)
String	unzip(File zipfile)
String	unzip(File zipfile, String destDir)
String	unzip(String sourcedir, String zipfilename)

Method Detail

addItemsAtomic

void addItemsAtomic(Context c,
                  List<Collection> mycollections,
                  String sourceDir,
                  String mapFile,
                  boolean template)
                    throws Exception

Throws:

Exception

addItems

void addItems(Context c,
            List<Collection> mycollections,
            String sourceDir,
            String mapFile,
            boolean template)
              throws Exception

Throws:

Exception

unzip

String unzip(File zipfile)
             throws IOException

Throws:

IOException

unzip

String unzip(File zipfile,
           String destDir)
             throws IOException

Throws:

IOException

unzip

String unzip(String sourcedir,
           String zipfilename)
             throws IOException

Throws:

IOException

processUIImport

void processUIImport(String url,
                   Collection owningCollection,
                   String[] collections,
                   String resumeDir,
                   String inputType,
                   Context context,
                   boolean template)
                     throws Exception

Given a public URL to a zip file that has the Simple Archive Format, this method imports the contents to DSpace

Parameters:

url - The public URL of the zip file

owningCollection - The owning collection the items will belong to

collections - The collections the created items will be inserted to, apart from the owning one

resumeDir - In case of a resume request, the directory that containsthe old mapfile and data

context - The context

Throws:

Exception

emailSuccessMessage

void emailSuccessMessage(Context context,
                       EPerson eperson,
                       String fileName)
                         throws javax.mail.MessagingException

Since the BTE batch import is done in a new thread we are unable to communicate with calling method about success or failure. We accomplish this communication with email instead. Send a success email once the batch import is complete

Parameters:

context - - the current Context

eperson - - eperson to send the email to

fileName - - the filepath to the mapfile created by the batch import

Throws:

javax.mail.MessagingException

emailErrorMessage

void emailErrorMessage(EPerson eperson,
                     String error)
                       throws javax.mail.MessagingException

Since the BTE batch import is done in a new thread we are unable to communicate with calling method about success or failure. We accomplis this communication with email instead. Send an error email if the batch import fails

Parameters:

eperson - - EPerson to send the error message to

error - - the error message

Throws:

javax.mail.MessagingException

getImportsAvailable

List<BatchUpload> getImportsAvailable(EPerson eperson)
                                      throws Exception

Throws:

Exception

getImportUploadableDirectory

String getImportUploadableDirectory(EPerson ePerson)
                                    throws Exception

Throws:

Exception

deleteBatchUpload

void deleteBatchUpload(Context c,
                     String uploadId)
                       throws Exception

Throws:

Exception

replaceItems

void replaceItems(Context c,
                List<Collection> mycollections,
                String sourcedir,
                String mapfile,
                boolean template)
                  throws Exception

Throws:

Exception

deleteItems

void deleteItems(Context c,
               String mapfile)
                 throws Exception

Throws:

Exception

addBTEItems

void addBTEItems(Context c,
               List<Collection> mycollections,
               String sourcedir,
               String mapfile,
               boolean template,
               String bteInputType,
               String workingDir)
                 throws Exception

Throws:

Exception

getTempWorkDir

String getTempWorkDir()

getTempWorkDirFile

File getTempWorkDirFile()

cleanupZipTemp

void cleanupZipTemp()

setTest

void setTest(boolean isTest)

setResume

void setResume(boolean isResume)

setUseWorkflow

void setUseWorkflow(boolean useWorkflow)

setUseWorkflowSendEmail

void setUseWorkflowSendEmail(boolean useWorkflow)

setQuiet

void setQuiet(boolean isQuiet)