org.sakaiproject.importer.impl

Class BasicImportService

java.lang.Object

org.sakaiproject.importer.impl.BasicImportService

All Implemented Interfaces:

ImportService

public class BasicImportService
extends Object
implements ImportService

Constructor Summary

Constructors

Constructor and Description
BasicImportService()

Method Summary

Modifier and Type	Method and Description
void	doImportItems(Collection<Importable> importables, String siteId) Put the parsed items into a site.
boolean	isValidArchive(ResetOnCloseInputStream archiveFileData) Check the validity of the file data passed.
ImportDataSource	parseFromFile(ResetOnCloseInputStream archiveFileData) Parse the archive file data and create an Import Data Source object containing the results.
void	registerParser(ImportFileParser parser)
void	registerResourceHandler(HandlesImportable handler)
void	setParsers(List<ImportFileParser> parsers)
void	setResourceHandlers(List<HandlesImportable> resourceHandlers)

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicImportService

public BasicImportService()

Method Detail

doImportItems

public void doImportItems(Collection<Importable> importables,
                          String siteId)

Description copied from interface: ImportService

Put the parsed items into a site.

Specified by:

doImportItems in interface ImportService

Parameters:

importables - a collection of importable things to import.

siteId - is the the id of the site to import to.

isValidArchive

public boolean isValidArchive(ResetOnCloseInputStream archiveFileData)

Description copied from interface: ImportService

Check the validity of the file data passed. Currently if you use this method, it's important you use an InputStream that does a .reset() on .close(). The archive-api's org.sakaiproject.importer.api.ResetOnCloseInputStream is one such example of this. This is because this InputStream may be re-used.

Specified by:

isValidArchive in interface ImportService

Parameters:

archiveFileData - is an input stream of data gathered from an archive file or package.

Returns:

true if file data is valid.

See Also:

ResetOnCloseInputStream

parseFromFile

public ImportDataSource parseFromFile(ResetOnCloseInputStream archiveFileData)

Description copied from interface: ImportService

Parse the archive file data and create an Import Data Source object containing the results. Currently if you use this method, it's important you use an InputStream that does a .reset() on .close(). The archive-api's org.sakaiproject.importer.api.ResetOnCloseInputStream is one such example of this. This is because this InputStream may be re-used.

Specified by:

parseFromFile in interface ImportService

Parameters:

archiveFileData - is an input stream of data gathered from an archive file or package.

Returns:

ImportDataSource containing parsing results.

See Also:

ResetOnCloseInputStream

registerParser

public void registerParser(ImportFileParser parser)

setParsers

public void setParsers(List<ImportFileParser> parsers)

registerResourceHandler

public void registerResourceHandler(HandlesImportable handler)

setResourceHandlers

public void setResourceHandlers(List<HandlesImportable> resourceHandlers)