Package com.broadleafcommerce.dataimport.service

Class DefaultImportSpecificationService

java.lang.Object

com.broadleafcommerce.dataimport.service.DefaultImportSpecificationService

All Implemented Interfaces:

ImportSpecificationService

@DataRouteByExample(Import.class)
public class DefaultImportSpecificationService
extends Object
implements ImportSpecificationService

Default service to fetch ImportSpecification and GlobalImportSpecification instances.

NOTE: Specifications are static at this time. They are pre-configured and not context-discriminated. Those who wish to support context-specific specifications should override this class and its methods to filter to such instances accordingly. TODO: Eventually, Broadleaf plans to introduce dynamic specifications and more robust mechanisms for different specifications on a per-tenant or per-application basis.

Author:

Kelly Tisdell (ktisdell)

Constructor Summary

Constructors

Constructor	Description
DefaultImportSpecificationService(List<ImportSpecification> importSpecifications)

Method Summary

Modifier and Type	Method	Description
List<GlobalImportSpecification>	findAllGlobalImportSpecifications(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	By default, this just finds all GlobalImportSpecification, with no regard for contextInfo.
protected ImportSpecification	findDefaultImportSpecification(String importType, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
ImportSpecification	findImportSpecification(String type, String specificationRef, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	By default, this just finds the first specification that can handle the given import type, with no regard for contextInfo or specificationRef.

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultImportSpecificationService

public DefaultImportSpecificationService(List<ImportSpecification> importSpecifications)

Method Details

findImportSpecification

public ImportSpecification findImportSpecification(String type,
 @Nullable
 String specificationRef,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

By default, this just finds the first specification that can handle the given import type, with no regard for contextInfo or specificationRef.

Specified by:

findImportSpecification in interface ImportSpecificationService

Parameters:

type - the import type for which to find the specification for

specificationRef - the ImportRequest.getSpecificationRef() and Import.getSpecificationRef() to find the specification for

contextInfo - the 'importing' context info, which should match the context the import will actually be performed in

Returns:

the first specification that matches the requested type, else a generic DefaultSpecification

See Also:

• findImportSpecification(String, String, ContextInfo)

findDefaultImportSpecification

protected ImportSpecification findDefaultImportSpecification(String importType,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

findAllGlobalImportSpecifications

public List<GlobalImportSpecification> findAllGlobalImportSpecifications(@Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

By default, this just finds all GlobalImportSpecification, with no regard for contextInfo.

Specified by:

findAllGlobalImportSpecifications in interface ImportSpecificationService

Parameters:

contextInfo - the 'importing' context info, which should match the context the import will actually be performed in

Returns:

all global import specifications