de.hybris.platform.patches.service

Interface PatchImportService

All Known Implementing Classes:

DefaultPatchImportService

public interface PatchImportService

Patches specific impex import service. It is responsible for importing data based on impexImportUnit and creating ImpexImportUnitResult.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	IMPEX_IMPORT_CRON_JOB_REMOVE_ON_SUCCESS_PROPERTY_KEY Property to disable removing impex import cron job after successful import
static java.lang.String	IMPEX_IMPORT_FAIL_ON_ERROR_PROPERTY_KEY Property to disable failing impex import on error

Method Summary

Modifier and Type	Method and Description
java.io.SequenceInputStream	getStreamForImpexImportUnit(ImpexImportUnit impexImportUnit) Method prepares SequenceInputStream based on impexImportUnit.
ImpexImportUnitResult	importImpexUnit(ImpexImportUnit impexImportUnit) Method for importing impex data based on ImpexImportUnit.
ImpexImportUnitResult	importImpexUnitWithoutTracking(ImpexImportUnit impexImportUnit) Method is workaround not to execute the aspect.

Field Detail

IMPEX_IMPORT_CRON_JOB_REMOVE_ON_SUCCESS_PROPERTY_KEY

static final java.lang.String IMPEX_IMPORT_CRON_JOB_REMOVE_ON_SUCCESS_PROPERTY_KEY

Property to disable removing impex import cron job after successful import

See Also:

Constant Field Values

IMPEX_IMPORT_FAIL_ON_ERROR_PROPERTY_KEY

static final java.lang.String IMPEX_IMPORT_FAIL_ON_ERROR_PROPERTY_KEY

Property to disable failing impex import on error

See Also:

Constant Field Values

Method Detail

importImpexUnit

ImpexImportUnitResult importImpexUnit(ImpexImportUnit impexImportUnit)

Method for importing impex data based on ImpexImportUnit. ImpexImportUnitResult data is created after import with information about import result.

Parameters:

impexImportUnit - unit which keeps all data

Returns:

ImpexImportUnitResult - object keeps information about impexImportUnit and import result

Throws:

PatchImportException - when there is

• FileNotFoundException - impex data file or mandatory header file is missing
• SystemException - problems related to model initialization, model saving or model not found, interceptor exceptions
• IllegalArgumentException - there is no script for import configuration or there is model type not supported exception
• IllegalStateException - during performing cron job when underlying source for given model doesn't exist

All these kind of exceptions are caught, packed to PatchImportException and thrown further.

importImpexUnitWithoutTracking

ImpexImportUnitResult importImpexUnitWithoutTracking(ImpexImportUnit impexImportUnit)

Method is workaround not to execute the aspect. It is used to execute importImpexUnit without tracking.

Parameters:

impexImportUnit - unit which keeps all data

Returns:

ImpexImportUnitResult - object keeps information about impexImportUnit and import result

Throws:

PatchImportException

getStreamForImpexImportUnit

java.io.SequenceInputStream getStreamForImpexImportUnit(ImpexImportUnit impexImportUnit)
                                                 throws java.io.FileNotFoundException

Method prepares SequenceInputStream based on impexImportUnit. It combines stream based on macro list, header files and data file.

Parameters:

impexImportUnit - unit which keeps all data

Returns:

SequenceInputStream keeps all data from impexImportUnit in one stream

Throws:

java.io.FileNotFoundException - when a given impex file cannot be found