Package com.broadleafcommerce.subscription.web.endpoint

Class SubscriptionEndpoint

java.lang.Object

com.broadleafcommerce.subscription.web.endpoint.SubscriptionEndpoint

@FrameworkRestController
@FrameworkMapping("/subscriptions")
@DataRouteByKey("billing")
public class SubscriptionEndpoint
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BASE_URI

Constructor Summary

Constructors

Constructor	Description
SubscriptionEndpoint()

Method Summary

Modifier and Type	Method	Description
protected com.broadleafcommerce.data.tracking.core.filtering.fetch.FilterParser<cz.jirutka.rsql.parser.ast.Node>	getParser()
protected SubscriptionService<Subscription,SubscriptionWithItems>	getSubscriptionService()
org.springframework.data.domain.Page<Subscription>	readAllSubscriptions(String query, boolean isSandboxAware, boolean isApplicationAware, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Pageable page)
Subscription	readSubscriptionBySubscriptionId(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, boolean isSandboxAware, boolean isApplicationAware, String subscriptionId, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
Subscription	replaceSubscription(boolean isSandboxAware, String id, Subscription req, 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

SubscriptionEndpoint

public SubscriptionEndpoint()

Method Details

readAllSubscriptions

@FrameworkGetMapping
@Policy(permissionRoots="SUBSCRIPTION",
        identityTypes=ADMIN)
public org.springframework.data.domain.Page<Subscription> readAllSubscriptions(@RequestParam(value="q",required=false)
 String query,
 @RequestHeader(value="X-SANDBOX-AWARE",required=false,defaultValue="true")
 boolean isSandboxAware,
 @RequestHeader(value="X-APPLICATION-AWARE",required=false,defaultValue="false")
 boolean isApplicationAware,
 @ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 cz.jirutka.rsql.parser.ast.Node filters,
 @PageableDefault(size=50,sort="tracking.basicAudit.creationTime",direction=DESC)
 org.springframework.data.domain.Pageable page)

readSubscriptionBySubscriptionId

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

replaceSubscription

@Policy(permissionRoots="SUBSCRIPTION")
@FrameworkPutMapping("/{subscriptionId}")
public Subscription replaceSubscription(@RequestHeader(value="X-SANDBOX-AWARE",required=false,defaultValue="true")
 boolean isSandboxAware,
 @PathVariable("subscriptionId")
 String id,
 @RequestBody
 Subscription req,
 @ContextOperation(UPDATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

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()