Package com.broadleafcommerce.subscriptionoperation.web.endpoint

Class CustomerSubscriptionOperationEndpoint

java.lang.Object

com.broadleafcommerce.subscriptionoperation.web.endpoint.CustomerSubscriptionOperationEndpoint

@FrameworkRestController
@FrameworkMapping("/customers/{customerId}/subscriptions")
public class CustomerSubscriptionOperationEndpoint
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BASE_URI
static final String	CUSTOMER_SUBSCRIPTION_PERMISSION_ROOT

Constructor Summary

Constructors

Constructor	Description
CustomerSubscriptionOperationEndpoint(SubscriptionOperationService<SubscriptionWithItems> subscriptionOperationService, SubscriptionAccessValidationService subscriptionAccessValidationService, com.broadleafcommerce.common.extension.TypeFactory typeFactory)

Method Summary

Modifier and Type	Method	Description
protected SubscriptionAccessValidationService	getSubscriptionAccessValidationService()
protected SubscriptionOperationService<SubscriptionWithItems>	getSubscriptionOperationService()
protected com.broadleafcommerce.common.extension.TypeFactory	getTypeFactory()
ModifySubscriptionResponse	modifySubscription(String customerId, String subscriptionId, ModifySubscriptionRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
org.springframework.data.domain.Page<SubscriptionWithItems>	readAllCustomerSubscriptions(String customerId, boolean getActions, org.springframework.data.domain.Pageable page, cz.jirutka.rsql.parser.ast.Node filters, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
SubscriptionWithItems	readCustomerSubscription(String customerId, String subscriptionId, boolean getActions, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
SubscriptionActionResponse	readCustomerSubscriptionActions(String customerId, String subscriptionId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

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

CUSTOMER_SUBSCRIPTION_PERMISSION_ROOT

public static final String CUSTOMER_SUBSCRIPTION_PERMISSION_ROOT

See Also:

• Constant Field Values

Constructor Details

CustomerSubscriptionOperationEndpoint

public CustomerSubscriptionOperationEndpoint(SubscriptionOperationService<SubscriptionWithItems> subscriptionOperationService,
 SubscriptionAccessValidationService subscriptionAccessValidationService,
 com.broadleafcommerce.common.extension.TypeFactory typeFactory)

Method Details

readAllCustomerSubscriptions

@FrameworkGetMapping
@Policy(permissionRoots="CUSTOMER_SUBSCRIPTION",
        identityTypes=OWNER,
        ownerIdentifierParam=0)
public org.springframework.data.domain.Page<SubscriptionWithItems> readAllCustomerSubscriptions(@PathVariable("customerId")
 String customerId,
 @RequestParam(value="getActions",required=false,defaultValue="false")
 boolean getActions,
 @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 contextInfo)

readCustomerSubscription

@FrameworkGetMapping("/{subscriptionId}")
@Policy(permissionRoots="CUSTOMER_SUBSCRIPTION",
        identityTypes=OWNER,
        ownerIdentifierParam=0)
public SubscriptionWithItems readCustomerSubscription(@PathVariable("customerId")
 String customerId,
 @PathVariable("subscriptionId")
 String subscriptionId,
 @RequestParam(value="getActions",required=false,defaultValue="true")
 boolean getActions,
 @ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

readCustomerSubscriptionActions

@FrameworkGetMapping("/{subscriptionId}/actions")
@Policy(permissionRoots="CUSTOMER_SUBSCRIPTION",
        identityTypes=OWNER,
        ownerIdentifierParam=0)
public SubscriptionActionResponse readCustomerSubscriptionActions(@PathVariable("customerId")
 String customerId,
 @PathVariable("subscriptionId")
 String subscriptionId,
 @ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

modifySubscription

@FrameworkPostMapping(value="/{subscriptionId}/modifications",
                      consumes="application/json")
@Policy(permissionRoots="CUSTOMER_SUBSCRIPTION",
        identityTypes=OWNER,
        ownerIdentifierParam=0,
        operationTypes=UPDATE)
public ModifySubscriptionResponse modifySubscription(@PathVariable("customerId")
 String customerId,
 @PathVariable("subscriptionId")
 String subscriptionId,
 @RequestBody
 ModifySubscriptionRequest request,
 @ContextOperation(UPDATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

getSubscriptionOperationService

protected SubscriptionOperationService<SubscriptionWithItems> getSubscriptionOperationService()

getSubscriptionAccessValidationService

protected SubscriptionAccessValidationService getSubscriptionAccessValidationService()

getTypeFactory

protected com.broadleafcommerce.common.extension.TypeFactory getTypeFactory()