Package com.broadleafcommerce.subscription.provider.jpa.repository

Class JpaCustomizedSubscriptionRepository<D extends JpaSubscription>

java.lang.Object

com.broadleafcommerce.subscription.provider.jpa.repository.JpaCustomizedSubscriptionRepository<D>

All Implemented Interfaces:

CustomizedSubscriptionRepository<D>, org.springframework.beans.factory.InitializingBean

public class JpaCustomizedSubscriptionRepository<D extends JpaSubscription>
extends Object
implements CustomizedSubscriptionRepository<D>, org.springframework.beans.factory.InitializingBean

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	BILLING_FREQUENCY
protected static final String	END_OF_TERM_DATE
protected static final String	LAST_BILLING_OPERATION_STATUS
protected static final String	NEXT_BILL_DATE
protected static final String	NEXT_STATUS_CHANGE_DATE
protected static final String	PRICE_DATA_ID
protected static final String	SECONDARY_SOURCE_REF
protected static final String	SECONDARY_SOURCE_TYPE
protected static final String	SUBSCRIPTION_SOURCE
protected static final String	SUBSCRIPTION_SOURCE_REF
protected static final String	SUBSCRIPTION_STATUS

Constructor Summary

Constructors

Constructor	Description
JpaCustomizedSubscriptionRepository(com.broadleafcommerce.data.tracking.core.TrackableBehaviorUtil behaviorUtil, com.broadleafcommerce.common.jpa.RepositoryEntityTypeManager repositoryEntityTypeManager, com.broadleafcommerce.data.tracking.jpa.filtering.fetch.rsql.JpaFiltersCriteriaBuilder criteriaBuilder)

Method Summary

