Index (archive-api 23.3 API)

A B C D F G H I M N O P R S T Z
All Classes All Packages

A

archive(String) - Method in interface org.sakaiproject.archive.api.ArchiveService: Create an archive for the resources of a site.
archive(String) - Static method in class org.sakaiproject.archive.cover.ArchiveService
archiveAndZip(String) - Method in interface org.sakaiproject.archive.api.ArchiveService: Archive a site then compress it to a zip.
ArchiveService - Class in org.sakaiproject.archive.cover: ArchiveService is a static Cover for the ArchiveService; see that interface for usage details.
ArchiveService - Interface in org.sakaiproject.archive.api: ArchiveService takes care of exporting and importing entities.
ArchiveService() - Constructor for class org.sakaiproject.archive.cover.ArchiveService
archiveZip(String) - Method in interface org.sakaiproject.archive.api.ZipAware: Compress a site archive to a zip.

B

buildSourceFolder(Collection<ImportMetadata>) - Method in interface org.sakaiproject.importer.api.SakaiArchive

C

canHandleType(String) - Method in interface org.sakaiproject.importer.api.HandlesImportable: Can this handler deal with this importable type.
cleanup() - Method in interface org.sakaiproject.importer.api.ImportDataSource: This should be called when the content has been imported and is no longer needed.
close() - Method in class org.sakaiproject.importer.api.ResetOnCloseInputStream

D

doImportItems(Collection<Importable>, String) - Method in interface org.sakaiproject.importer.api.ImportService: Put the parsed items into a site.
doImportItems(Collection, String) - Static method in class org.sakaiproject.importer.cover.ImportService

F

finalize() - Method in class org.sakaiproject.importer.api.ResetOnCloseInputStream
FROM_CT - Static variable in interface org.sakaiproject.archive.api.ArchiveService: A tag for the input system.
FROM_SAKAI - Static variable in interface org.sakaiproject.archive.api.ArchiveService
FROM_SAKAI_2_8 - Static variable in interface org.sakaiproject.archive.api.ArchiveService
FROM_WT - Static variable in interface org.sakaiproject.archive.api.ArchiveService

G

getContextPath() - Method in interface org.sakaiproject.importer.api.Importable
getFileName() - Method in interface org.sakaiproject.archive.api.ImportMetadata
getGuid() - Method in interface org.sakaiproject.importer.api.Importable
getId() - Method in interface org.sakaiproject.archive.api.ImportMetadata
getImportMapById(String) - Method in interface org.sakaiproject.archive.api.ImportMetadataService
getImportMapById(String) - Static method in class org.sakaiproject.archive.cover.ImportMetadataService
getImportMetadataElements(Document) - Method in interface org.sakaiproject.archive.api.ImportMetadataService
getImportMetadataElements(Document) - Static method in class org.sakaiproject.archive.cover.ImportMetadataService
getInstance() - Static method in class org.sakaiproject.archive.cover.ArchiveService: Access the component instance: special cover only method.
getInstance() - Static method in class org.sakaiproject.archive.cover.ImportMetadataService: Access the component instance: special cover only method.
getInstance() - Static method in class org.sakaiproject.importer.cover.ImportService: Access the component instance: special cover only method.
getItemCategories() - Method in interface org.sakaiproject.importer.api.ImportDataSource
getItemsForCategories(List<ImportMetadata>) - Method in interface org.sakaiproject.importer.api.ImportDataSource
getLegacyGroup() - Method in interface org.sakaiproject.importer.api.Importable
getLegacyTool() - Method in interface org.sakaiproject.archive.api.ImportMetadata
getParent() - Method in interface org.sakaiproject.importer.api.Importable
getSakaiServiceName() - Method in interface org.sakaiproject.archive.api.ImportMetadata
getSakaiTool() - Method in interface org.sakaiproject.archive.api.ImportMetadata
getSequenceNum() - Method in interface org.sakaiproject.importer.api.HasSequence
getSourceFolder() - Method in interface org.sakaiproject.importer.api.SakaiArchive
getTypeName() - Method in interface org.sakaiproject.importer.api.Importable: Get the type for this importable.
getTypeName() - Method in interface org.sakaiproject.importer.api.IMSResourceTranslator

H

handle(Importable, String) - Method in interface org.sakaiproject.importer.api.HandlesImportable: Import the supplied importable into the site.
HandlesImportable - Interface in org.sakaiproject.importer.api: A handler takes a vendor-neutral content object and stuffs it into a particular Sakai tool.
hasMaintainRole(String, Document) - Method in interface org.sakaiproject.archive.api.ImportMetadataService
hasMaintainRole(String, Document) - Static method in class org.sakaiproject.archive.cover.ImportMetadataService
HasSequence - Interface in org.sakaiproject.importer.api: If an Importable has an order then this interface can be applied to it and then they can be arranged into an order.

I

