org.jahia.services.importexport

Interface XMLContentTransformer

public interface XMLContentTransformer

A XMLContentTransformer performs some modifications in a Jahia exported content xml file. It can be used when the content structure does not fit the set of templates used to import it. To use this feature, the first step is to define one or more implementations of this interface, and then to declare it in the WEB-INF/etc/spring/applicationcontext-services.xml configuration file of the Jahia application.

<bean id="ImportExportService" parent="proxyTemplate"> <property name="target"> <bean class="org.jahia.services.importexport.ImportExportBaseService" parent="jahiaServiceTemplate" factory-method="getInstance">

...

<property name="xmlContentTransformers"> <list> <bean class="org.myProject.AnImplementation" /> <bean class="org.myProject.AnOtherImplementation" /> </list> </property> </bean> </property> </bean>

This interface provides the transform() method that will be called by the import feature. Several implementations can be used to simplify the code, for example focusing on a single modification in the xml file. In this case, the different declared implementations will be processed sequencially. It is very important to keep in mind that the output of the last processed Object has to be a Jahia compliant content export file, as it will be processed by the import feature, instead of the initial file.

Method Summary

Modifier and Type	Method and Description
File	transform(File input) Performs some custom modifications in an Jahia exported content xml file, and returns the updated file.
File	transform(File input, File tmpDirectory) Performs some custom modifications in an Jahia exported content xml file, and returns the updated file.

Method Detail

transform

File transform(File input)

Performs some custom modifications in an Jahia exported content xml file, and returns the updated file.

Parameters:

input - A Jahia exported content xml file

Returns:

The updated file

transform

File transform(File input,
               File tmpDirectory)

Performs some custom modifications in an Jahia exported content xml file, and returns the updated file.

Parameters:

input - A Jahia exported content xml file

tmpDirectory - Temporary directory where the XMLContentTransformer should write some output for troubleshooting purpose

Returns:

The updated file