org.sakaiproject.archive.impl

Class ArchiveService2Impl

java.lang.Object

org.sakaiproject.archive.impl.ArchiveService2Impl

All Implemented Interfaces:

org.sakaiproject.archive.api.ArchiveService

public class ArchiveService2Impl
extends Object
implements org.sakaiproject.archive.api.ArchiveService

Field Summary

Fields

Modifier and Type	Field and Description
protected org.sakaiproject.entity.api.EntityManager	m_entityManager Dependency: EntityManager.
protected String[]	m_filteredSakaiRoles
protected String[]	m_filteredSakaiServices
protected boolean	m_filterSakaiRoles
protected boolean	m_filterSakaiServices
protected org.sakaiproject.component.api.ServerConfigurationService	m_serverConfigurationService Dependency: ServerConfigurationService.
protected SiteArchiver	m_siteArchiver Dependency: SiteArchiver
protected SiteMerger	m_siteMerger Dependency: SiteMerger
protected String	m_storagePath A full path and file name to the storage file.

Fields inherited from interface org.sakaiproject.archive.api.ArchiveService

FROM_CT, FROM_SAKAI, FROM_SAKAI_2_8, FROM_WT, SAKAI_assign_draft_import, SAKAI_msg_draft_import, SAKAI_rsc_draft_import, SAKAI_schedule_draft_import, SERVICE_NAME

Constructor Summary

Constructors

Constructor and Description
ArchiveService2Impl()

Method Summary

Methods

Modifier and Type	Method and Description
String	archive(String siteId) Create an archive for the resources of a site.
void	destroy()
void	init() Init and Destroy
String	merge(String fileName, String siteId, String creatorId) Process a merge for the file, or if it's a directory, for all contained files (one level deep).
void	setEntityManager(org.sakaiproject.entity.api.EntityManager service)
void	setMergeFilteredSakaiRoles(String[] filtered)
void	setMergeFilteredSakaiServices(String[] filtered)
void	setMergeFilterSakaiRoles(boolean filter)
void	setMergeFilterSakaiServices(boolean filter)
void	setServerConfigurationService(org.sakaiproject.component.api.ServerConfigurationService service)
void	setSiteArchiver(SiteArchiver siteArchiver)
void	setSiteMerger(SiteMerger siteMerger)
void	setStoragePath(String path)

Methods inherited from class java.lang.Object

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

Field Detail

m_serverConfigurationService

protected org.sakaiproject.component.api.ServerConfigurationService m_serverConfigurationService

Dependency: ServerConfigurationService.

m_entityManager

protected org.sakaiproject.entity.api.EntityManager m_entityManager

Dependency: EntityManager.

m_siteArchiver

protected SiteArchiver m_siteArchiver

Dependency: SiteArchiver

m_siteMerger

protected SiteMerger m_siteMerger

Dependency: SiteMerger

m_storagePath

protected String m_storagePath

A full path and file name to the storage file.

m_filterSakaiServices

protected boolean m_filterSakaiServices

m_filterSakaiRoles

protected boolean m_filterSakaiRoles

m_filteredSakaiServices

protected String[] m_filteredSakaiServices

m_filteredSakaiRoles

protected String[] m_filteredSakaiRoles

Constructor Detail

ArchiveService2Impl

public ArchiveService2Impl()

Method Detail

setServerConfigurationService

public void setServerConfigurationService(org.sakaiproject.component.api.ServerConfigurationService service)

setEntityManager

public void setEntityManager(org.sakaiproject.entity.api.EntityManager service)

setSiteArchiver

public void setSiteArchiver(SiteArchiver siteArchiver)

setSiteMerger

public void setSiteMerger(SiteMerger siteMerger)

setStoragePath

public void setStoragePath(String path)

setMergeFilterSakaiServices

public void setMergeFilterSakaiServices(boolean filter)

setMergeFilterSakaiRoles

public void setMergeFilterSakaiRoles(boolean filter)

setMergeFilteredSakaiServices

public void setMergeFilteredSakaiServices(String[] filtered)

setMergeFilteredSakaiRoles

public void setMergeFilteredSakaiRoles(String[] filtered)

init

public void init()

Init and Destroy

destroy

public void destroy()

archive

public String archive(String siteId)

Create an archive for the resources of a site.

Specified by:

archive in interface org.sakaiproject.archive.api.ArchiveService

Parameters:

siteId - The id of the site to archive.

Returns:

A log of messages from the archive.

merge

public String merge(String fileName,
           String siteId,
           String creatorId)

Process a merge for the file, or if it's a directory, for all contained files (one level deep).

Specified by:

merge in interface org.sakaiproject.archive.api.ArchiveService

Parameters:

fileName - The site name (for the archive file) to read from.

mergeId - The id string to use to make ids in the merge consistent and unique.

creatorId - The creator id If null or blank, the date/time string of the merge is used.