org.sakaiproject.archive.api

Interface ArchiveService

public interface ArchiveService

ArchiveService takes care of exporting and importing entities.

Field Summary

Fields

Modifier and Type	Field and Description
static String	FROM_CT A tag for the input system.
static String	FROM_SAKAI
static String	FROM_SAKAI_2_8
static String	FROM_WT
static boolean	SAKAI_assign_draft_import
static boolean	SAKAI_msg_draft_import
static boolean	SAKAI_rsc_draft_import
static boolean	SAKAI_schedule_draft_import
static String	SERVICE_NAME This string can be used to find the service in the service manager.

Method Summary

Modifier and Type	Method and Description
String	archive(String siteId) Create an archive for the resources of a site.
String	archiveAndZip(String siteId) Archive a site then compress it to a zip.
String	merge(String archiveUrl, String siteId, String siteCreatorId) Read in an archived set of resources, and merge the entries into the specified site, and set site creator name
String	mergeFromZip(String zipFilePath, String siteId, String siteCreatorId) 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

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

This string can be used to find the service in the service manager.

FROM_CT

static final String FROM_CT

A tag for the input system.

See Also:

Constant Field Values

FROM_WT

static final String FROM_WT

See Also:

Constant Field Values

FROM_SAKAI

static final String FROM_SAKAI

See Also:

Constant Field Values

FROM_SAKAI_2_8

static final String FROM_SAKAI_2_8

See Also:

Constant Field Values

SAKAI_msg_draft_import

static final boolean SAKAI_msg_draft_import

See Also:

Constant Field Values

SAKAI_assign_draft_import

static final boolean SAKAI_assign_draft_import

See Also:

Constant Field Values

SAKAI_rsc_draft_import

static final boolean SAKAI_rsc_draft_import

See Also:

Constant Field Values

SAKAI_schedule_draft_import

static final boolean SAKAI_schedule_draft_import

See Also:

Constant Field Values

Method Detail

archive

String archive(String siteId)

Create an archive for the resources of a site.

Parameters:

siteId - The id of the site to archive.

Returns:

A log of messages from the archive.

merge

String merge(String archiveUrl,
             String siteId,
             String siteCreatorId)

Read in an archived set of resources, and merge the entries into the specified site, and set site creator name

Parameters:

archiveUrl - The archive xml file Url.

siteId - The id of the site to merge the content into.

siteCreatorId - the site creator Id

Returns:

A log of messages from the merge.

mergeFromZip

String mergeFromZip(String zipFilePath,
                    String siteId,
                    String siteCreatorId)

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

Parameters:

zipFilePath - The archived site as a zip file

siteId - The id of the site to merge the content into.

siteCreatorId - the site creator Id

Returns:

A log of messages from the merge.

archiveAndZip

String archiveAndZip(String siteId)
              throws IOException

Archive a site then compress it to a zip.

Parameters:

siteId - - id of site to be archived

Returns:

A log of messages from creating the archive

Throws:

IOException