org.broadleafcommerce.common.copy

Class MultiTenantCopyContext

java.lang.Object

org.broadleafcommerce.common.copy.MultiTenantCopyContext

public class MultiTenantCopyContext
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String[]	BROADLEAF_PACKAGE_PREFIXES
protected Map<String,String>	copyHints hints used to fine tune copying - generally support for hints is included in MultiTenantCloneable.createOrRetrieveCopyInstance(org.broadleafcommerce.common.copy.MultiTenantCopyContext) implementations.
protected Map<Integer,Object>	currentCloneMap
protected com.google.common.collect.BiMap<Integer,String>	currentEquivalentMap
protected List<DeferredOperation>	deferredOperations
protected Map<String,Map<Object,Object>>	equivalentsMap
protected MultiTenantCopierExtensionManager	extensionManager
protected Catalog	fromCatalog
protected Site	fromSite
protected GenericEntityService	genericEntityService
protected Boolean	isForDuplicate
protected Catalog	toCatalog
protected Site	toSite

Constructor Summary

Constructors

Constructor and Description
MultiTenantCopyContext(Catalog fromCatalog, Catalog toCatalog, Site fromSite, Site toSite, GenericEntityService genericEntityService, MultiTenantCopierExtensionManager extensionManager)

Method Summary

Modifier and Type	Method and Description
void	addDeferredOperation(DeferredOperation operation)
void	addDeferredOperations(List<DeferredOperation> operations)
protected boolean	checkCloneStatus(Object instance)
void	clearOriginalIdentifiers()
protected <G> G	createNewInstance(Class<?> instanceClass)
<G> CreateResponse<G>	createOrRetrieveCopyInstance(Object instance) Create a new instance of the polymorphic entity type - could be an extended type outside of Broadleaf.
Field[]	getAllFields(Class<?> targetClass)
<T> T	getClonedVersion(Class<T> clazz, Object originalId)
Map<String,String>	getCopyHints() Provides a place for the caller to provide generic information to inform the copy operation.
List<DeferredOperation>	getDeferredOperations()
Object	getEquivalentId(String className, Object fromId)
Boolean	getForDuplicate()
Catalog	getFromCatalog()
Site	getFromSite()
Long	getIdentifier(Object entity)
Object	getPreviousClone(Class<?> instanceClass, Long originalId)
Catalog	getToCatalog()
Site	getToSite()
protected <G> CreateResponse<G>	handleEmbedded(Class<?> instanceClass)
protected <G> CreateResponse<G>	handleStandardEntity(Object instance, BroadleafRequestContext context, Class<?> instanceClass)
protected <G> G	performCopy(Object instance, Class<?> instanceClass, Long originalId)
Object	removeOriginalIdentifier(Object copy)
void	setCopyHints(Map<String,String> copyHints)
void	setForDuplicate(Boolean forDuplicate)
protected BroadleafRequestContext	setupContext()
void	storeEquivalentMapping(String className, Object fromId, Object toId)
protected void	tearDownContext(BroadleafRequestContext context)
protected void	validateClone(Object cloned) Detects whether or not the current cloned entity is an extension of an entity in Broadleaf, and if so, if the extension itself does not implement clone.
protected void	validateOriginal(Object instance)

Methods inherited from class java.lang.Object

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

Field Detail

BROADLEAF_PACKAGE_PREFIXES

public static final String[] BROADLEAF_PACKAGE_PREFIXES

fromCatalog

protected Catalog fromCatalog

toCatalog

protected Catalog toCatalog

fromSite

protected Site fromSite

toSite

protected Site toSite

extensionManager

protected MultiTenantCopierExtensionManager extensionManager

currentEquivalentMap

protected com.google.common.collect.BiMap<Integer,String> currentEquivalentMap

currentCloneMap

protected Map<Integer,Object> currentCloneMap

equivalentsMap

protected Map<String,Map<Object,Object>> equivalentsMap

genericEntityService

