Package com.broadleafcommerce.subscription.web.endpoint

Class AdjustmentEndpoint

java.lang.Object

com.broadleafcommerce.subscription.web.endpoint.AdjustmentEndpoint

@FrameworkRestController
@FrameworkMapping("/adjustments")
@DataRouteByKey("billing")
public class AdjustmentEndpoint
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BASE_URI
protected SubscriptionAdjustmentService<SubscriptionAdjustment>	subscriptionAdjustmentService

Constructor Summary

Constructors

Constructor	Description
AdjustmentEndpoint()

Method Summary

Modifier and Type	Method	Description
SubscriptionAdjustment	addAdjustment(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, boolean isSandboxAware, SubscriptionAdjustment subscriptionAdjustment, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
List<SubscriptionAdjustment>	getSubscriptionAdjustments(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, boolean isSandboxAware, boolean isApplicationAware, String subscriptionId, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
void	removeSubscriptionAdjustment(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, boolean isSandboxAware, String adjustmentId, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

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

subscriptionAdjustmentService

@Autowired
protected SubscriptionAdjustmentService<SubscriptionAdjustment> subscriptionAdjustmentService

Constructor Details

AdjustmentEndpoint

public AdjustmentEndpoint()

Method Details

getSubscriptionAdjustments

@FrameworkGetMapping
@Policy(permissionRoots="SUBSCRIPTION")
public List<SubscriptionAdjustment> getSubscriptionAdjustments(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,
 @RequestParam
 String subscriptionId,
 @ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

addAdjustment

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

removeSubscriptionAdjustment

@FrameworkDeleteMapping("/{adjustmentId}")
@Policy(permissionRoots="SUBSCRIPTION")
public void removeSubscriptionAdjustment(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response,
 @RequestHeader(value="X-SANDBOX-AWARE",required=false,defaultValue="true")
 boolean isSandboxAware,
 @PathVariable("adjustmentId")
 String adjustmentId,
 @ContextOperation(DELETE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context)