org.jahia.services.importexport

Class ImportExportBaseService

java.lang.Object

org.jahia.services.JahiaService

org.jahia.services.importexport.ImportExportBaseService

All Implemented Interfaces:

Observer, ImportExportService

public class ImportExportBaseService
extends JahiaService
implements ImportExportService, Observer

Service used to perform all import/export operations for content and documents.

Author:

Thomas Draier

Field Summary

Fields

Modifier and Type	Field and Description
static String	DYNAMIC_MOUNT_POINT_ATTR
static String	EXPORT_PROPERTIES
static String	LIVE_REPOSITORY_XML
static String	MOUNTS_ZIP
static String	REFERENCES_ZIP
static String	REPOSITORY_XML
static String	ROLES_ZIP
static String	SERVER_PERMISSIONS_XML
static String	SITE_PROPERTIES
static String	STATIC_MOUNT_POINT_ATTR
static String	USERS_XML
static String	USERS_ZIP

Fields inherited from class org.jahia.services.JahiaService

settingsBean

Fields inherited from interface org.jahia.services.importexport.ImportExportService

DATE_FORMAT, FROM, INCLUDE_ALL_FILES, INCLUDE_DEFINITIONS, INCLUDE_LIVE_EXPORT, INCLUDE_MOUNTS, INCLUDE_ROLES, INCLUDE_SITE_INFOS, INCLUDE_TEMPLATES, INCLUDE_USERS, JAHIA_URI, NO_RECURSE, SERVER_DIRECTORY, SKIP_BINARY, SYSTEM_VIEW, TO, VIEW_ACL, VIEW_CONTENT, VIEW_JAHIALINKS, VIEW_METADATA, VIEW_PID, VIEW_VERSION, VIEW_WORKFLOW, XSL_PATH

Method Summary

Modifier and Type	Method and Description
void	cleanFilesList(File expandedFolder, List<String> fileList) Remove the list of files temporarily expanded to the given folder.
static String	detectImportContentType(String declaredContentType, String fileName) Helper method to determine which type of the import the uploaded file represents.
int	detectXmlFormat(InputStream is) Detects the type of the import from the provided stream.
JCRNodeWrapper	ensureDir(JCRSessionWrapper session, String path, JahiaSite site)
void	ensureFile(JCRSessionWrapper session, String path, InputStream inputStream, String type, JahiaSite destSite)
void	exportAll(OutputStream outputStream, Map<String,Object> params) Performs the full repository export into the provided output stream using the specified parameters.
void	exportNode(JCRNodeWrapper node, JCRNodeWrapper exportRoot, OutputStream out, Map<String,Object> params) Export JCR node as xml
void	exportSites(OutputStream outputStream, Map<String,Object> params, List<JCRSiteNode> sites) Export complete sites
void	exportZip(JCRNodeWrapper node, JCRNodeWrapper exportRoot, OutputStream out, Map<String,Object> params) Export JCR content along with binaries into a zip
List<AttributeProcessor>	getAttributeProcessors() Returns a list of configured attribute processors for the import.
File	getFileList(org.springframework.core.io.Resource file, Map<String,Long> sizes, List<String> fileList) Gets the list of files from the given ZIP file.
static ImportExportBaseService	getInstance()
void	importCategories(Category rootCategory, InputStream is) Performs the import of categories from the provided import stream into the specified root category.
void	importSiteZip(File file, JCRSessionWrapper session) Import the sitee from the specified file.
void	importSiteZip(JCRNodeWrapper nodeWrapper) Import the site from the specified file node.
void	importSiteZip(org.springframework.core.io.Resource file) Import the site from the specified resource.
void	importSiteZip(org.springframework.core.io.Resource file, JahiaSite site, Map<Object,Object> infos) Import a full site zip into a newly created site.
void	importSiteZip(org.springframework.core.io.Resource file, JahiaSite site, Map<Object,Object> infos, org.springframework.core.io.Resource legacyMappingFilePath, org.springframework.core.io.Resource legacyDefinitionsFilePath) Import a full site zip into a newly created site.
void	importSiteZip(org.springframework.core.io.Resource file, JahiaSite site, Map<Object,Object> infos, org.springframework.core.io.Resource legacyMappingFilePath, org.springframework.core.io.Resource legacyDefinitionsFilePath, JCRSessionWrapper session) Import a full site zip into a newly created site.
void	importSiteZip(org.springframework.core.io.Resource file, JCRSessionWrapper session) Import the site from the specified resource using the provided JCR session.
List<String[]>	importUsers(File file) Performs a batch import of users from the provided file
void	importXML(String parentNodePath, InputStream content, int rootBehavior) Performs an import of the XML content, detecting its type: users, categories or general JCR content.
void	importXML(String parentNodePath, InputStream content, int rootBehavior, Map<String,List<String>> references, JCRSessionWrapper session) Imports the provided content.
void	importZip(String parentNodePath, org.springframework.core.io.Resource file, int rootBehavior) Performs an import of the ZIP file.
void	importZip(String parentNodePath, org.springframework.core.io.Resource file, int rootBehaviour, JCRSessionWrapper session) Performs an import of the ZIP file.
void	importZip(String parentNodePath, org.springframework.core.io.Resource file, int rootBehaviour, JCRSessionWrapper session, Set<String> filesToIgnore, boolean useReferenceKeeper) Imports the content of the specified resource.
void	setAttributeProcessors(List<AttributeProcessor> attributeProcessors) Sets a list of configured attribute processors for the import.
void	setCategoryService(CategoryService categoryService) Injects an instance of the category service
void	setExpandImportedFilesOnDisk(boolean expandImportedFilesOnDisk)
void	setExpandImportedFilesOnDiskPath(String expandImportedFilesOnDiskPath)
void	setFileWatcherService(JahiaFileWatcherService fileWatcherService)
void	setJcrStoreService(JCRStoreService jcrStoreService)
void	setLegacyPidMappingTool(LegacyPidMappingTool legacyPidMappingTool)
void	setPostImportPatcher(PostImportPatcher postImportPatcher)
void	setSchedulerService(SchedulerService schedulerService)
void	setSitesService(JahiaSitesService sitesService)
void	setTemplatePackageRegistry(TemplatePackageRegistry templatePackageRegistry)
void	setXmlContentTransformers(List<XMLContentTransformer> xmlContentTransformers)
void	start()
void	stop()
void	update(Observable o, Object arg)
ValidationResults	validateImportFile(JCRSessionWrapper session, InputStream is, String contentType, List<String> installedModules) Validates a JCR content import file in document format and returns expected failures.