Modifier and Type	Method	Description
protected void	addPredicatesForSubscriptionStatusAndNexBillDateBeforeNow(List<jakarta.persistence.criteria.Predicate> predicates, Map<String,Object> params, jakarta.persistence.criteria.Root<D> subscription, jakarta.persistence.criteria.CriteriaBuilder builder, String subscriptionStatus)
void	afterPropertiesSet()
Long	countAllBySubscriptionStatus(String subscriptionStatus, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Count subscriptions matching the subscriptionStatus.
protected <D extends JpaSubscription> void	explicitSimpleNarrowing(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, List<jakarta.persistence.criteria.Predicate> predicates, jakarta.persistence.criteria.CriteriaBuilder builder, jakarta.persistence.criteria.Root<D> subscription, Map<String,Object> params)
protected List<D>	filterSubscriptionsByItemRefs(List<D> unfiltered, Collection<String> itemRefs, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
org.springframework.data.domain.Page<D>	findAllByPriceData(String priceDataId, Set<String> statuses, org.springframework.data.domain.Pageable page, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Find all subscriptions by priceDataId.
org.springframework.data.domain.Page<D>	findAllBySubscriptionStatusInAndNextBillDateBeforeOrNextStatusChangeDateBeforeOrEndOfTermDateBefore(List<String> subscriptionStatuses, Date dateToFilter, org.springframework.data.domain.Pageable pageable, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Find subscriptions within the following criteria: subscriptionStatus in the given list billing frequency is DefaultSubscriptionBillingFrequencyEnum.NON_RENEWING OR the Subscription.getNextBillDate() is before or equal the given date OR the Subscription.getNextStatusChangeDate() is before or equal the given date OR the Subscription.getEndOfTermDate() is before or equal the given date lastBillingOperationStatus is null OR is either PaymentStatusEnum.SUCCESS or PaymentStatusEnum.ABORTED Note that the last condition prevents subscriptions that are being processed by another subscription job to be picked up again.
org.springframework.data.domain.Page<D>	findAllBySubscriptionStatusInAndNextBillDateBeforeOrNullAndNextStatusChangeDateBefore(List<String> subscriptionStatuses, Date dateToFilter, org.springframework.data.domain.Pageable pageable, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Find subscriptions within the following criteria: subscriptionStatus in the given list billing frequency is DefaultSubscriptionBillingFrequencyEnum.NON_RENEWING OR the nextBillDate before or equal the given date OR nextBillDate is null and the nextStatusChangeDate is before or equal the given date lastBillingOperationStatus is null OR is either PaymentStatusEnum.SUCCESS or PaymentStatusEnum.ABORTED Note that the last condition prevents subscriptions that are being processed by another subscription job to be picked up again.
List<D>	findAllByUserRefTypeAndUserRefAndActive(String userRefType, String userRef, boolean includeInactive, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Find all subscriptions by userId.
List<D>	findAllByUserRefTypeAndUserRefAndSubscriptionItemsItemRefIn(String userRefType, String userRef, Collection<String> itemRefs, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
Optional<D>	findByMatchingSubscriptionSource(@NonNull Subscription subscription, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Find a Subscription with the source matching the Subscription given.
org.springframework.data.domain.Page<String>	findContextIdsBySubscriptionStatus(String subscriptionStatus, org.springframework.data.domain.Pageable pageable, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Retrieve contextIds of subscriptions matching the subscriptionStatus
protected com.broadleafcommerce.data.tracking.core.TrackableBehaviorUtil	getBehaviorUtil()
protected com.broadleafcommerce.data.tracking.jpa.filtering.fetch.rsql.JpaFiltersCriteriaBuilder	getCriteriaBuilder()
protected jakarta.persistence.EntityManager	getEntityManager()
protected SubscriptionItemRepository<JpaSubscriptionItem>	getItemRepository()
protected <T extends JpaSubscriptionItem> Class<T>	getManagedItemType()
protected Class<D>	getManagedType()	Helper method to get the underlying Class<D extends JpaSubscription> for the managed entity.
protected com.broadleafcommerce.data.tracking.jpa.filtering.narrow.JpaNarrowingHelper	getNarrowingHelper()
protected SubscriptionRepository<D>	getRepository()
protected com.broadleafcommerce.common.jpa.RepositoryEntityTypeManager	getRepositoryEntityTypeManager()
protected List<D>	getSubscriptionsByUserRefTypeAndUserRef(String userRefType, String userRef, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
void	setItemRepository(SubscriptionItemRepository<JpaSubscriptionItem> itemRepository)
void	setRepository(SubscriptionRepository<D> repository)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.broadleafcommerce.subscription.repository.CustomizedSubscriptionRepository

countAllBySubscriptionStatus, findAllBySubscriptionStatus, findAllBySubscriptionStatusAndBillingOperationStatus, findAllByUserRefAndSubscriptionItemsItemRefIn, listSubscriptions

Field Details

SUBSCRIPTION_STATUS

protected static final String SUBSCRIPTION_STATUS

See Also:

• Constant Field Values

NEXT_BILL_DATE

protected static final String NEXT_BILL_DATE

See Also:

• Constant Field Values

NEXT_STATUS_CHANGE_DATE

protected static final String NEXT_STATUS_CHANGE_DATE

See Also:

• Constant Field Values

END_OF_TERM_DATE

protected static final String END_OF_TERM_DATE

See Also:

• Constant Field Values

LAST_BILLING_OPERATION_STATUS

protected static final String LAST_BILLING_OPERATION_STATUS

See Also:

• Constant Field Values

BILLING_FREQUENCY

protected static final String BILLING_FREQUENCY

See Also:

• Constant Field Values

SUBSCRIPTION_SOURCE

protected static final String SUBSCRIPTION_SOURCE

See Also:

• Constant Field Values

SUBSCRIPTION_SOURCE_REF

protected static final String SUBSCRIPTION_SOURCE_REF

See Also:

• Constant Field Values

SECONDARY_SOURCE_TYPE

protected static final String SECONDARY_SOURCE_TYPE

See Also:

• Constant Field Values

SECONDARY_SOURCE_REF

protected static final String SECONDARY_SOURCE_REF

See Also:

• Constant Field Values

PRICE_DATA_ID

protected static final String PRICE_DATA_ID

See Also:

• Constant Field Values

Constructor Details

JpaCustomizedSubscriptionRepository

public JpaCustomizedSubscriptionRepository(com.broadleafcommerce.data.tracking.core.TrackableBehaviorUtil behaviorUtil,
 com.broadleafcommerce.common.jpa.RepositoryEntityTypeManager repositoryEntityTypeManager,
 com.broadleafcommerce.data.tracking.jpa.filtering.fetch.rsql.JpaFiltersCriteriaBuilder criteriaBuilder)

Method Details

setRepository

@Autowired
@Lazy
public void setRepository(SubscriptionRepository<D> repository)

setItemRepository

@Autowired
@Lazy
public void setItemRepository(SubscriptionItemRepository<JpaSubscriptionItem> itemRepository)

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

findAllByUserRefTypeAndUserRefAndActive

public List<D> findAllByUserRefTypeAndUserRefAndActive(String userRefType,
 String userRef,
 boolean includeInactive,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from interface: CustomizedSubscriptionRepository

Find all subscriptions by userId. Optionally include inactive subscriptions.

Specified by:

findAllByUserRefTypeAndUserRefAndActive in interface CustomizedSubscriptionRepository<D extends JpaSubscription>

findContextIdsBySubscriptionStatus

public org.springframework.data.domain.Page<String> findContextIdsBySubscriptionStatus(String subscriptionStatus,
 org.springframework.data.domain.Pageable pageable,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from interface: CustomizedSubscriptionRepository

Retrieve contextIds of subscriptions matching the subscriptionStatus

Specified by:

findContextIdsBySubscriptionStatus in interface CustomizedSubscriptionRepository<D extends JpaSubscription>

findAllByPriceData

public org.springframework.data.domain.Page<D> findAllByPriceData(String priceDataId,
 Set<String> statuses,
 org.springframework.data.domain.Pageable page,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from interface: CustomizedSubscriptionRepository

Find all subscriptions by priceDataId.

Specified by:

findAllByPriceData in interface CustomizedSubscriptionRepository<D extends JpaSubscription>

Parameters:

priceDataId - The id of the priceData belonging to one or more of the contained SubscriptionItem instances.

statuses - Set of statuses to filter by.

page - The page information

contextInfo - Additional sandbox and multitenant info

findAllByUserRefTypeAndUserRefAndSubscriptionItemsItemRefIn

public List<D> findAllByUserRefTypeAndUserRefAndSubscriptionItemsItemRefIn(String userRefType,
 String userRef,
 Collection<String> itemRefs,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Specified by:

findAllByUserRefTypeAndUserRefAndSubscriptionItemsItemRefIn in interface CustomizedSubscriptionRepository<D extends JpaSubscription>

countAllBySubscriptionStatus

public Long countAllBySubscriptionStatus(String subscriptionStatus,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from interface: CustomizedSubscriptionRepository

Count subscriptions matching the subscriptionStatus.

Specified by:

countAllBySubscriptionStatus in interface CustomizedSubscriptionRepository<D extends JpaSubscription>

findAllBySubscriptionStatusInAndNextBillDateBeforeOrNullAndNextStatusChangeDateBefore

@Transactional
public org.springframework.data.domain.Page<D> findAllBySubscriptionStatusInAndNextBillDateBeforeOrNullAndNextStatusChangeDateBefore(List<String> subscriptionStatuses,
 Date dateToFilter,
 org.springframework.data.domain.Pageable pageable,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from interface: CustomizedSubscriptionRepository

Find subscriptions within the following criteria:

• subscriptionStatus in the given list
• billing frequency is DefaultSubscriptionBillingFrequencyEnum.NON_RENEWING OR the nextBillDate before or equal the given date OR nextBillDate is null and the nextStatusChangeDate is before or equal the given date
• lastBillingOperationStatus is null OR is either PaymentStatusEnum.SUCCESS or PaymentStatusEnum.ABORTED Note that the last condition prevents subscriptions that are being processed by another subscription job to be picked up again.

Specified by:

findAllBySubscriptionStatusInAndNextBillDateBeforeOrNullAndNextStatusChangeDateBefore in interface CustomizedSubscriptionRepository<D extends JpaSubscription>

findAllBySubscriptionStatusInAndNextBillDateBeforeOrNextStatusChangeDateBeforeOrEndOfTermDateBefore

@Transactional
public org.springframework.data.domain.Page<D> findAllBySubscriptionStatusInAndNextBillDateBeforeOrNextStatusChangeDateBeforeOrEndOfTermDateBefore(List<String> subscriptionStatuses,
 Date dateToFilter,
 org.springframework.data.domain.Pageable pageable,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from interface: CustomizedSubscriptionRepository

Find subscriptions within the following criteria:

• subscriptionStatus in the given list
• billing frequency is DefaultSubscriptionBillingFrequencyEnum.NON_RENEWING OR the Subscription.getNextBillDate() is before or equal the given date OR the Subscription.getNextStatusChangeDate() is before or equal the given date OR the Subscription.getEndOfTermDate() is before or equal the given date
• lastBillingOperationStatus is null OR is either PaymentStatusEnum.SUCCESS or PaymentStatusEnum.ABORTED Note that the last condition prevents subscriptions that are being processed by another subscription job to be picked up again.

Specified by:

findAllBySubscriptionStatusInAndNextBillDateBeforeOrNextStatusChangeDateBeforeOrEndOfTermDateBefore in interface CustomizedSubscriptionRepository<D extends JpaSubscription>

findByMatchingSubscriptionSource

public Optional<D> findByMatchingSubscriptionSource(@NonNull
 @NonNull Subscription subscription,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from interface: CustomizedSubscriptionRepository

Find a Subscription with the source matching the Subscription given. By default, this is based on Subscription.getSubscriptionSource(), Subscription.getSubscriptionSourceRef(), Subscription.getSecondarySourceType(), and Subscription.getSecondarySourceRef().

Specified by:

findByMatchingSubscriptionSource in interface CustomizedSubscriptionRepository<D extends JpaSubscription>

Parameters:

subscription - A Subscription for which to find a matching source.

addPredicatesForSubscriptionStatusAndNexBillDateBeforeNow

protected void addPredicatesForSubscriptionStatusAndNexBillDateBeforeNow(List<jakarta.persistence.criteria.Predicate> predicates,
 Map<String,Object> params,
 jakarta.persistence.criteria.Root<D> subscription,
 jakarta.persistence.criteria.CriteriaBuilder builder,
 String subscriptionStatus)

getManagedType

protected Class<D> getManagedType()

Helper method to get the underlying Class<D extends JpaSubscription> for the managed entity. The result is usually determined by RepositoryEntityTypeManager.getManagedType(Class, Class, EntityManager).

Returns:

the Class<D extends JpaSubscription> for the managed entity.

getManagedItemType

protected <T extends JpaSubscriptionItem> Class<T> getManagedItemType()

explicitSimpleNarrowing

protected <D extends JpaSubscription> void explicitSimpleNarrowing(@Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo,
 List<jakarta.persistence.criteria.Predicate> predicates,
 jakarta.persistence.criteria.CriteriaBuilder builder,
 jakarta.persistence.criteria.Root<D> subscription,
 Map<String,Object> params)

getSubscriptionsByUserRefTypeAndUserRef

protected List<D> getSubscriptionsByUserRefTypeAndUserRef(String userRefType,
 String userRef,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

filterSubscriptionsByItemRefs

protected List<D> filterSubscriptionsByItemRefs(List<D> unfiltered,
 Collection<String> itemRefs,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

getBehaviorUtil

protected com.broadleafcommerce.data.tracking.core.TrackableBehaviorUtil getBehaviorUtil()

getRepositoryEntityTypeManager

protected com.broadleafcommerce.common.jpa.RepositoryEntityTypeManager getRepositoryEntityTypeManager()

getCriteriaBuilder

protected com.broadleafcommerce.data.tracking.jpa.filtering.fetch.rsql.JpaFiltersCriteriaBuilder getCriteriaBuilder()

getNarrowingHelper

protected com.broadleafcommerce.data.tracking.jpa.filtering.narrow.JpaNarrowingHelper getNarrowingHelper()

getEntityManager

protected jakarta.persistence.EntityManager getEntityManager()

getRepository

protected SubscriptionRepository<D> getRepository()

getItemRepository

protected SubscriptionItemRepository<JpaSubscriptionItem> getItemRepository()