Importable - Interface in org.sakaiproject.importer.api: Importables are extracted as a collection by a parser, and passed one at a time to one or more handlers to be added to Sakai.
ImportDataSource - Interface in org.sakaiproject.importer.api: An ImportDataSource is an object that acts as a container for the Importable objects in an archive.
ImportFileParser - Interface in org.sakaiproject.importer.api: A parser is a class that understands how to read an archive file and extract from it a vendor-neutral collection of content objects.
ImportMetadata - Interface in org.sakaiproject.archive.api: ...
ImportMetadataService - Class in org.sakaiproject.archive.cover: ...
ImportMetadataService - Interface in org.sakaiproject.archive.api: ...
ImportMetadataService() - Constructor for class org.sakaiproject.archive.cover.ImportMetadataService
ImportService - Class in org.sakaiproject.importer.cover
ImportService - Interface in org.sakaiproject.importer.api: The ImportService provides a top level framework to handled import data collected from a content package or other archive.
ImportService() - Constructor for class org.sakaiproject.importer.cover.ImportService
IMSResourceTranslator - Interface in org.sakaiproject.importer.api
isMandatory() - Method in interface org.sakaiproject.archive.api.ImportMetadata
isValidArchive(InputStream) - Method in interface org.sakaiproject.importer.api.ImportFileParser
isValidArchive(ResetOnCloseInputStream) - Method in interface org.sakaiproject.importer.api.ImportService: Check the validity of the file data passed.
isValidArchive(ResetOnCloseInputStream) - Static method in class org.sakaiproject.importer.cover.ImportService

M

merge(String, String, String) - Method in interface org.sakaiproject.archive.api.ArchiveService: Read in an archived set of resources, and merge the entries into the specified site, and set site creator name
merge(String, String, String) - Static method in class org.sakaiproject.archive.cover.ArchiveService
mergeFromZip(String, String, String) - Method in interface org.sakaiproject.archive.api.ArchiveService: Read in an archived set of resources, and merge the entries into the specified site, and set site creator name Allows a ZIP file to be used instead of the site archive directory
mergeZip(String, String, String) - Method in interface org.sakaiproject.archive.api.ZipAware: Read in an archived set of resources, and merge the entries into the specified site, and set site creator name Allows a ZIP file to be used instead of the site archive directory

N

newParser() - Method in interface org.sakaiproject.importer.api.ImportFileParser: Factory method to create a new instance of this parser.

O

org.sakaiproject.archive.api - package org.sakaiproject.archive.api
org.sakaiproject.archive.cover - package org.sakaiproject.archive.cover
org.sakaiproject.importer.api - package org.sakaiproject.importer.api
org.sakaiproject.importer.cover - package org.sakaiproject.importer.cover

P

parse(InputStream, String) - Method in interface org.sakaiproject.importer.api.ImportFileParser
parseFromFile(ResetOnCloseInputStream) - Method in interface org.sakaiproject.importer.api.ImportService: Parse the archive file data and create an Import Data Source object containing the results.
parseFromFile(ResetOnCloseInputStream) - Static method in class org.sakaiproject.importer.cover.ImportService
processResourceChildren() - Method in interface org.sakaiproject.importer.api.IMSResourceTranslator

R

read() - Method in class org.sakaiproject.importer.api.ResetOnCloseInputStream
ResetOnCloseInputStream - Class in org.sakaiproject.importer.api
ResetOnCloseInputStream(File) - Constructor for class org.sakaiproject.importer.api.ResetOnCloseInputStream
ResetOnCloseInputStream(InputStream) - Constructor for class org.sakaiproject.importer.api.ResetOnCloseInputStream

S

SAKAI_ARCHIVE_NS - Static variable in interface org.sakaiproject.archive.api.ArchiveService
SAKAI_assign_draft_import - Static variable in interface org.sakaiproject.archive.api.ArchiveService
SAKAI_msg_draft_import - Static variable in interface org.sakaiproject.archive.api.ArchiveService
SAKAI_rsc_draft_import - Static variable in interface org.sakaiproject.archive.api.ArchiveService
SAKAI_schedule_draft_import - Static variable in interface org.sakaiproject.archive.api.ArchiveService
SakaiArchive - Interface in org.sakaiproject.importer.api
SERVICE_NAME - Static variable in interface org.sakaiproject.archive.api.ArchiveService: This string can be used to find the service in the service manager.
SERVICE_NAME - Static variable in interface org.sakaiproject.archive.api.ImportMetadataService
SERVICE_NAME - Static variable in class org.sakaiproject.archive.cover.ArchiveService
SERVICE_NAME - Static variable in class org.sakaiproject.archive.cover.ImportMetadataService
setContextPath(String) - Method in interface org.sakaiproject.importer.api.Importable
setFileName(String) - Method in interface org.sakaiproject.archive.api.ImportMetadata
setId(String) - Method in interface org.sakaiproject.archive.api.ImportMetadata
setItemCategories(List<ImportMetadata>) - Method in interface org.sakaiproject.importer.api.ImportDataSource
setItems(Collection<Importable>) - Method in interface org.sakaiproject.importer.api.ImportDataSource
setLegacyGroup(String) - Method in interface org.sakaiproject.importer.api.Importable
setLegacyTool(String) - Method in interface org.sakaiproject.archive.api.ImportMetadata
setMandatory(boolean) - Method in interface org.sakaiproject.archive.api.ImportMetadata
setParent(Importable) - Method in interface org.sakaiproject.importer.api.Importable
setSakaiServiceName(String) - Method in interface org.sakaiproject.archive.api.ImportMetadata
setSakaiTool(String) - Method in interface org.sakaiproject.archive.api.ImportMetadata

T

translate(Node, Document, String, String) - Method in interface org.sakaiproject.importer.api.IMSResourceTranslator

Z

ZipAware - Interface in org.sakaiproject.archive.api

A B C D F G H I M N O P R S T Z
All Classes All Packages