Methods inherited from class org.jahia.services.JahiaService

getSettingsBean, setSettingsBean

Methods inherited from class java.lang.Object

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

Field Detail

REPOSITORY_XML

public static final String REPOSITORY_XML

See Also:

Constant Field Values

LIVE_REPOSITORY_XML

public static final String LIVE_REPOSITORY_XML

See Also:

Constant Field Values

USERS_XML

public static final String USERS_XML

See Also:

Constant Field Values

USERS_ZIP

public static final String USERS_ZIP

See Also:

Constant Field Values

SERVER_PERMISSIONS_XML

public static final String SERVER_PERMISSIONS_XML

See Also:

Constant Field Values

SITE_PROPERTIES

public static final String SITE_PROPERTIES

See Also:

Constant Field Values

EXPORT_PROPERTIES

public static final String EXPORT_PROPERTIES

See Also:

Constant Field Values

MOUNTS_ZIP

public static final String MOUNTS_ZIP

See Also:

Constant Field Values

REFERENCES_ZIP

public static final String REFERENCES_ZIP

See Also:

Constant Field Values

ROLES_ZIP

public static final String ROLES_ZIP

See Also:

Constant Field Values

STATIC_MOUNT_POINT_ATTR

public static final String STATIC_MOUNT_POINT_ATTR

See Also:

Constant Field Values

DYNAMIC_MOUNT_POINT_ATTR

public static final String DYNAMIC_MOUNT_POINT_ATTR

See Also:

Constant Field Values

Method Detail

getInstance

public static ImportExportBaseService getInstance()

detectImportContentType

public static String detectImportContentType(String declaredContentType,
                                             String fileName)

Helper method to determine which type of the import the uploaded file represents.

Parameters:

declaredContentType - the declared content type

fileName - the uploaded file name

Returns:

type of the import the uploaded file represents

start

public void start()

Specified by:

start in class JahiaService

setExpandImportedFilesOnDisk

public void setExpandImportedFilesOnDisk(boolean expandImportedFilesOnDisk)

setExpandImportedFilesOnDiskPath

public void setExpandImportedFilesOnDiskPath(String expandImportedFilesOnDiskPath)

getAttributeProcessors

public List<AttributeProcessor> getAttributeProcessors()

Returns a list of configured attribute processors for the import.

Returns:

a list of configured attribute processors for the import

setAttributeProcessors

public void setAttributeProcessors(List<AttributeProcessor> attributeProcessors)

