public interface ItemExportService
ItemExport creates the simple AIP package that the importer also uses. It consists of:
/exportdir/42/ (one directory per item) / dublin_core.xml - qualified dublin core in RDF schema / contents - text file, listing one file per line / file1 - files contained in the item / file2 / ...
issues -doesn't handle special characters in metadata (needs to turn &'s into
&, etc.)
Modified by David Little, UCSD Libraries 12/21/04 to allow the registration of files (bitstreams) into DSpace.
| Modifier and Type | Field and Description |
|---|---|
static String |
COMPRESSED_EXPORT_MIME_TYPE
used for export download
|
| Modifier and Type | Method and Description |
|---|---|
String |
assembleFileName(String type,
EPerson eperson,
Date date)
Create a file name based on the date and eperson
|
boolean |
canDownload(Context context,
String fileName)
The file name of the export archive contains the eperson id of the person
who created it When requested for download this method can check if the
person requesting it is the same one that created it
|
void |
createDownloadableExport(DSpaceObject dso,
Context context,
boolean migrate)
Convenience methot to create export a single Community, Collection, or
Item
|
void |
createDownloadableExport(DSpaceObject dso,
Context context,
String additionalEmail,
boolean migrate)
Convenience methot to create export a single Community, Collection, or
Item
|
void |
createDownloadableExport(List<DSpaceObject> dsObjects,
Context context,
boolean migrate)
Convenience method to export a List of dspace objects (Community,
Collection or Item)
|
void |
createDownloadableExport(List<DSpaceObject> dsObjects,
Context context,
String additionalEmail,
boolean migrate)
Convenience method to export a List of dspace objects (Community,
Collection or Item)
|
void |
deleteOldExportArchives()
A clean up method that is ran before a new export archive is created.
|
void |
deleteOldExportArchives(EPerson eperson)
A clean up method that is ran before a new export archive is created.
|
void |
emailErrorMessage(EPerson eperson,
String error)
Since the archive is created 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 archive is created in a new thread we are unable to communicate
with calling method about success or failure.
|
void |
exportAsZip(Context context,
Iterator<Item> items,
String destDirName,
String zipFileName,
int seqStart,
boolean migrate,
boolean excludeBitstreams)
Method to perform an export and save it as a zip file.
|
void |
exportItem(Context c,
Iterator<Item> i,
String destDirName,
int seqStart,
boolean migrate,
boolean excludeBitstreams) |
String |
getExportDownloadDirectory(EPerson ePerson)
Use config file entry for org.dspace.app.itemexport.download.dir and id
of the eperson to create a download directory name
|
InputStream |
getExportDownloadInputStream(String fileName,
EPerson eperson)
Used to read the export archived.
|
long |
getExportFileLastModified(Context context,
String fileName)
Get the last modified date of the export archive represented by the file name.
|
long |
getExportFileSize(Context context,
String fileName)
Get the file size of the export archive represented by the file name.
|
List<String> |
getExportsAvailable(EPerson eperson)
Reads the download directory for the eperson to see if any export
archives are available
|
String |
getExportWorkDirectory()
Returns config file entry for org.dspace.app.itemexport.work.dir
|
void |
zip(String strSource,
String target)
Zip source to target
|
static final String COMPRESSED_EXPORT_MIME_TYPE
void exportItem(Context c, Iterator<Item> i, String destDirName, int seqStart, boolean migrate, boolean excludeBitstreams) throws Exception
Exceptionvoid exportAsZip(Context context, Iterator<Item> items, String destDirName, String zipFileName, int seqStart, boolean migrate, boolean excludeBitstreams) throws Exception
context - The DSpace Contextitems - The items to exportdestDirName - The directory to save the export inzipFileName - The name to save the zip file asseqStart - The first number in the sequencemigrate - Whether to use the migrate option or notexcludeBitstreams - Whether to exclude bitstreams or notException - if errorvoid createDownloadableExport(DSpaceObject dso, Context context, boolean migrate) throws Exception
dso - - the dspace object to exportcontext - - the dspace contextmigrate - Whether to use the migrate option or notException - if errorvoid createDownloadableExport(List<DSpaceObject> dsObjects, Context context, boolean migrate) throws Exception
dsObjects - - List containing dspace objectscontext - - the dspace contextmigrate - Whether to use the migrate option or notException - if errorvoid createDownloadableExport(DSpaceObject dso, Context context, String additionalEmail, boolean migrate) throws Exception
dso - - the dspace object to exportcontext - - the dspace contextadditionalEmail - - cc email to usemigrate - Whether to use the migrate option or notException - if errorvoid createDownloadableExport(List<DSpaceObject> dsObjects, Context context, String additionalEmail, boolean migrate) throws Exception
dsObjects - - List containing dspace objectscontext - - the dspace contextadditionalEmail - - cc email to usemigrate - Whether to use the migrate option or notException - if errorString assembleFileName(String type, EPerson eperson, Date date) throws Exception
type - Type of object (as string)eperson - - eperson who requested export and will be able to download itdate - - the date the export process was createdException - if errorString getExportDownloadDirectory(EPerson ePerson) throws Exception
ePerson - - the eperson who requested export archiveException - if errorString getExportWorkDirectory() throws Exception
Exception - if errorInputStream getExportDownloadInputStream(String fileName, EPerson eperson) throws Exception
fileName - the name of the file to downloadeperson - the eperson requesting the downloadException - if errorlong getExportFileSize(Context context, String fileName) throws Exception
context - DSpace contextfileName - name of the file to get the size.Exception - if errorlong getExportFileLastModified(Context context, String fileName) throws Exception
context - DSpace contextfileName - name of the file to get the size.Exception - if errorFile.lastModified()boolean canDownload(Context context, String fileName)
context - dspace contextfileName - the file name to check auths forList<String> getExportsAvailable(EPerson eperson) throws Exception
eperson - EPerson objectException - if errorvoid deleteOldExportArchives(EPerson eperson) throws Exception
eperson - - the eperson to clean upException - if errorvoid deleteOldExportArchives()
throws Exception
Exception - if errorvoid emailSuccessMessage(Context context, EPerson eperson, String fileName) throws javax.mail.MessagingException
context - - the current Contexteperson - - eperson to send the email tofileName - - the file name to be downloaded. It is added to the url in
the emailjavax.mail.MessagingException - if errorvoid emailErrorMessage(EPerson eperson, String error) throws javax.mail.MessagingException
eperson - - EPerson to send the error message toerror - - the error messagejavax.mail.MessagingException - if errorCopyright © 2017 DuraSpace. All rights reserved.