protected GenericEntityService genericEntityService

deferredOperations

protected List<DeferredOperation> deferredOperations

copyHints

protected Map<String,String> copyHints

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

isForDuplicate

protected Boolean isForDuplicate

Constructor Detail

MultiTenantCopyContext

public MultiTenantCopyContext(Catalog fromCatalog,
                              Catalog toCatalog,
                              Site fromSite,
                              Site toSite,
                              GenericEntityService genericEntityService,
                              MultiTenantCopierExtensionManager extensionManager)

Method Detail

getClonedVersion

public <T> T getClonedVersion(Class<T> clazz,
                              Object originalId)

getEquivalentId

public Object getEquivalentId(String className,
                              Object fromId)

storeEquivalentMapping

public void storeEquivalentMapping(String className,
                                   Object fromId,
                                   Object toId)

getIdentifier

public Long getIdentifier(Object entity)

getFromCatalog

public Catalog getFromCatalog()

getToCatalog

public Catalog getToCatalog()

getFromSite

public Site getFromSite()

getToSite

public Site getToSite()

createOrRetrieveCopyInstance

public <G> CreateResponse<G> createOrRetrieveCopyInstance(Object instance)
                                                   throws CloneNotSupportedException

Create a new instance of the polymorphic entity type - could be an extended type outside of Broadleaf.

Type Parameters:

G -

Parameters:

instance - the object instance for the actual entity type (could be extended)

Returns:

the new, empty instance of the entity

Throws:

CloneNotSupportedException

clearOriginalIdentifiers

public void clearOriginalIdentifiers()

removeOriginalIdentifier

public Object removeOriginalIdentifier(Object copy)

getAllFields

public Field[] getAllFields(Class<?> targetClass)

getPreviousClone

public Object getPreviousClone(Class<?> instanceClass,
                               Long originalId)

addDeferredOperation

public void addDeferredOperation(DeferredOperation operation)

addDeferredOperations

public void addDeferredOperations(List<DeferredOperation> operations)

getDeferredOperations

public List<DeferredOperation> getDeferredOperations()

getCopyHints

public Map<String,String> getCopyHints()

Provides a place for the caller to provide generic information to inform the copy operation. It's still up to the entity implementation of MultiTenantCloneable.createOrRetrieveCopyInstance(org.broadleafcommerce.common.copy.MultiTenantCopyContext) to actually harvest and utilize the information in some meaningful way.

Returns:

setCopyHints

public void setCopyHints(Map<String,String> copyHints)

getForDuplicate

public Boolean getForDuplicate()

setForDuplicate

public void setForDuplicate(Boolean forDuplicate)

checkCloneStatus

protected boolean checkCloneStatus(Object instance)

validateOriginal

protected void validateOriginal(Object instance)
                         throws CloneNotSupportedException

Throws:

CloneNotSupportedException

tearDownContext

protected void tearDownContext(BroadleafRequestContext context)

setupContext

protected BroadleafRequestContext setupContext()

createNewInstance

protected <G> G createNewInstance(Class<?> instanceClass)

handleStandardEntity

protected <G> CreateResponse<G> handleStandardEntity(Object instance,
                                                     BroadleafRequestContext context,
                                                     Class<?> instanceClass)
                                              throws CloneNotSupportedException

Throws:

CloneNotSupportedException

handleEmbedded

protected <G> CreateResponse<G> handleEmbedded(Class<?> instanceClass)

performCopy

protected <G> G performCopy(Object instance,
                            Class<?> instanceClass,
                            Long originalId)
                     throws CloneNotSupportedException

Throws:

CloneNotSupportedException

validateClone

protected void validateClone(Object cloned)
                      throws CloneNotSupportedException

Detects whether or not the current cloned entity is an extension of an entity in Broadleaf, and if so, if the extension itself does not implement clone.

Parameters:

cloned - the cloned entity instance

Throws:

CloneNotSupportedException - thrown if the entity is an extension and is does not implement clone