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(value="blEntityDuplicator")
public class EntityDuplicatorImpl
extends MultiTenantCopier
implements EntityDuplicator

Author:

Jeff Fischer

See Also:

EntityDuplicator

Field Summary

Fields

Modifier and Type	Field and Description
protected EntityDuplicatorExtensionManager	extensionManager
protected boolean	isActive
protected MultiTenantCopierExtensionManager	mtCopierExtensionManager

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

classExcludeRegexList, genericEntityService, LOG, order, transUtil

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
EntityDuplicatorImpl()

Method Summary

Modifier and Type	Method and Description
<T> T	copy(Class<T> entityClass, Long id, Map<String,String> copyHints, EntityDuplicateModifier... modifiers) 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) Create a production duplicate of the entity specified in the params.
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> T	performCopy(MultiTenantCopyContext context, MultiTenantCloneable<T> entity, Map<String,String> copyHints, EntityDuplicateModifier... modifiers)
boolean	validate(Class<?> entityClass, Long id) Validate whether or not this feature is enabled and whether or not 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

copyEntitiesOfType, excludeFromCopyRegex, getOrder, 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 Detail

isActive

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

extensionManager

protected EntityDuplicatorExtensionManager extensionManager

mtCopierExtensionManager

protected MultiTenantCopierExtensionManager mtCopierExtensionManager

Constructor Detail

EntityDuplicatorImpl

public EntityDuplicatorImpl()

Method Detail

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 or not 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

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

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

copyHints - hints used to fine tune copying - generally support for hints is included in MultiTenantCloneable.createOrRetrieveCopyInstance(org.broadleafcommerce.common.copy.MultiTenantCopyContext) implementations.

modifiers - list of modifications to perform to the resulting duplicate prior to persistence

Returns:

the duplicated entity

copy

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

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

copyHints - hints used to fine tune copying - generally support for hints is included in MultiTenantCloneable.createOrRetrieveCopyInstance(org.broadleafcommerce.common.copy.MultiTenantCopyContext) implementations.

modifiers - list of modifications to perform to the resulting duplicate prior to persistence

Returns:

the duplicated entity

performCopy

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

Throws:

Exception