Sets a list of configured attribute processors for the import.

Parameters:

attributeProcessors - a list of configured attribute processors for the import

stop

public void stop()

Specified by:

stop in class JahiaService

setSitesService

public void setSitesService(JahiaSitesService sitesService)

setSchedulerService

public void setSchedulerService(SchedulerService schedulerService)

setJcrStoreService

public void setJcrStoreService(JCRStoreService jcrStoreService)

setFileWatcherService

public void setFileWatcherService(JahiaFileWatcherService fileWatcherService)

exportAll

public void exportAll(OutputStream outputStream,
                      Map<String,Object> params)
               throws JahiaException,
                      javax.jcr.RepositoryException,
                      IOException,
                      SAXException,
                      TransformerException

Description copied from interface: ImportExportService

Performs the full repository export into the provided output stream using the specified parameters.

Specified by:

exportAll in interface ImportExportService

Parameters:

outputStream - the output stream to write exported content into

params - the export options

Throws:

JahiaException - in case of processing errors

javax.jcr.RepositoryException - for JCR-related errors

IOException - I/O communication errors

SAXException - in case of a parsing exceptions

TransformerException - XSLT transformation errors

exportSites

public void exportSites(OutputStream outputStream,
                        Map<String,Object> params,
                        List<JCRSiteNode> sites)
                 throws javax.jcr.RepositoryException,
                        IOException,
                        SAXException,
                        TransformerException

Description copied from interface: ImportExportService

Export complete sites

Specified by:

exportSites in interface ImportExportService

Throws:

javax.jcr.RepositoryException - in case of JCR-related errors

IOException

SAXException

TransformerException

exportZip

public void exportZip(JCRNodeWrapper node,
                      JCRNodeWrapper exportRoot,
                      OutputStream out,
                      Map<String,Object> params)
               throws javax.jcr.RepositoryException,
                      SAXException,
                      IOException,
                      TransformerException

Description copied from interface: ImportExportService

Export JCR content along with binaries into a zip

Specified by:

exportZip in interface ImportExportService

Parameters:

node - node to export

out - outputstream

params - @throws JahiaException

Throws:

javax.jcr.RepositoryException - in case of JCR-related errors

SAXException

IOException

TransformerException

exportNode

public void exportNode(JCRNodeWrapper node,
                       JCRNodeWrapper exportRoot,
                       OutputStream out,
                       Map<String,Object> params)
                throws javax.jcr.RepositoryException,
                       SAXException,
                       IOException,
                       TransformerException

Description copied from interface: ImportExportService

Export JCR node as xml

Specified by:

exportNode in interface ImportExportService

Parameters:

node - node to export

out - outputstream

params - @throws JahiaException

Throws:

javax.jcr.RepositoryException - in case of JCR-related errors

SAXException

IOException

TransformerException

importSiteZip

public void importSiteZip(JCRNodeWrapper nodeWrapper)
                   throws javax.jcr.RepositoryException,
                          IOException,
                          JahiaException

Description copied from interface: ImportExportService

Import the site from the specified file node.

Specified by:

importSiteZip in interface ImportExportService

Parameters:

nodeWrapper - the file node to read content of the imported site from

Throws:

javax.jcr.RepositoryException - in case of a JCR error

IOException - in case of an I/O exception

JahiaException - if a processing error happens

importSiteZip

public void importSiteZip(File file,
                          JCRSessionWrapper session)
                   throws javax.jcr.RepositoryException,
                          IOException,
                          JahiaException

Description copied from interface: ImportExportService

Import the sitee from the specified file.

Specified by:

importSiteZip in interface ImportExportService

Parameters:

file - the file to read content of the imported site from

session - current JCR session instance

Throws:

javax.jcr.RepositoryException - in case of a JCR error

IOException - in case of an I/O exception

JahiaException - if a processing error happens

importSiteZip

public void importSiteZip(org.springframework.core.io.Resource file)
                   throws javax.jcr.RepositoryException,
                          IOException,
                          JahiaException

Description copied from interface: ImportExportService

Import the site from the specified resource.

Specified by:

importSiteZip in interface ImportExportService

Parameters:

file - the resource to read content of the imported site from

Throws:

javax.jcr.RepositoryException - in case of a JCR error

IOException - in case of an I/O exception

JahiaException - if a processing error happens

importSiteZip

public void importSiteZip(org.springframework.core.io.Resource file,
                          JCRSessionWrapper session)
                   throws javax.jcr.RepositoryException,
                          IOException

Description copied from interface: ImportExportService

