org.dspace.app.itemimport

Class ItemImportServiceImpl

java.lang.Object

org.dspace.app.itemimport.ItemImportServiceImpl

All Implemented Interfaces:

ItemImportService, org.springframework.beans.factory.InitializingBean

public class ItemImportServiceImpl
extends Object
implements ItemImportService, org.springframework.beans.factory.InitializingBean

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.

Field Summary

Fields

Modifier and Type	Field and Description
protected AuthorizeService	authorizeService
protected BitstreamFormatService	bitstreamFormatService
protected BitstreamService	bitstreamService
protected BundleService	bundleService
protected CollectionService	collectionService
protected FilenameFilter	directoryFilter
protected EPersonService	ePersonService
protected GroupService	groupService
protected HandleService	handleService
protected InstallItemService	installItemService
protected boolean	isQuiet
protected boolean	isResume
protected boolean	isTest
protected ItemService	itemService
protected MetadataFieldService	metadataFieldService
protected FilenameFilter	metadataFileFilter
protected MetadataSchemaService	metadataSchemaService
protected ResourcePolicyService	resourcePolicyService
protected String	tempWorkDir
protected boolean	useWorkflow
protected boolean	useWorkflowSendEmail
protected WorkflowService	workflowService
protected WorkspaceItemService	workspaceItemService

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ItemImportServiceImpl()

Method Summary

Methods

Modifier and Type	Method and Description
void	addBTEItems(Context c, List<Collection> mycollections, String sourceDir, String mapFile, boolean template, String inputType, String workingDir) In this method, the BTE is instantiated.
protected void	addDCValue(Context c, Item i, String schema, Node n)
protected Item	addItem(Context c, List<Collection> mycollections, String path, String itemname, PrintWriter mapOut, boolean template) item? try and add it to the archive.
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	afterPropertiesSet()
void	cleanupZipTemp()
void	deleteBatchUpload(Context c, String uploadId)
protected boolean	deleteDirectory(File path) Delete a directory and its child files and directories
protected void	deleteItem(Context c, Item myitem)
protected void	deleteItem(Context c, String myhandle)
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.
protected String	generateRandomFilename(boolean hidden) Generate a random filename based on current time
List<BatchUpload>	getImportsAvailable(EPerson eperson)
String	getImportUploadableDirectory(EPerson ePerson)
protected String	getStringValue(Node node) Return the String value of a Node.
String	getTempWorkDir()
File	getTempWorkDirFile()
protected void	loadDublinCore(Context c, Item myitem, String filename)
protected void	loadMetadata(Context c, Item myitem, String path)
protected Document	loadXML(String filename) Load in the XML from file.
protected List<Collection>	processCollectionFile(Context c, String path, String filename) Read the collections file inside the item directory.
protected void	processContentFileEntry(Context c, Item i, String path, String fileName, String bundleName, boolean primary) each entry represents a bitstream....
protected List<String>	processContentsFile(Context c, Item i, String path, String filename) Given a contents file and an item, stuffing it with bitstreams from the contents file Returns a List of Strings with lines from the contents file that request non-default bitstream permission
protected String	processHandleFile(Context c, Item i, String path, String filename) Read in the handle file or return null if empty or doesn't exist
protected void	processOptions(Context c, Item myItem, List<String> options) Process the Options to apply to the Item.
void	processUIImport(String filepath, Collection owningCollection, String[] otherCollections, String resumeDir, String inputType, Context context, boolean template) Given a local file or public URL to a zip file that has the Simple Archive Format, this method imports the contents to DSpace
protected Map<String,String>	readMapFile(String filename)
protected void	registerBitstream(Context c, Item i, int assetstore, String bitstreamPath, String bundleName, String description) Register the bitstream file into DSpace
void	replaceItems(Context c, List<Collection> mycollections, String sourceDir, String mapFile, boolean template)
protected void	setPermission(Context c, Group g, int actionID, Bitstream bs) Set the Permission on a Bitstream.
void	setQuiet(boolean isQuiet)
void	setResume(boolean isResume)
void	setTest(boolean isTest)
void	setUseWorkflow(boolean useWorkflow)
void	setUseWorkflowSendEmail(boolean useWorkflowSendEmail)
String	unzip(File zipfile)
String	unzip(File zipfile, String destDir)
String	unzip(String sourcedir, String zipfilename)

Methods inherited from class java.lang.Object

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

Field Detail

authorizeService

@Autowired(required=true)
protected AuthorizeService authorizeService

bitstreamService

@Autowired(required=true)
protected BitstreamService bitstreamService

bitstreamFormatService

@Autowired(required=true)
protected BitstreamFormatService bitstreamFormatService

bundleService

@Autowired(required=true)
protected BundleService bundleService

collectionService

@Autowired(required=true)
protected CollectionService collectionService

ePersonService

@Autowired(required=true)
protected EPersonService ePersonService

handleService

@Autowired(required=true)
protected HandleService handleService

itemService

@Autowired(required=true)
protected ItemService itemService

installItemService

@Autowired(required=true)
protected InstallItemService installItemService

groupService

