Package org.broadleafcommerce.common.persistence

Class EntityDuplicatorImpl

java.lang.Object

org.broadleafcommerce.common.copy.MultiTenantCopier

org.broadleafcommerce.common.persistence.EntityDuplicatorImpl

All Implemented Interfaces:

EntityDuplicator, org.springframework.core.Ordered

@Service("blEntityDuplicator")
public class EntityDuplicatorImpl
extends MultiTenantCopier
implements EntityDuplicator

Author:

Jeff Fischer

See Also:

• EntityDuplicator

Field Summary

Fields

Modifier and Type	Field	Description
protected Collection<EntityDuplicationHelper>	entityDuplicationHelpers
protected EntityDuplicatorExtensionManager	extensionManager
protected boolean	isActive
protected MultiTenantCopierExtensionManager	mtCopierExtensionManager

Fields inherited from class org.broadleafcommerce.common.copy.MultiTenantCopier

catalogCopierOptimizationEnabled, classExcludeRegexPatternList, genericEntityService, LOG, order, transUtil

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
EntityDuplicatorImpl()

Method Summary

Modifier and Type	Method	Description
<T> T	copy(Class<T> entityClass, Long id)	Create a production duplicate of the entity specified in the params.
<T> T	copy(Class<T> entityClass, Long id, Map<String,String> copyHints, EntityDuplicateModifier... modifiers)	Deprecated.
<T> T	copy(MultiTenantCopyContext context, MultiTenantCloneable<T> entity)	Create a production duplicate of the entity specified in the params.
<T> T	copy(MultiTenantCopyContext context, MultiTenantCloneable<T> entity, Map<String,String> copyHints, EntityDuplicateModifier... modifiers)	Deprecated.
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 Set<EntityDuplicationHelper>	filterDuplicationHelpers(MultiTenantCloneable entity)
protected <T> T	performCopy(MultiTenantCopyContext context, MultiTenantCloneable<T> entity)
protected <T> T	performCopy(MultiTenantCopyContext context, MultiTenantCloneable<T> entity, Map<String,String> copyHints, EntityDuplicateModifier... modifiers)	Deprecated.
protected void	putAllCopyHints(MultiTenantCopyContext context, Set<EntityDuplicationHelper> helpers)
boolean	validate(Class<?> entityClass, Long id)	Validate whether or not this feature is enabled and whether the passed entity params are valid for duplication.
boolean	validate(Object entity)	Validate whether or not this feature is enabled and whether or not the passed entity params are valid for duplication.

Methods inherited from class org.broadleafcommerce.common.copy.MultiTenantCopier

addPattern, copyEntitiesOfType, dontTraversThroughEntityFromTheDB, excludeFromCopyRegexPattern, getOrder, needToAdd, persistCopyObjectTree, persistCopyObjectTreeInternal, persistNode, readAll, readAll, readAllIds, readCount, save, setOrder

Methods inherited from class java.lang.Object

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

Field Details

isActive

@Value("${admin.entity.duplication.isactive:false}")
protected boolean isActive

extensionManager

protected EntityDuplicatorExtensionManager extensionManager

mtCopierExtensionManager

protected MultiTenantCopierExtensionManager mtCopierExtensionManager

entityDuplicationHelpers

protected Collection<EntityDuplicationHelper> entityDuplicationHelpers

Constructor Details

EntityDuplicatorImpl

public EntityDuplicatorImpl()

Method Details

copyEntities

public void copyEntities(MultiTenantCopyContext context)
                  throws Exception

Description copied from class: MultiTenantCopier

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

Specified by:

copyEntities in class MultiTenantCopier

Throws:

Exception

validate

public boolean validate(Class<?> entityClass,
 Long id)

Description copied from interface: EntityDuplicator

Validate whether or not this feature is enabled and whether the passed entity params are valid for duplication.

Specified by:

validate in interface EntityDuplicator

Returns:

validate

public boolean validate(Object entity)

Description copied from interface: EntityDuplicator

Validate whether or not this feature is enabled and whether or not the passed entity params are valid for duplication.

Specified by:

validate in interface EntityDuplicator

Returns:

copy

@Deprecated
public <T> T copy(Class<T> entityClass,
 Long id,
 Map<String,String> copyHints,
 EntityDuplicateModifier... modifiers)

Deprecated.

Instead of passing in EntityDuplicateModifiers, add the beans to EntityDuplicationHelpers. Additionally, add copy hints to the helpers. Also, note that you should implement AbstractEntityDuplicationHelper now instead as EntityDuplicateModifier is deprecated.

Specified by:

copy in interface EntityDuplicator

copy

@Deprecated
public <T> T copy(MultiTenantCopyContext context,
 MultiTenantCloneable<T> entity,
 Map<String,String> copyHints,
 EntityDuplicateModifier... modifiers)

Deprecated.

Instead of passing in EntityDuplicateModifiers, add the beans to EntityDuplicationHelpers. Additionally, add copy hints to the helpers. Also, note that you should implement AbstractEntityDuplicationHelper now instead as EntityDuplicateModifier is deprecated.

Specified by:

copy in interface EntityDuplicator

copy

@Transactional("blTransactionManager")
public <T> T copy(Class<T> entityClass,
 Long id)

Description copied from interface: EntityDuplicator

Create a production duplicate of the entity specified in the params. The is the most oft used copy method.

Specified by:

copy in interface EntityDuplicator

Type Parameters:

T - the entity type

Parameters:

entityClass - the class for the entity

id - the primary key

Returns:

the duplicated entity

copy

@Transactional("blTransactionManager")
public <T> T copy(MultiTenantCopyContext context,
 MultiTenantCloneable<T> entity)

Description copied from interface: EntityDuplicator

Create a production duplicate of the entity specified in the params. The is the least oft used copy method.

Specified by:

copy in interface EntityDuplicator

Type Parameters:

T - the entity type

Parameters:

context - prepopulated copy context that is setup for catalog and/or site

entity - the instance to duplicate

Returns:

the duplicated entity

performCopy

@Deprecated
protected <T> T performCopy(MultiTenantCopyContext context,
 MultiTenantCloneable<T> entity,
 Map<String,String> copyHints,
 EntityDuplicateModifier... modifiers)
                     throws Exception

Deprecated.

Instead of passing in EntityDuplicateModifiers, add the beans to EntityDuplicationHelpers. Additionally, add copy hints to the helpers. Also, note that you should implement AbstractEntityDuplicationHelper now instead as EntityDuplicateModifier is deprecated.

Throws:

Exception

performCopy

protected <T> T performCopy(MultiTenantCopyContext context,
 MultiTenantCloneable<T> entity)
                     throws Exception

Throws:

Exception

filterDuplicationHelpers

protected Set<EntityDuplicationHelper> filterDuplicationHelpers(MultiTenantCloneable entity)

putAllCopyHints

protected void putAllCopyHints(MultiTenantCopyContext context,
 Set<EntityDuplicationHelper> helpers)