Class TenantEndpoint

java.lang.Object
com.broadleafcommerce.tenant.web.endpoint.TenantEndpoint

@FrameworkRestController @FrameworkMapping("/tenants") @DataRouteByExample(Tenant.class) public class TenantEndpoint extends Object
API for managing Tenant instances.
  • Constructor Details

  • Method Details

    • setPolicyUtils

      @Autowired public void setPolicyUtils(@Nullable com.broadleafcommerce.data.tracking.core.policy.trackable.TrackablePolicyUtils policyUtils)
    • validateGlobalOnlyOperation

      protected void validateGlobalOnlyOperation()
    • readAll

      @FrameworkGetMapping @Policy(permissionRoots="TENANT", operationTypes=READ) public org.springframework.data.domain.Page<Tenant> readAll(jakarta.servlet.http.HttpServletRequest request, @PageableDefault(size=50) org.springframework.data.domain.Pageable page, cz.jirutka.rsql.parser.ast.Node filters)
    • readById

      @FrameworkGetMapping("/{id}") @Policy(permissionRoots="TENANT", operationTypes=READ) public Tenant readById(jakarta.servlet.http.HttpServletRequest request, @PathVariable("id") String id)
    • update

      @FrameworkPatchMapping(value="/{id}", consumes="application/json") @Policy(permissionRoots="TENANT", operationTypes=UPDATE) public Tenant update(jakarta.servlet.http.HttpServletRequest request, @PathVariable("id") String id, @RequestBody Tenant req)
    • replace

      @FrameworkPutMapping(value="/{id}", consumes="application/json") @Policy(permissionRoots="TENANT", operationTypes=UPDATE) public Tenant replace(jakarta.servlet.http.HttpServletRequest request, @PathVariable("id") String id, @RequestBody Tenant req)
    • create

      @FrameworkPostMapping(consumes="application/json") @Policy(permissionRoots="TENANT", operationTypes=CREATE) public Tenant create(jakarta.servlet.http.HttpServletRequest request, @RequestBody Tenant req)
    • delete

      @FrameworkDeleteMapping("/{id}") @Policy(permissionRoots="TENANT", operationTypes=DELETE) public void delete(jakarta.servlet.http.HttpServletRequest request, @PathVariable("id") String id)
    • getService

      protected TenantService<Tenant> getService()
    • getPolicyUtils

      @Nullable protected com.broadleafcommerce.data.tracking.core.policy.trackable.TrackablePolicyUtils getPolicyUtils()