@Autowired(required=true)
protected GroupService groupService

metadataFieldService

@Autowired(required=true)
protected MetadataFieldService metadataFieldService

metadataSchemaService

@Autowired(required=true)
protected MetadataSchemaService metadataSchemaService

resourcePolicyService

@Autowired(required=true)
protected ResourcePolicyService resourcePolicyService

workspaceItemService

@Autowired(required=true)
protected WorkspaceItemService workspaceItemService

workflowService

@Autowired(required=true)
protected WorkflowService workflowService

tempWorkDir

protected final String tempWorkDir

isTest

protected boolean isTest

isResume

protected boolean isResume

useWorkflow

protected boolean useWorkflow

useWorkflowSendEmail

protected boolean useWorkflowSendEmail

isQuiet

protected boolean isQuiet

metadataFileFilter

protected FilenameFilter metadataFileFilter

directoryFilter

protected FilenameFilter directoryFilter

Constructor Detail

ItemImportServiceImpl

protected ItemImportServiceImpl()

Method Detail

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception

addBTEItems

public void addBTEItems(Context c,
               List<Collection> mycollections,
               String sourceDir,
               String mapFile,
               boolean template,
               String inputType,
               String workingDir)
                 throws Exception

In this method, the BTE is instantiated. THe workflow generates the DSpace files necessary for the upload, and the default item import method is called

Specified by:

addBTEItems in interface ItemImportService

Parameters:

c - The contect

mycollections - The collections the items are inserted to

sourceDir - The filepath to the file to read data from

mapFile - The filepath to mapfile to be generated

template -

inputType - The type of the input data (bibtex, csv, etc.)

workingDir - The path to create temporary files (for command line or UI based)

Throws:

Exception

addItemsAtomic

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

Specified by:

addItemsAtomic in interface ItemImportService

Throws:

Exception

addItems

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

Specified by:

addItems in interface ItemImportService

Throws:

Exception

replaceItems

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

Specified by:

replaceItems in interface ItemImportService

Throws:

Exception

deleteItems

public void deleteItems(Context c,
               String mapFile)
                 throws Exception

Specified by:

deleteItems in interface ItemImportService

Throws:

Exception

addItem

protected Item addItem(Context c,
           List<Collection> mycollections,
           String path,
           String itemname,
           PrintWriter mapOut,
           boolean template)
                throws Exception

item? try and add it to the archive.

Parameters:

mycollections - - add item to these Collections.

path - - directory containing the item directories.

itemname - handle - non-null means we have a pre-defined handle already

mapOut - - mapfile we're writing

Throws:

Exception

deleteItem

protected void deleteItem(Context c,
              Item myitem)
                   throws Exception

Throws:

Exception

deleteItem

protected void deleteItem(Context c,
              String myhandle)
                   throws Exception

Throws:

Exception

readMapFile

protected Map<String,String> readMapFile(String filename)
                                  throws Exception

Throws:

Exception

loadMetadata

protected void loadMetadata(Context c,
                Item myitem,
                String path)
                     throws SQLException,
                            IOException,
                            ParserConfigurationException,
                            SAXException,
                            TransformerException,
                            AuthorizeException

Throws:

SQLException

IOException

ParserConfigurationException

SAXException

TransformerException

AuthorizeException

loadDublinCore

protected void loadDublinCore(Context c,
                  Item myitem,
                  String filename)
                       throws SQLException,
                              IOException,
                              ParserConfigurationException,
                              SAXException,
                              TransformerException,
                              AuthorizeException

Throws:

SQLException

IOException

ParserConfigurationException

SAXException

TransformerException

AuthorizeException

addDCValue

protected void addDCValue(Context c,
              Item i,
              String schema,
              Node n)
                   throws TransformerException,
                          SQLException,
                          AuthorizeException

Throws:

TransformerException

SQLException

AuthorizeException

processCollectionFile

protected List<Collection> processCollectionFile(Context c,
                                     String path,
                                     String filename)
                                          throws IOException,
                                                 SQLException

Read the collections file inside the item directory. If there is one and it is not empty return a list of collections in which the item should be inserted. If it does not exist or it is empty return null.

Parameters:

c - The context

path - The path to the data directory for this item

filename - The collections file filename. Should be "collections"

Returns:

A list of collections in which to insert the item or null

Throws:

IOException

SQLException

processHandleFile

protected String processHandleFile(Context c,
                       Item i,
                       String path,
                       String filename)

Read in the handle file or return null if empty or doesn't exist

processContentsFile

protected List<String> processContentsFile(Context c,
                               Item i,
                               String path,
                               String filename)
                                    throws SQLException,
                                           IOException,
                                           AuthorizeException

Given a contents file and an item, stuffing it with bitstreams from the contents file Returns a List of Strings with lines from the contents file that request non-default bitstream permission

Throws:

SQLException

IOException

AuthorizeException

processContentFileEntry

protected void processContentFileEntry(Context c,
                           Item i,
                           String path,
                           String fileName,
                           String bundleName,
                           boolean primary)
                                throws SQLException,
                                       IOException,
                                       AuthorizeException