Import the site from the specified resource using the provided JCR session.

Specified by:

importSiteZip in interface ImportExportService

Parameters:

file - the resource to read content of the imported site from

session - current JCR session to use for the import

Throws:

javax.jcr.RepositoryException - in case of a JCR error

IOException - in case of an I/O exception

importSiteZip

public void importSiteZip(org.springframework.core.io.Resource file,
                          JahiaSite site,
                          Map<Object,Object> infos)
                   throws javax.jcr.RepositoryException,
                          IOException

Description copied from interface: ImportExportService

Import a full site zip into a newly created site. zip file can contain all kind of legacy jahia import files or jcr import format.

Specified by:

importSiteZip in interface ImportExportService

Parameters:

file - Zip file

site - The new site where to import

infos - site infos

Throws:

javax.jcr.RepositoryException - in case of JCR-related errors

IOException

importSiteZip

public void importSiteZip(org.springframework.core.io.Resource file,
                          JahiaSite site,
                          Map<Object,Object> infos,
                          org.springframework.core.io.Resource legacyMappingFilePath,
                          org.springframework.core.io.Resource legacyDefinitionsFilePath)
                   throws javax.jcr.RepositoryException,
                          IOException

Description copied from interface: ImportExportService

Import a full site zip into a newly created site. zip file can contain all kind of legacy jahia import files or jcr import format.

Specified by:

importSiteZip in interface ImportExportService

Parameters:

file - Zip file

site - The new site where to import

infos - site infos

legacyMappingFilePath - path to the legacy mappings

legacyDefinitionsFilePath - path for the legacy definitions

Throws:

javax.jcr.RepositoryException - in case of JCR-related errors

IOException

importSiteZip

public void importSiteZip(org.springframework.core.io.Resource file,
                          JahiaSite site,
                          Map<Object,Object> infos,
                          org.springframework.core.io.Resource legacyMappingFilePath,
                          org.springframework.core.io.Resource legacyDefinitionsFilePath,
                          JCRSessionWrapper session)
                   throws javax.jcr.RepositoryException,
                          IOException

Import a full site zip into a newly created site.

zip file can contain all kind of legacy jahia import files or jcr import format.

Parameters:

file - Zip file

site - The new site where to import

infos - site infos

legacyMappingFilePath - path to the legacy mappings

legacyDefinitionsFilePath - path for the legacy definitions

session - the current JCR session to use for the import

Throws:

javax.jcr.RepositoryException - in case of JCR-related errors

IOException - in case of I/O errors

cleanFilesList

public void cleanFilesList(File expandedFolder,
                           List<String> fileList)

Remove the list of files temporarily expanded to the given folder.

Parameters:

expandedFolder - path to the expanded folder on disk - if null, do nothing

fileList - list of files expanded to disk

ensureDir

public JCRNodeWrapper ensureDir(JCRSessionWrapper session,
                                String path,
                                JahiaSite site)
                         throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

ensureFile

public void ensureFile(JCRSessionWrapper session,
                       String path,
                       InputStream inputStream,
                       String type,
                       JahiaSite destSite)

importCategories

public void importCategories(Category rootCategory,
                             InputStream is)

Description copied from interface: ImportExportService

Performs the import of categories from the provided import stream into the specified root category.

Specified by:

importCategories in interface ImportExportService

Parameters:

rootCategory - the root category to use

is - the input stream to read import content from

importUsers

public List<String[]> importUsers(File file)
                           throws IOException,
                                  javax.jcr.RepositoryException

Description copied from interface: ImportExportService

Performs a batch import of users from the provided file

Specified by:

importUsers in interface ImportExportService

Parameters:

file - a file to read user data from

Returns:

a list of tuples <username, password, homePage> for the imported users

Throws:

IOException - in case of a reading/parsing error

javax.jcr.RepositoryException

detectXmlFormat

public int detectXmlFormat(InputStream is)

Detects the type of the import from the provided stream.

Parameters:

is - the input stream to read imported content from

Returns:

the type of the import from the provided stream

See Also:

XMLFormatDetectionHandler

importXML

public void importXML(String parentNodePath,
                      InputStream content,
                      int rootBehavior)
               throws IOException,
                      javax.jcr.RepositoryException,
                      JahiaException

Description copied from interface: ImportExportService

Performs an import of the XML content, detecting its type: users, categories or general JCR content.

Specified by:

importXML in interface ImportExportService

Parameters:

parentNodePath - the path of the parent node, where the content should be imported

content - the XML content stream

