Package com.broadleafcommerce.data.tracking.core

Class DefaultTrackableBehaviorUtil

java.lang.Object

com.broadleafcommerce.data.tracking.core.DefaultTrackableBehaviorUtil

All Implemented Interfaces:

TrackableBehaviorUtil

public class DefaultTrackableBehaviorUtil
extends Object
implements TrackableBehaviorUtil

Author:

Jeff Fischer

Constructor Summary

Constructors

Constructor	Description
DefaultTrackableBehaviorUtil()

Method Summary

Modifier and Type	Method	Description
boolean	allowTransitionPersistenceMessage(Trackable domainInstance)	Whether a persistence message will be dropped for sandbox transitions.
boolean	currentRouteSupportsCatalog()	Reports whether the currently active data route supports common Catalog functionality.
boolean	currentRouteSupportsMarketplace()	Reports whether the currently active data route supports common marketplace (ex: MarketplaceApplicationCatalog) functionality.
protected TrackableBehaviorPackage	determineTrackableBehaviorPackage(@NonNull Class<?> domainClass)	Determines the TrackableBehaviors if no extensions are found for the domain class.
protected Optional<TrackableBehaviorPackage>	getBehaviorFromExtension(@NonNull Class<?> domainClass)	Looks for an extension with which to determine the TrackableBehaviors for a domain class.
protected org.springframework.core.env.Environment	getEnvironment()
TrackableBehaviorPackage	getInheritedBehavior(@NonNull TrackableBehaviorInheritable domainInstance)	Retrieve a pojo that describes the inherited TrackableBehavior attributes of a domain object
protected List<TrackableBehaviorOverride>	getOverrides()
protected com.broadleafcommerce.common.extension.data.DataRouteReference	getReference()
TrackableBehaviorPackage	getTrackableBehavior(@NonNull Class<?> domainClass)	Retrieve a pojo that describes the TrackableBehavior attributes of a domain class
TrackableBehaviorPackage	getTrackableBehavior(@NonNull Object domainInstance)	Retrieve a pojo that describes the TrackableBehavior attributes of a domain object
boolean	isSandboxPropagationEnabled()	Whether or not sandbox propagation is enabled in the system.
boolean	isSandboxRecord(@NonNull Trackable domainInstance)	Determines whether the given Trackable is a record in a sandbox.
void	setDataRouteReference(com.broadleafcommerce.common.extension.data.DataRouteReference reference)
void	setEnvironment(org.springframework.core.env.Environment environment)
void	setOverrides(List<TrackableBehaviorOverride> overrides)
void	setSandboxPropagationProperties(SandboxPropagationProperties properties)

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultTrackableBehaviorUtil

public DefaultTrackableBehaviorUtil()

Method Details

setOverrides

@Autowired
public void setOverrides(@Nullable
 List<TrackableBehaviorOverride> overrides)

setSandboxPropagationProperties

@Autowired
public void setSandboxPropagationProperties(@Nullable
 SandboxPropagationProperties properties)

setDataRouteReference

@Autowired
public void setDataRouteReference(@Nullable
 com.broadleafcommerce.common.extension.data.DataRouteReference reference)

setEnvironment

@Autowired
public void setEnvironment(@Nullable
 org.springframework.core.env.Environment environment)

isSandboxPropagationEnabled

public boolean isSandboxPropagationEnabled()

Description copied from interface: TrackableBehaviorUtil

Whether or not sandbox propagation is enabled in the system. See SandboxPropagationProperties. Default is false.

Specified by:

isSandboxPropagationEnabled in interface TrackableBehaviorUtil

Returns:

Whether or not sandbox propagation is enabled in the system

getTrackableBehavior

@NonNull
public TrackableBehaviorPackage getTrackableBehavior(@NonNull @NonNull
 @NonNull Class<?> domainClass)

Description copied from interface: TrackableBehaviorUtil

Retrieve a pojo that describes the TrackableBehavior attributes of a domain class

Specified by:

getTrackableBehavior in interface TrackableBehaviorUtil

Parameters:

domainClass - The domain class to review for TrackableBehavior

Returns:

Retrieve a pojo that describes the TrackableBehavior attributes of a domain class

isSandboxRecord

public boolean isSandboxRecord(@NonNull @NonNull
 @NonNull Trackable domainInstance)

Description copied from interface: TrackableBehaviorUtil

Determines whether the given Trackable is a record in a sandbox. This takes into account whether domainInstance is even sandboxable before checking the tracking level to determine if it's in a sandbox.

Specified by:

isSandboxRecord in interface TrackableBehaviorUtil

Parameters:

domainInstance - The Trackable that could be a sandbox record

Returns:

