de.hybris.platform.commerceservices.setup.impl

Class DefaultSetupImpexService

java.lang.Object

de.hybris.platform.commerceservices.setup.impl.DefaultSetupImpexService

All Implemented Interfaces:

SetupImpexService

Direct Known Subclasses:

DefaultSetupImpexAddOnService

public class DefaultSetupImpexService
extends java.lang.Object
implements SetupImpexService

Default implementation of SetupImpexService.

Constructor Summary

Constructors

Constructor and Description
DefaultSetupImpexService()

Method Summary

Modifier and Type	Method and Description
protected CommonI18NService	getCommonI18NService()
protected java.lang.String	getFileEncoding()
protected java.lang.String	getImpexExt()
protected ImportService	getImportService()
void	importImpexFile(java.lang.String file, boolean errorIfMissing) Import impex file.
void	importImpexFile(java.lang.String file, boolean errorIfMissing, boolean legacyMode) Import impex file.
boolean	importImpexFile(java.lang.String file, ImpexMacroParameterData macroParameters, boolean errorIfMissing)
boolean	importImpexFile(java.lang.String file, ImpexMacroParameterData macroParameters, boolean errorIfMissing, boolean legacyMode)
protected void	importImpexFile(java.lang.String file, java.io.InputStream stream, boolean legacyMode)
boolean	importImpexFile(java.lang.String file, java.util.Map<java.lang.String,java.lang.Object> macroParameters, boolean errorIfMissing)
boolean	importImpexFile(java.lang.String file, java.util.Map<java.lang.String,java.lang.Object> macroParameters, boolean errorIfMissing, boolean legacyMode)
void	setCommonI18NService(CommonI18NService commonI18NService)
void	setFileEncoding(java.lang.String fileEncoding)
void	setImpexExt(java.lang.String impexExt)
void	setImportService(ImportService importService)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultSetupImpexService

public DefaultSetupImpexService()

Method Detail

getFileEncoding

protected java.lang.String getFileEncoding()

setFileEncoding

public void setFileEncoding(java.lang.String fileEncoding)

getImpexExt

protected java.lang.String getImpexExt()

setImpexExt

public void setImpexExt(java.lang.String impexExt)

getCommonI18NService

protected CommonI18NService getCommonI18NService()

setCommonI18NService

public void setCommonI18NService(CommonI18NService commonI18NService)

getImportService

protected ImportService getImportService()

setImportService

public void setImportService(ImportService importService)

importImpexFile

public void importImpexFile(java.lang.String file,
                            boolean errorIfMissing)

Description copied from interface: SetupImpexService

Import impex file. The file is looked up from the classpath. If the file does not exist then an info message is logged. The file should used the ".impex" file extension. Any language specific files are found with the same root file name then they are also imported. Language specific files have the language iso code appended to the file name using an underscore as a separator. For example if the file /path/file.impex is imported and the language specific file /path/file_de.impex exists, then it will also be imported. Only files for languages that exist in the hybris system will be imported. By default this method imports the impex data with legacy mode set to false.

Specified by:

importImpexFile in interface SetupImpexService

Parameters:

file - the file path to import

errorIfMissing - flag, set to true to error if the file is not found

importImpexFile

public void importImpexFile(java.lang.String file,
                            boolean errorIfMissing,
                            boolean legacyMode)

Description copied from interface: SetupImpexService

Import impex file. The file is looked up from the classpath. If the file does not exist then an info message is logged. The file should used the ".impex" file extension. Any language specific files are found with the same root file name then they are also imported. Language specific files have the language iso code appended to the file name using an underscore as a separator. For example if the file /path/file.impex is imported and the language specific file /path/file_de.impex exists, then it will also be imported. Only files for languages that exist in the hybris system will be imported.

Specified by:

importImpexFile in interface SetupImpexService

Parameters:

file - the file path to import

errorIfMissing - flag, set to true to error if the file is not found

legacyMode - flag, set to true to use legacy impex mode

importImpexFile

protected void importImpexFile(java.lang.String file,
                               java.io.InputStream stream,
                               boolean legacyMode)

importImpexFile

public boolean importImpexFile(java.lang.String file,
                               java.util.Map<java.lang.String,java.lang.Object> macroParameters,
                               boolean errorIfMissing,
                               boolean legacyMode)

Specified by:

importImpexFile in interface SetupImpexService

Parameters:

file - the file path to import

macroParameters - the macro parameters

errorIfMissing - flag, set to true to error if the file is not found

legacyMode - flag, set to true to use legacy impex mode

Returns:

false for default implementation

importImpexFile

public boolean importImpexFile(java.lang.String file,
                               java.util.Map<java.lang.String,java.lang.Object> macroParameters,
                               boolean errorIfMissing)

Specified by:

importImpexFile in interface SetupImpexService

Parameters:

file - the file path to import

macroParameters - the macro parameters

errorIfMissing - flag, set to true to error if the file is not found

Returns:

false for default implementation

importImpexFile

public boolean importImpexFile(java.lang.String file,
                               ImpexMacroParameterData macroParameters,
                               boolean errorIfMissing,
                               boolean legacyMode)

Specified by:

importImpexFile in interface SetupImpexService

Parameters:

file - the file path to import

macroParameters - the macro parameters

errorIfMissing - flag, set to true to error if the file is not found

legacyMode - flag, set to true to use legacy impex mode

Returns:

false for default implementation

importImpexFile

public boolean importImpexFile(java.lang.String file,
                               ImpexMacroParameterData macroParameters,
                               boolean errorIfMissing)

Specified by:

importImpexFile in interface SetupImpexService

Parameters:

file - the file path to import

macroParameters - the macro parameters

errorIfMissing - flag, set to true to error if the file is not found

Returns:

false for default implementation