rootBehavior - Ignore root xml element - can be used to import multiple nodes in the same node, using one single import

Throws:

IOException - in case of read/write errors

javax.jcr.RepositoryException - in case of repository operation errors

JahiaException - in case of errors during categories import

importXML

public void importXML(String parentNodePath,
                      InputStream content,
                      int rootBehavior,
                      Map<String,List<String>> references,
                      JCRSessionWrapper session)
               throws IOException,
                      javax.jcr.RepositoryException,
                      JahiaException

Imports the provided content.

Parameters:

parentNodePath - the node to use as a parent for the import

content - the input stream to read content from

rootBehavior - the root behaviour (see DocumentViewImportHandler)

session - current JCR session

Throws:

IOException - in case of an I/O operation error

javax.jcr.RepositoryException - in case of a JCR-related error

JahiaException - in case of a processing error

importZip

public void importZip(String parentNodePath,
                      org.springframework.core.io.Resource file,
                      int rootBehavior)
               throws IOException,
                      javax.jcr.RepositoryException

Description copied from interface: ImportExportService

Performs an import of the ZIP file. The format of XML files will be detected, as if they were imported with importXML(String, InputStream) method. Binary content will be

Specified by:

importZip in interface ImportExportService

rootBehavior - Ignore root xml element - can be used to import multiple nodes in the same node, using one single import

Throws:

IOException

javax.jcr.RepositoryException - in case of JCR-related errors

validateImportFile

public ValidationResults validateImportFile(JCRSessionWrapper session,
                                            InputStream is,
                                            String contentType,
                                            List<String> installedModules)

Validates a JCR content import file in document format and returns expected failures.

Specified by:

validateImportFile in interface ImportExportService

Parameters:

session - current JCR session instance

is - the input stream with a JCR content in document format

contentType - the content type for the content

installedModules - the list of installed modules, where the first element is a template set name

Returns:

the validation result

Since:

Jahia 6.6

importZip

public void importZip(String parentNodePath,
                      org.springframework.core.io.Resource file,
                      int rootBehaviour,
                      JCRSessionWrapper session)
               throws IOException,
                      javax.jcr.RepositoryException

Description copied from interface: ImportExportService

Performs an import of the ZIP file. The format of XML files will be detected, as if they were imported with importXML(String, InputStream) method. Binary content will be

Specified by:

importZip in interface ImportExportService

rootBehaviour - Ignore root xml element - can be used to import multiple nodes in the same node, using one single import

Throws:

IOException

javax.jcr.RepositoryException - in case of JCR-related errors

importZip

public void importZip(String parentNodePath,
                      org.springframework.core.io.Resource file,
                      int rootBehaviour,
                      JCRSessionWrapper session,
                      Set<String> filesToIgnore,
                      boolean useReferenceKeeper)
               throws IOException,
                      javax.jcr.RepositoryException

Imports the content of the specified resource.

Specified by:

importZip in interface ImportExportService

Parameters:

parentNodePath - the node to use as a parent for the import

file - the file with the content to be imported

rootBehaviour - the root behaviour (see DocumentViewImportHandler)

session - current JCR session

filesToIgnore - set of files to be skipped

Throws:

IOException - in case of an I/O operation error

javax.jcr.RepositoryException - in case of a JCR-related error

getFileList

public File getFileList(org.springframework.core.io.Resource file,
                        Map<String,Long> sizes,
                        List<String> fileList)
                 throws IOException

Gets the list of files from the given ZIP file. If expandImportedFilesOnDiskPath is set to true (in jahia.properties), then also expand the files to a temporary directory if it is not already expanded.

Parameters:

file - ZIP file with content to be imported

sizes - collection holding sizes of uncompressed file elements

fileList - collection into which the files from ZIP file will be added

Returns:

null if files were not expanded to disk (it is just optional), otherwise path to temporary local folder

Throws:

IOException

setCategoryService

public void setCategoryService(CategoryService categoryService)

Injects an instance of the category service

Parameters:

categoryService - category service instance

setXmlContentTransformers

public void setXmlContentTransformers(List<XMLContentTransformer> xmlContentTransformers)

setLegacyPidMappingTool

public void setLegacyPidMappingTool(LegacyPidMappingTool legacyPidMappingTool)

setPostImportPatcher

public void setPostImportPatcher(PostImportPatcher postImportPatcher)

setTemplatePackageRegistry

public void setTemplatePackageRegistry(TemplatePackageRegistry templatePackageRegistry)

update

public void update(Observable o,
                   Object arg)

Specified by:

update in interface Observer