Whether the given Trackable is a record in a sandbox

allowTransitionPersistenceMessage

public boolean allowTransitionPersistenceMessage(Trackable domainInstance)

Description copied from interface: TrackableBehaviorUtil

Whether a persistence message will be dropped for sandbox transitions. This does not include deployments, which are always allowed. Default is false.

Specified by:

allowTransitionPersistenceMessage in interface TrackableBehaviorUtil

getTrackableBehavior

@NonNull
public TrackableBehaviorPackage getTrackableBehavior(@NonNull @NonNull
 @NonNull Object domainInstance)

Description copied from interface: TrackableBehaviorUtil

Retrieve a pojo that describes the TrackableBehavior attributes of a domain object

Specified by:

getTrackableBehavior in interface TrackableBehaviorUtil

Parameters:

domainInstance - The domain object to review for TrackableBehavior

Returns:

Retrieve a pojo that describes the TrackableBehavior attributes of a domain object

getInheritedBehavior

@NonNull
public TrackableBehaviorPackage getInheritedBehavior(@NonNull @NonNull
 @NonNull TrackableBehaviorInheritable domainInstance)

Description copied from interface: TrackableBehaviorUtil

Retrieve a pojo that describes the inherited TrackableBehavior attributes of a domain object

Specified by:

getInheritedBehavior in interface TrackableBehaviorUtil

Parameters:

domainInstance - The domain object to review for inherited TrackableBehavior

Returns:

Retrieve a pojo that describes the inherited TrackableBehavior attributes of a domain object

getBehaviorFromExtension

protected Optional<TrackableBehaviorPackage> getBehaviorFromExtension(@NonNull @NonNull
 @NonNull Class<?> domainClass)

Looks for an extension with which to determine the TrackableBehaviors for a domain class. Extensions may be provided via registering TrackableBehaviorOverride Beans or annotating classes with TrackableExtension.

Parameters:

domainClass - The class for which to determine the TrackableBehaviors

Returns:

The behaviors from the extension or empty if no extension particular to domainClass.

See Also:

• TrackableBehaviorUtil for more details on extensions
• TrackableBehaviorOverride
• TrackableExtension

determineTrackableBehaviorPackage

protected TrackableBehaviorPackage determineTrackableBehaviorPackage(@NonNull @NonNull
 @NonNull Class<?> domainClass)

Determines the TrackableBehaviors if no extensions are found for the domain class. This will determine behaviors based on the implemented Trackable interfaces of domainClass.

Parameters:

domainClass - The class for which to determine the TrackableBehaviors

Returns:

the TrackableBehaviors particular to domainClass.

See Also:

• FullTrackable
• CatalogTrackable
• ApplicationTrackable
• CustomerContextTrackable
• SandboxTrackable
• TenantTrackable
• Trackable

currentRouteSupportsCatalog

public boolean currentRouteSupportsCatalog()

Description copied from interface: TrackableBehaviorUtil

Reports whether the currently active data route supports common Catalog functionality.

In the event that data routing is disabled or the current data route is not CatalogDataRouteSupporting, the value of NarrowingSupportFallbackProperties.isSupportsCatalog() should be used as a fallback.

This can be useful to ensure certain behavior (ex: narrowing) will only apply if the current configuration has the requisite support for it.

Default returns true.

Specified by:

currentRouteSupportsCatalog in interface TrackableBehaviorUtil

Returns:

true if the current route supports common Catalog functionality, or false otherwise

See Also:

• CatalogDataRouteSupporting
• NarrowingSupportFallbackProperties.isSupportsCatalog()

currentRouteSupportsMarketplace

public boolean currentRouteSupportsMarketplace()

Description copied from interface: TrackableBehaviorUtil

Reports whether the currently active data route supports common marketplace (ex: MarketplaceApplicationCatalog) functionality.

In the event that data routing is disabled or the current data route is not MarketplaceDataRouteSupporting, the value of NarrowingSupportFallbackProperties.isSupportsMarketplace() will be used as a fallback.

This can be useful to ensure certain behavior (ex: narrowing) will only apply if the current configuration has the requisite support for it.

Default returns true.

Specified by:

currentRouteSupportsMarketplace in interface TrackableBehaviorUtil

Returns:

true if the currently route supports common marketplace functionality, or false otherwise

See Also:

• MarketplaceDataRouteSupporting
• NarrowingSupportFallbackProperties.isSupportsMarketplace()

getOverrides

@NonNull
protected List<TrackableBehaviorOverride> getOverrides()

getReference

@Nullable
protected com.broadleafcommerce.common.extension.data.DataRouteReference getReference()

getEnvironment

@Nullable
protected org.springframework.core.env.Environment getEnvironment()