org.jahia.services.importexport

Interface ImportExportService

All Known Implementing Classes:

ImportExportBaseService

public interface ImportExportService

Jahia import/export service to manipulate different types of content.

Author:

toto

Field Summary

Fields

Modifier and Type	Field and Description
static String	DATE_FORMAT
static String	FROM
static String	INCLUDE_ALL_FILES
static String	INCLUDE_DEFINITIONS
static String	INCLUDE_LIVE_EXPORT
static String	INCLUDE_MOUNTS
static String	INCLUDE_ROLES
static String	INCLUDE_SITE_INFOS
static String	INCLUDE_TEMPLATES
static String	INCLUDE_USERS
static String	JAHIA_URI
static String	NO_RECURSE
static String	SERVER_DIRECTORY
static String	SKIP_BINARY
static String	SYSTEM_VIEW
static String	TO
static String	VIEW_ACL
static String	VIEW_CONTENT
static String	VIEW_JAHIALINKS
static String	VIEW_METADATA
static String	VIEW_PID
static String	VIEW_VERSION
static String	VIEW_WORKFLOW
static String	XSL_PATH

Method Summary

Modifier and Type	Method and Description
void	exportAll(OutputStream out, 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
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 resource) 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 resource, 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	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 rootBehavior, 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) Performs an import of the ZIP file.
ValidationResults	validateImportFile(JCRSessionWrapper session, InputStream is, String contentType, List<String> installedModules) Validates a JCR content import file in document format and returns expected failures.

Field Detail

DATE_FORMAT

static final String DATE_FORMAT

See Also:

Constant Field Values

JAHIA_URI

static final String JAHIA_URI

See Also:

Constant Field Values

FROM

static final String FROM

See Also:

Constant Field Values

TO

static final String TO

See Also:

Constant Field Values

INCLUDE_TEMPLATES

static final String INCLUDE_TEMPLATES

See Also:

Constant Field Values

INCLUDE_SITE_INFOS

static final String INCLUDE_SITE_INFOS

See Also:

Constant Field Values

INCLUDE_ALL_FILES

static final String INCLUDE_ALL_FILES

See Also:

Constant Field Values

INCLUDE_DEFINITIONS

static final String INCLUDE_DEFINITIONS

See Also:

Constant Field Values

INCLUDE_LIVE_EXPORT

static final String INCLUDE_LIVE_EXPORT

See Also:

Constant Field Values

INCLUDE_USERS

static final String INCLUDE_USERS

See Also:

Constant Field Values

INCLUDE_ROLES

static final String INCLUDE_ROLES

See Also:

Constant Field Values

INCLUDE_MOUNTS

static final String INCLUDE_MOUNTS

See Also:

Constant Field Values

VIEW_CONTENT

static final String VIEW_CONTENT

See Also:

Constant Field Values

VIEW_VERSION

static final String VIEW_VERSION

See Also:

Constant Field Values

VIEW_METADATA

static final String VIEW_METADATA

See Also:

Constant Field Values

VIEW_JAHIALINKS

static final String VIEW_JAHIALINKS

See Also:

Constant Field Values

VIEW_ACL

static final String VIEW_ACL

See Also:

Constant Field Values

VIEW_WORKFLOW

static final String VIEW_WORKFLOW

See Also:

Constant Field Values

VIEW_PID

static final String VIEW_PID

See Also:

Constant Field Values

XSL_PATH

static final String XSL_PATH

See Also:

Constant Field Values

NO_RECURSE

static final String NO_RECURSE

See Also:

Constant Field Values

SKIP_BINARY

static final String SKIP_BINARY

See Also:

Constant Field Values

SYSTEM_VIEW

static final String SYSTEM_VIEW

See Also:

Constant Field Values

SERVER_DIRECTORY

static final String SERVER_DIRECTORY

See Also:

Constant Field Values

Method Detail

exportAll

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

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

Parameters:

out - 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

SAXException - in case of a parsing exceptions

IOException - I/O communication errors

TransformerException - XSLT transformation errors

exportSites

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

Export complete sites

Parameters:

outputStream -

params -

sites -

Throws:

JahiaException

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

IOException

SAXException

TransformerException

exportNode

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

Export JCR node as xml

Parameters:

node - node to export

exportRoot -

out - outputstream

params - @throws JahiaException

Throws:

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

SAXException

IOException

TransformerException

exportZip

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

Export JCR content along with binaries into a zip

Parameters:

node - node to export

exportRoot -

out - outputstream

params - @throws JahiaException

Throws:

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

SAXException

IOException

TransformerException

importXML

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

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

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

importZip

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

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

Parameters:

parentNodePath -

file -

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

JahiaException

importZip

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

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

Parameters:

parentNodePath -

file -

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

JahiaException

importZip

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

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

Parameters:

parentNodePath -

file -

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

filesToIgnore - Files to ignore

references - References map

Throws:

IOException

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

JahiaException

validateImportFile

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

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

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

importSiteZip

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

Import the site from the specified file node.

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

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

Import the sitee from the specified file.

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

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

Import the site from the specified resource.

Parameters:

resource - 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

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

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

Parameters:

resource - 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

JahiaException - if a processing error happens

importSiteZip

void importSiteZip(org.springframework.core.io.Resource file,
                   JahiaSite site,
                   Map<Object,Object> infos)
            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

Throws:

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

IOException

importSiteZip

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

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

Throws:

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

IOException

importCategories

void importCategories(Category rootCategory,
                      InputStream is)

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

Parameters:

rootCategory - the root category to use

is - the input stream to read import content from

importUsers

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

Performs a batch import of users from the provided file

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