Package org.broadleafcommerce.common.copy

Class MultiTenantCopier

java.lang.Object

org.broadleafcommerce.common.copy.MultiTenantCopier

All Implemented Interfaces:

org.springframework.core.Ordered

Direct Known Subclasses:

EntityDuplicatorImpl

public abstract class MultiTenantCopier
extends Object
implements org.springframework.core.Ordered

Abstract class for copying entities to a new catalog as required during derived catalog propagation. Subclasses generally call copyEntitiesOfType(Class, org.broadleafcommerce.common.site.domain.Site, org.broadleafcommerce.common.site.domain.Catalog, MultiTenantCopyContext) one or more times inside of their copyEntities(MultiTenantCopyContext) implementation to clone and persist an entity object tree.

Author:

Andre Azzolini (apazzolini), Jeff Fischer

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	catalogCopierOptimizationEnabled
protected List<Pattern>	classExcludeRegexPatternList	To add elements use addPattern(Pattern)
protected MultiTenantCopierExtensionManager	extensionManager
protected GenericEntityService	genericEntityService
protected static final org.apache.commons.logging.Log	LOG
protected int	order
protected StreamingTransactionCapableUtil	transUtil

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
MultiTenantCopier()

Method Summary

Modifier and Type	Method	Description
protected void	addPattern(Pattern pattern)	Checks for similar items before adding to avoid duplication
abstract void	copyEntities(MultiTenantCopyContext context)	Main method that should be implemented by each MultiTenantCopier to drive the logic of copying that particular entity to the new derived catalog.
protected <T extends MultiTenantCloneable> void	copyEntitiesOfType(Class<T> clazz, Site fromSite, Catalog fromCatalog, MultiTenantCopyContext context)	Subclasses will generally call this method in their copyEntities(MultiTenantCopyContext) implementation.
protected boolean	dontTraversThroughEntityFromTheDB(Object copy, MultiTenantCopyContext context)
protected Boolean	excludeFromCopyRegexPattern(Object copy)
int	getOrder()
protected boolean	needToAdd(Pattern pattern)
protected <T, G extends Exception> void	persistCopyObjectTree(CopyOperation<T,G> copyOperation, Class<T> clazz, T original, MultiTenantCopyContext context)
protected void	persistCopyObjectTreeInternal(Object copy, Set<Integer> library, MultiTenantCopyContext context)
protected void	persistNode(Object copy, MultiTenantCopyContext context)
protected <T> List<T>	readAll(Class<T> clazz, int limit, int offset, Site site, Catalog catalog)	Returns a list of all entities in the system for the given class, site, and catalog.
protected <T> List<T>	readAll(Class<T> clazz, Site site, Catalog catalog)
protected List<Long>	readAllIds(Class<?> clazz, Site site, Catalog catalog)	Returns the primary key values for all entities of the specified type in the site or catalog.
protected <T> Long	readCount(Class<T> clazz, Site site, Catalog catalog)	Returns the count of the given entity class for the specified site and catalog
protected <T> T	save(MultiTenantCopyContext context, T object)	Saves the specified object in the toSite and toCatalog of the given context.
void	setOrder(int order)

Methods inherited from class java.lang.Object

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

Field Details

LOG

protected static final org.apache.commons.logging.Log LOG

genericEntityService

protected GenericEntityService genericEntityService

extensionManager

protected MultiTenantCopierExtensionManager extensionManager

transUtil

protected StreamingTransactionCapableUtil transUtil

catalogCopierOptimizationEnabled

@Value("${catalog.copier.optimization.enabled:false}")
protected boolean catalogCopierOptimizationEnabled

order

protected int order

classExcludeRegexPatternList

protected List<Pattern> classExcludeRegexPatternList

To add elements use addPattern(Pattern)

Constructor Details

MultiTenantCopier

public MultiTenantCopier()

Method Details

copyEntities

public abstract void copyEntities(MultiTenantCopyContext context)
                           throws Exception

Main method that should be implemented by each MultiTenantCopier to drive the logic of copying that particular entity to the new derived catalog.

Parameters:

context -

Throws:

Exception

getOrder

public int getOrder()

Specified by:

getOrder in interface org.springframework.core.Ordered

Returns:

the order of this MultiTenantCopier

setOrder

public void setOrder(int order)

persistCopyObjectTree

protected <T,
G extends Exception> void persistCopyObjectTree(CopyOperation<T,G> copyOperation,
 Class<T> clazz,
 T original,
 MultiTenantCopyContext context)
                                                      throws G

Throws:

G extends Exception

persistCopyObjectTreeInternal

protected void persistCopyObjectTreeInternal(Object copy,
 Set<Integer> library,
 MultiTenantCopyContext context)

dontTraversThroughEntityFromTheDB

protected boolean dontTraversThroughEntityFromTheDB(Object copy,
 MultiTenantCopyContext context)

excludeFromCopyRegexPattern

protected Boolean excludeFromCopyRegexPattern(Object copy)

Parameters:

copy - Copy object

Returns:

excluded or not in patterns

persistNode

protected void persistNode(Object copy,
 MultiTenantCopyContext context)

copyEntitiesOfType

protected <T extends MultiTenantCloneable> void copyEntitiesOfType(Class<T> clazz,
 Site fromSite,
 Catalog fromCatalog,
 MultiTenantCopyContext context)
                                                            throws ServiceException,
CloneNotSupportedException

Subclasses will generally call this method in their copyEntities(MultiTenantCopyContext) implementation.

Type Parameters:

T -

Parameters:

clazz -

fromSite -

fromCatalog -

context -

Throws:

ServiceException

CloneNotSupportedException

save

protected <T> T save(MultiTenantCopyContext context,
 T object)
              throws ServiceException

Saves the specified object in the toSite and toCatalog of the given context.

Parameters:

context -

object -

Returns:

the saved entity

Throws:

ServiceException

readCount

protected <T> Long readCount(Class<T> clazz,
 Site site,
 Catalog catalog)
                      throws ServiceException

Returns the count of the given entity class for the specified site and catalog

Parameters:

clazz -

site -

catalog -

Returns:

the count

Throws:

ServiceException

readAll

protected <T> List<T> readAll(Class<T> clazz,
 Site site,
 Catalog catalog)
                       throws ServiceException

Parameters:

clazz -

site -

catalog -

Returns:

the list of entities for the specified parameters

Throws:

ServiceException

See Also:

• readAll(Class, int, int, Site, Catalog)

readAllIds

protected List<Long> readAllIds(Class<?> clazz,
 Site site,
 Catalog catalog)
                         throws ServiceException

Returns the primary key values for all entities of the specified type in the site or catalog.

Parameters:

clazz -

site -

catalog -

Returns:

Throws:

ServiceException

readAll

protected <T> List<T> readAll(Class<T> clazz,
 int limit,
 int offset,
 Site site,
 Catalog catalog)
                       throws ServiceException

Returns a list of all entities in the system for the given class, site, and catalog. Additionally, this method supports pagination.

Parameters:

clazz -

limit -

offset -

site -

catalog -

Returns:

the list of entities for the specified parameters

Throws:

ServiceException

addPattern

protected void addPattern(Pattern pattern)

Checks for similar items before adding to avoid duplication

Parameters:

pattern - input pattern

needToAdd

protected boolean needToAdd(Pattern pattern)