Package com.broadleafcommerce.subscription.web.endpoint

Class SubscriptionWithItemsEndpoint

java.lang.Object

com.broadleafcommerce.subscription.web.endpoint.SubscriptionWithItemsEndpoint

@FrameworkRestController
@FrameworkMapping("/subscription-with-items")
@DataRouteByKey("billing")
public class SubscriptionWithItemsEndpoint
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BASE_URI

Constructor Summary

Constructors

Constructor	Description
SubscriptionWithItemsEndpoint()

Method Summary

Modifier and Type	Method	Description
SubscriptionWithItems	createSubscription(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, boolean returnIfExists, boolean isSandboxAware, boolean isApplicationAware, SubscriptionWithItems subscriptionWithItems, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
protected Optional<Subscription>	findSubscriptionBySourceAndSourceRef(SubscriptionWithItems subscriptionWithItems, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected com.broadleafcommerce.data.tracking.core.filtering.fetch.FilterParser<cz.jirutka.rsql.parser.ast.Node>	getParser()
protected SubscriptionService<Subscription,SubscriptionWithItems>	getSubscriptionService()
List<SubscriptionWithItems>	readAllSubscriptionsByIds(boolean isSandboxAware, boolean isApplicationAware, List<String> ids, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
org.springframework.data.domain.Page<SubscriptionWithItems>	readAllSubscriptionsByUserAndStatuses(boolean isSandboxAware, boolean isApplicationAware, String userRefType, String userRef, String[] statuses, org.springframework.data.domain.Pageable page, cz.jirutka.rsql.parser.ast.Node filters, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
SubscriptionWithItems	readSubscriptionWithItemsBySubscriptionId(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, String subscriptionId, boolean isSandboxAware, boolean isApplicationAware, boolean ignoreDeleteFiltering, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
SubscriptionWithItems	readUserSubscriptionWithItemsById(boolean isSandboxAware, boolean isApplicationAware, String userRefType, String userRef, String subscriptionId, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
SubscriptionWithItems	replaceSubscription(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, boolean isSandboxAware, String subscriptionId, SubscriptionWithItems subscriptionWithItems, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
void	setParser(com.broadleafcommerce.data.tracking.core.filtering.fetch.FilterParser<cz.jirutka.rsql.parser.ast.Node> parser)
void	setSubscriptionService(SubscriptionService<Subscription,SubscriptionWithItems> subscriptionService)

Methods inherited from class java.lang.Object

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

Field Details

BASE_URI

public static final String BASE_URI

See Also:

• Constant Field Values

Constructor Details

SubscriptionWithItemsEndpoint

public SubscriptionWithItemsEndpoint()

Method Details

readAllSubscriptionsByUserAndStatuses

@FrameworkGetMapping
@Policy(permissionRoots="SUBSCRIPTION")
public org.springframework.data.domain.Page<SubscriptionWithItems> readAllSubscriptionsByUserAndStatuses(@RequestHeader(value="X-SANDBOX-AWARE",required=false,defaultValue="false")
 boolean isSandboxAware,
 @RequestHeader(value="X-APPLICATION-AWARE",required=false,defaultValue="false")
 boolean isApplicationAware,
 @RequestParam("userRefType")
 String userRefType,
 @RequestParam("userRef")
 String userRef,
 @RequestParam(value="status",required=false)
 String[] statuses,
 @PageableDefault(sort="tracking.basicAudit.creationTime",direction=DESC)
 org.springframework.data.domain.Pageable page,
 cz.jirutka.rsql.parser.ast.Node filters,
 @ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

readAllSubscriptionsByIds

@FrameworkGetMapping(params="ids")
@Policy(permissionRoots="SUBSCRIPTION")
public List<SubscriptionWithItems> readAllSubscriptionsByIds(@RequestHeader(value="X-SANDBOX-AWARE",required=false,defaultValue="false")
 boolean isSandboxAware,
 @RequestHeader(value="X-APPLICATION-AWARE",required=false,defaultValue="false")
 boolean isApplicationAware,
 @RequestParam("ids")
 List<String> ids,
 @ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

readSubscriptionWithItemsBySubscriptionId

@FrameworkGetMapping("/{subscriptionId}")
@Policy(permissionRoots="SUBSCRIPTION")
public SubscriptionWithItems readSubscriptionWithItemsBySubscriptionId(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response,
 @PathVariable("subscriptionId")
 String subscriptionId,
 @RequestHeader(value="X-SANDBOX-AWARE",required=false,defaultValue="false")
 boolean isSandboxAware,
 @RequestHeader(value="X-APPLICATION-AWARE",required=false,defaultValue="false")
 boolean isApplicationAware,
 @RequestHeader(value="X-SANDBOX-IGNORE-DELETE-FILTERING",required=false,defaultValue="false")
 boolean ignoreDeleteFiltering,
 @ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

readUserSubscriptionWithItemsById

@FrameworkGetMapping(value="/{subscriptionId}",
                     params={"userRefType","userRef"})
@Policy(permissionRoots="SUBSCRIPTION")
public SubscriptionWithItems readUserSubscriptionWithItemsById(@RequestHeader(value="X-SANDBOX-AWARE",required=false,defaultValue="false")
 boolean isSandboxAware,
 @RequestHeader(value="X-APPLICATION-AWARE",required=false,defaultValue="false")
 boolean isApplicationAware,
 @RequestParam("userRefType")
 String userRefType,
 @RequestParam("userRef")
 String userRef,
 @PathVariable("subscriptionId")
 String subscriptionId,
 @ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

createSubscription

@FrameworkPostMapping
@Policy(permissionRoots="SUBSCRIPTION")
public SubscriptionWithItems createSubscription(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response,
 @RequestParam(value="returnIfExists",required=false,defaultValue="false")
 boolean returnIfExists,
 @RequestHeader(value="X-SANDBOX-AWARE",required=false,defaultValue="true")
 boolean isSandboxAware,
 @RequestHeader(value="X-APPLICATION-AWARE",required=false,defaultValue="false")
 boolean isApplicationAware,
 @RequestBody
 SubscriptionWithItems subscriptionWithItems,
 @ContextOperation(CREATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

replaceSubscription

@FrameworkPutMapping("/{subscriptionId}")
@Policy(permissionRoots="SUBSCRIPTION")
public SubscriptionWithItems replaceSubscription(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response,
 @RequestHeader(value="X-SANDBOX-AWARE",required=false,defaultValue="true")
 boolean isSandboxAware,
 @PathVariable("subscriptionId")
 String subscriptionId,
 @RequestBody
 SubscriptionWithItems subscriptionWithItems,
 @ContextOperation(UPDATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

findSubscriptionBySourceAndSourceRef

protected Optional<Subscription> findSubscriptionBySourceAndSourceRef(SubscriptionWithItems subscriptionWithItems,
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

setSubscriptionService

@Autowired
public void setSubscriptionService(SubscriptionService<Subscription,SubscriptionWithItems> subscriptionService)

getSubscriptionService

protected SubscriptionService<Subscription,SubscriptionWithItems> getSubscriptionService()

setParser

@Autowired
public void setParser(com.broadleafcommerce.data.tracking.core.filtering.fetch.FilterParser<cz.jirutka.rsql.parser.ast.Node> parser)

getParser

protected com.broadleafcommerce.data.tracking.core.filtering.fetch.FilterParser<cz.jirutka.rsql.parser.ast.Node> getParser()