each entry represents a bitstream....

Parameters:

c -

i -

path -

fileName -

bundleName -

Throws:

SQLException

IOException

AuthorizeException

registerBitstream

protected void registerBitstream(Context c,
                     Item i,
                     int assetstore,
                     String bitstreamPath,
                     String bundleName,
                     String description)
                          throws SQLException,
                                 IOException,
                                 AuthorizeException

Register the bitstream file into DSpace

Parameters:

c -

i -

assetstore -

bitstreamPath - the full filepath expressed in the contents file

bundleName -

Throws:

SQLException

IOException

AuthorizeException

processOptions

protected void processOptions(Context c,
                  Item myItem,
                  List<String> options)
                       throws SQLException,
                              AuthorizeException

Process the Options to apply to the Item. The options are tab delimited Options: 48217870-MIT.pdf permissions: -r 'MIT Users' description: Full printable version (MIT only) permissions:[r|w]-['group name'] description: 'the description of the file' where: [r|w] (meaning: read|write) ['MIT Users'] (the group name)

Parameters:

c -

myItem -

options -

Throws:

SQLException

AuthorizeException

setPermission

protected void setPermission(Context c,
                 Group g,
                 int actionID,
                 Bitstream bs)
                      throws SQLException,
                             AuthorizeException

Set the Permission on a Bitstream.

Parameters:

c -

g -

actionID -

bs -

Throws:

SQLException

AuthorizeException

getStringValue

protected String getStringValue(Node node)

Return the String value of a Node.

Parameters:

node -

Returns:

loadXML

protected Document loadXML(String filename)
                    throws IOException,
                           ParserConfigurationException,
                           SAXException

Load in the XML from file.

Parameters:

filename - the filename to load from

Returns:

the DOM representation of the XML file

Throws:

IOException

ParserConfigurationException

SAXException

deleteDirectory

protected boolean deleteDirectory(File path)

Delete a directory and its child files and directories

Parameters:

path - The directory to delete

Returns:

Whether the deletion was successful or not

unzip

public String unzip(File zipfile)
             throws IOException

Specified by:

unzip in interface ItemImportService

Throws:

IOException

unzip

public String unzip(File zipfile,
           String destDir)
             throws IOException

Specified by:

unzip in interface ItemImportService

Throws:

IOException

unzip

public String unzip(String sourcedir,
           String zipfilename)
             throws IOException

Specified by:

unzip in interface ItemImportService

Throws:

IOException

generateRandomFilename

protected String generateRandomFilename(boolean hidden)

Generate a random filename based on current time

Parameters:

hidden: - add . as a prefix to make the file hidden

Returns:

the filename

processUIImport

public void processUIImport(String filepath,
                   Collection owningCollection,
                   String[] otherCollections,
                   String resumeDir,
                   String inputType,
                   Context context,
                   boolean template)
                     throws Exception

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

Specified by:

processUIImport in interface ItemImportService

Parameters:

filepath - The filepath to local file or the public URL of the zip file

owningCollection - The owning collection the items will belong to

otherCollections - 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

inputType - The input type of the data (bibtex, csv, etc.), in case of local file

context - The context

Throws:

Exception

emailSuccessMessage

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

Description copied from interface: ItemImportService

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

Specified by:

emailSuccessMessage in interface ItemImportService

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

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

Description copied from interface: ItemImportService

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

Specified by:

emailErrorMessage in interface ItemImportService

Parameters:

eperson - - EPerson to send the error message to

error - - the error message

Throws:

javax.mail.MessagingException

getImportsAvailable

public List<BatchUpload> getImportsAvailable(EPerson eperson)
                                      throws Exception

Specified by:

getImportsAvailable in interface ItemImportService

Throws:

Exception

getImportUploadableDirectory

public String getImportUploadableDirectory(EPerson ePerson)
                                    throws Exception

Specified by:

getImportUploadableDirectory in interface ItemImportService

Throws:

Exception

deleteBatchUpload

public void deleteBatchUpload(Context c,
                     String uploadId)
                       throws Exception

Specified by:

deleteBatchUpload in interface ItemImportService

Throws:

Exception

getTempWorkDir

public String getTempWorkDir()

Specified by:

getTempWorkDir in interface ItemImportService

getTempWorkDirFile

public File getTempWorkDirFile()

Specified by:

getTempWorkDirFile in interface ItemImportService

cleanupZipTemp

public void cleanupZipTemp()

Specified by:

cleanupZipTemp in interface ItemImportService

setTest

public void setTest(boolean isTest)

Specified by:

setTest in interface ItemImportService

setResume

public void setResume(boolean isResume)

Specified by:

setResume in interface ItemImportService

setUseWorkflow

public void setUseWorkflow(boolean useWorkflow)

Specified by:

setUseWorkflow in interface ItemImportService

setUseWorkflowSendEmail

public void setUseWorkflowSendEmail(boolean useWorkflowSendEmail)

Specified by:

setUseWorkflowSendEmail in interface ItemImportService

setQuiet

public void setQuiet(boolean isQuiet)

Specified by:

setQuiet in interface ItemImportService